Create a billing plan
Create a new Plan. A plan represents a collection of Products that can be subscribed to one of your Customers
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
2024-05-09
Body
The end-client facing name of this plan
The internal descriptive name of this plan
Plan type
CUSTOM
, REUSABLE
The plan's currency
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 amount to bill
The price ids this plan includes
The plan id this plan was cloned from
The customers this plan is eligible for. If empty then it's eligible for all customers
Response
Unique Plan ID
The end-client facing name of this plan
The internal descriptive name of this plan
Plan type
CUSTOM
, REUSABLE
Sequence Account ID
The Plan's version
The Plan's currency
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 amount to bill
The Prices this Plan includes
The ID of the Plan that this one was originally cloned from
The Customers IDs this Plan is eligible for. If empty then it's eligible for all customers.
The status of this Plan
DRAFT
, LIVE
, RETIRED
The date and time at which this Plan version is effective
The method by which a Plan update should propagate to Billing Schedules
NEVER
, IMMEDIATE
, NEXT_BILLING_DATE
Created at
Last updated at
Number of schedules for the plan