POST
/
subscriptions

Authorizations

Authorization
string
header
required

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

Body

application/json
address
required
customer
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".

meter
required
payment_method
required
plan
string
required

ID of the plan associated with this subscription.

previous_supplier
string

ID of the previous energy supplier. Required if switching from another energy supplier.

Response

201 - application/json
address
string
required

ID of the delivery address.

created_at
string
required

When the subscription was created.

customer
string
required

ID of the customer associated with this subscription.

id
string
required

Unique identifier for the subscription.

meter
string
required

ID of the meter associated with this subscription.

number
string
required

Unique number for the subscription.

object
string
required

Type of object is always subscription.

payment_method
string
required

ID of the payment method associated with this subscription.

plan
string
required

ID of the plan associated with this subscription.

status
enum<string>
required

Status of the subscription.

Available options:
pending,
active,
ended
end_at
string

When the subscription ended.

start_at
string

When the subscription became active.

terminated_at
string

When the subscription was terminated.