Skip to main content
GET
Retrieve a plan

Authorizations

Authorization
string
header
required

Paste your secret key as the bearer token: sk_test_… (test) or sk_live_… (live). That is all a normal API call needs. OAuth access tokens from POST /v1/oauth/token also work, but a client id/secret is only for platforms acting on another tenant's behalf, not for your own integration.

Path Parameters

id
string
required

Response

OK

id
string
name
string
amount
integer
currency
string
interval
enum<string>
Available options:
hour,
day,
week,
month,
quarter,
biannual,
year
intervalCount
integer
trialDays
integer
maxCycles
integer | null
createdAt
string<date-time>