GET
/
subscriptions
/
{subscription}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

subscription
string
required

ID of the subscription to retrieve

Response

200 - application/json
object
string
required

Type of object is always subscription.

id
string
required

Unique identifier for the subscription.

number
string
required

Unique number for the subscription.

plan
object
required
customer
object
required
address
object
required
meter
object
required
payment_method
object
required
intended_start_date
string
required

When the subscription is intended to start. Must be a date in YYYY-MM-DD format or "next possible".

created_at
string
required

When 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.

Retrieve a QuoteList All Subscriptions