Skip to navigation

Get plan

Get a plan by Paid plan ID.

Authentication

AuthorizationBearer
API Key authentication using Bearer token

Path parameters

idstringRequired

Response

200
idstring
productIdstring
namestring or null
displayNamestring or null
What your customers see for this plan on invoices, checkout and the customer portal. Null means they see the plan name.
externalIdstring or null
supportedCurrencieslist of strings
isDefaultboolean
statusenum
Allowed values:
upgradePathOrderdouble or null
archivedAtdatetime or null
createdAtdatetime
updatedAtdatetime
attributeslist of objects

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error