Subscriptions
Retrieve a Subscription
Retrieve a Subscription object with the given ID.
GET
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
ID of the subscription to retrieve
Example:
"sub_a05fl82x36f6endetxm8rrra"
Response
200
application/json
Successful response
Type of object is always subscription.
Example:
"subscription"
Unique identifier for the subscription.
Example:
"sub_a05fl82x36f6endetxm8rrra"
Unique number for the subscription.
Example:
"28510261"
When the subscription is intended to start. Must be a date in YYYY-MM-DD format or "next possible".
Example:
"next possible"
When the subscription was created.
Example:
"2024-01-01T00:00:00Z"
Status of the subscription.
Available options:
pending
, active
, ended
Example:
"pending"
When the subscription became active.
Example:
null
When the subscription was terminated.
Example:
null
When the subscription ended.
Example:
null