Subscriptions
Retrieve a Subscription
Retrieve a Subscription object with the given ID.
GET
/
subscriptions
/
{subscription}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
subscription
string
requiredID of the subscription to retrieve
Response
200 - application/json
object
string
requiredType of object is always subscription.
id
string
requiredUnique identifier for the subscription.
number
string
requiredUnique number for the subscription.
plan
object
requiredcustomer
object
requiredaddress
object
requiredmeter
object
requiredpayment_method
object
requiredintended_start_date
string
requiredWhen the subscription is intended to start. Must be a date in YYYY-MM-DD format or "next possible".
created_at
string
requiredWhen the subscription was created.
previous_supplier
object
status
enum<string>
Status of the subscription.
Available options:
pending
, active
, ended
start_at
string
When the subscription became active.
terminated_at
string
When the subscription was terminated.
end_at
string
When the subscription ended.