v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create a Plan

This API creates a new plan.

post/v1/plans

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. <br /><br /><b>Possible Values:</b><br /> application/json<br />application/x-www-form-urlencoded

Request body

amountinteger required

A positive integer in cents representing how much to charge.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Numeric (in cents)</td><td>50</td><td>10000000</td><td>9 would be $0.09 10,000,000 would be $100,000.00</td></tr></table>

plan_type'physical' | 'digital' required

The type of plan.<br><style>td </style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Alphabetic</td><td>physical digital</td></tr></table>

namestring required

Name of the plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>3 characters</td><td>50 characters</td><td>mynewplanname</td></tr></table>

interval'day' | 'month' | 'week' | 'year' required

The unit of interval for billing a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Alphabetic</td><td>day month week year</td></tr></table>

statement_descriptorstring required

An arbitrary string to be displayed on a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>5 characters</td><td>25 characters</td><td>A1 Company 888-888-8888`</td></tr></table>

interval_countinteger

The frequency of billing.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Numeric</td><td>Days: 1 - 365 Months: 1 - 12 Weeks: 1 - 52 Years: 1</td><td>interval: interval_count(frequency) | what it means? days: 2 | You will be billed every two days. months: 3 | You will be billed every 3 months. weeks: 4 | You will be billed every 4 weeks. years: 1 | You will be billed every 1 year.</td></tr></table>

trial_period_daysinteger

Number of days of the trial period that a customer is not charged for.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Allowed Values</b></td></tr><tr><td>Numeric</td><td>0 - 365</td></tr></table>

plan_idstring

An ID that refers to a newly created plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Min Length</b></td><td style='text-align: center;'><b>Max Length</b></td><td style='text-align: center;'><b>Examples</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>3 characters</td><td>191 characters</td><td>mynewplan_1<br>plan_de2c4146 - if PAYARC generated one.</td><td>Users can create a custom plan ID or PAYARC will generate one automatically.</td></tr></table>

plan_descriptionstring

An arbitrary string that describes a plan.<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Alphanumeric and Special Characters</td><td>**Min⬤</td></tr></table>

currencystring

The alphabetic currency code, based on ISO standard<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Format</b></td><td style='text-align: center;'><b>Examples</b></td></tr><tr><td>Three-letter ISO currency code, in lowercase.</td><td>The US dollar is represented as USD – the US coming from the ISO 3166 country code and the D for dollar.</td></tr></table>

surcharge_applicableinteger

Surcharge option<br><style></style><table style='width: 100%; border-collapse: collapse;'><tr><td style='text-align: center;'><b>Notes</b></td></tr><tr><td>Enabling this option will apply surcharge to the plan amount. Please contact support@payarc.com to configure the surcharge value.</td></tr></table>

Response

201

Example response

{
  "data": {
    "object": "Plan",
    "id": "daily_yoga",
    "real_id": 9,
    "amount": "2900",
    "interval": "day",
    "interval_count": "1",
    "name": "Daily yoga",
    "statement_descriptor": "sample statement descriptor",
    "trial_period_days": "3",
    "currency": "USD",
    "created_at": {
      "date": "2018-11-27 09:15:59.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    },
    "updated_at": {
      "date": "2018-11-27 09:15:59.000000",
      "timezone_type": 3,
      "timezone": "UTC"
    }
  }
}