API Reference

Create a Plan

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

This API creates a new plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required

A positive integer in cents representing how much to charge.

FormatMin LengthMax LengthExamplesNumeric (in cents)50100000009 would be $0.09 10,000,000 would be $100,000.00

string
enum
required

The type of plan.

FormatAllowed ValuesAlphabeticphysical digital

Allowed:
string
required

Name of the plan.

FormatMin LengthMax LengthExamplesAlphanumeric and Special Characters3 characters50 charactersmynewplanname

string
enum
required

The unit of interval for billing a plan.

FormatAllowed ValuesAlphabeticday month week year

Allowed:
string
required

An arbitrary string to be displayed on a plan.

FormatMin LengthMax LengthExamplesAlphanumeric and Special Characters5 characters25 charactersA1 Company 888-888-8888`

int32

The frequency of billing.

FormatAllowed ValuesNotesNumericDays: 1 - 365 Months: 1 - 12 Weeks: 1 - 52 Years: 1interval: 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.

int32

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

FormatAllowed ValuesNumeric0 - 365

string

An ID that refers to a newly created plan.

FormatMin LengthMax LengthExamplesNotesAlphanumeric and Special Characters3 characters191 charactersmynewplan_1
plan_de2c4146 - if PAYARC generated one.Users can create a custom plan ID or PAYARC will generate one automatically.

string

An arbitrary string that describes a plan.

FormatNotesAlphanumeric and Special Characters**Min​⬤

string

The alphabetic currency code, based on ISO standard

FormatExamplesThree-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.

int32

Surcharge option

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

Headers
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 11 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago