POST
/
plans

Headers

Authorization
string
required

Your API credentials. Eg. Basic {credentials}.

Sequence-Version
enum<string>

Use this header to select an API version

Available options:
2024-05-09

Body

application/json
name
string
required

The end-client facing name of this plan

label
string
required

The internal descriptive name of this plan

type
enum<string>

Plan type

Available options:
CUSTOM,
REUSABLE
currency
enum<string>
required

The plan's currency

Available options:
ARS,
AUD,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
HKD,
ILS,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
minimum
string

Minimum amount to bill

priceIds
string[]
required

The price ids this plan includes

parentId
string

The plan id this plan was cloned from

eligibleCustomerIds
any[]
required

The customers this plan is eligible for. If empty then it's eligible for all customers

Response

201 - application/json
id
string
required

Unique Plan ID

name
string
required

The end-client facing name of this plan

label
string
required

The internal descriptive name of this plan

type
enum<string>
required

Plan type

Available options:
CUSTOM,
REUSABLE
sequenceAccountId
string
required

Sequence Account ID

version
integer
required

The Plan's version

currency
enum<string>
required

The Plan's currency

Available options:
ARS,
AUD,
BRL,
CAD,
CHF,
CNY,
COP,
CZK,
DKK,
EUR,
GBP,
HKD,
ILS,
JPY,
KRW,
MXN,
NOK,
NZD,
PLN,
SEK,
SGD,
THB,
USD,
UYU,
ZAR
minimum
string

Minimum amount to bill

prices
object[]
required

The Prices this Plan includes

parentId
string

The ID of the Plan that this one was originally cloned from

eligibleCustomerIds
any[]
required

The Customers IDs this Plan is eligible for. If empty then it's eligible for all customers.

status
enum<string>
required

The status of this Plan

Available options:
DRAFT,
LIVE,
RETIRED
versionEffectiveFrom
string

The date and time at which this Plan version is effective

versionChangeBehaviour
enum<string>
required

The method by which a Plan update should propagate to Billing Schedules

Available options:
NEVER,
IMMEDIATE,
NEXT_BILLING_DATE
createdAt
string
required

Created at

updatedAt
string
required

Last updated at

schedulesCount
integer
required

Number of schedules for the plan