Create a Plan

post

https://testapi.payarc.net/v1/plans

This API creates a new plan.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

amount

int32

required

A positive integer in cents representing how much to charge.

Format	Min Length	Max Length	Examples
Numeric (in cents)	50	10000000	`9` would be $0.09 10,000,000 would be $100,000.00

plan_type

string

enum

required

The type of plan.
td

Format	Allowed Values
Alphabetic	`physical` `digital`

Allowed:

name

string

required

Name of the plan.

Format	Min Length	Max Length	Examples
Alphanumeric and Special Characters	3 characters	50 characters	`mynewplanname`

interval

string

enum

required

The unit of interval for billing a plan.

Format	Allowed Values
Alphabetic	`day` `month` `week` `year`

Allowed:

statement_descriptor

string

required

An arbitrary string to be displayed on a plan.

Format	Min Length	Max Length	Examples
Alphanumeric and Special Characters	5 characters	25 characters	A1 Company 888-888-8888`

interval_count

int32

The frequency of billing.

Format	Allowed Values	Notes
Numeric	Days: `1 - 365` Months: `1 - 12` Weeks: `1 - 52` Years: `1`	`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.

trial_period_days

int32

Number of days of the trial period that a customer is not charged for.

Format	Allowed Values
Numeric	`0 - 365`

plan_id

string

An ID that refers to a newly created plan.

Format	Min Length	Max Length	Examples	Notes
Alphanumeric and Special Characters	3 characters	191 characters	`mynewplan_1` `plan_de2c4146` - if PAYARC generated one.	Users can create a custom plan ID or PAYARC will generate one automatically.

plan_description

string

An arbitrary string that describes a plan.

Format	Notes
Alphanumeric and Special Characters	**Min⬤

currency

string

The alphabetic currency code, based on ISO standard

Format	Examples
Three-letter ISO currency code, in lowercase.	The US dollar is represented as USD – the US coming from the ISO 3166 country code and the D for dollar.

surcharge_applicable

int32

Surcharge option

Notes

Enabling this option will apply surcharge to the plan amount. Please contact [email protected] to configure the surcharge value.

Headers

string

required

Defaults to application/json

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

Content-Type

string

required

Defaults to application/json

Indicates the media type of the resource sent in the HTTP message body.

Possible Values:
application/json
application/x-www-form-urlencoded

Responses

201201

422422