GET
/
subscriptions
/
{subscription}

Authorizations

Authorization
string
header
required

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
address
object
required
created_at
string
required

When the subscription was created.

customer
object
required
id
string
required

Unique identifier for the subscription.

intended_start_date
string
required

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

meter
object
required
number
string
required

Unique number for the subscription.

object
string
required

Type of object is always subscription.

payment_method
object
required
plan
object
required
end_at
string

When the subscription ended.

previous_supplier
object
start_at
string

When the subscription became active.

status
enum<string>

Status of the subscription.

Available options:
pending,
active,
ended
terminated_at
string

When the subscription was terminated.