Plans
Get Plan
Retrieve the details of one of your Plans.
GET
/
plans
/
{planId}
Headers
Authorization
string
requiredYour API credentials. Eg. Basic {credentials}
.
Sequence-Version
enum<string>
Use this header to select an API version
Available options:
2024-05-09
Path Parameters
planId
string
requiredPlan ID
Response
200 - application/json
id
string
requiredUnique Plan ID
name
string
requiredThe end-client facing name of this plan
label
string
requiredThe internal descriptive name of this plan
type
enum<string>
requiredPlan type
Available options:
CUSTOM
, REUSABLE
sequenceAccountId
string
requiredSequence Account ID
version
integer
requiredThe Plan's version
currency
enum<string>
requiredThe 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[]
requiredThe Prices this Plan includes
parentId
string
The ID of the Plan that this one was originally cloned from
eligibleCustomerIds
any[]
requiredThe Customers IDs this Plan is eligible for. If empty then it's eligible for all customers.
status
enum<string>
requiredThe 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>
requiredThe method by which a Plan update should propagate to Billing Schedules
Available options:
NEVER
, IMMEDIATE
, NEXT_BILLING_DATE
createdAt
string
requiredCreated at
updatedAt
string
requiredLast updated at
schedulesCount
integer
requiredNumber of schedules for the plan