Create subscription

POST

/v1/subscriptions/

Create a new subscription.

Request Body ^required

SubscriptionCreate

object

external_id

required

External Id

string

>= 1 characters <= 255 characters

customer_id

required

Customer Id

string format: uuid

plan_id

required

Plan Id

string format: uuid

started_at

Any of:

string

string format: date-time

null

null

billing_time

BillingTime

string

default: calendar

Allowed values: calendar anniversary

trial_period_days

Trial Period Days

integer

0

subscription_at

Any of:

string

string format: date-time

null

null

pay_in_advance

Pay In Advance

boolean

on_termination_action

TerminationAction

string

default: generate_invoice

Allowed values: generate_invoice generate_credit_note skip

Responses

201

Successful Response

SubscriptionResponse

object

id

required

Id

string format: uuid

external_id

required

External Id

string

customer_id

required

Customer Id

string format: uuid

plan_id

required

Plan Id

string format: uuid

status

required

SubscriptionStatus

string

Allowed values: pending active paused canceled terminated

billing_time

required

Billing Time

string

trial_period_days

required

Trial Period Days

integer

trial_ended_at

required

Any of:

string

string format: date-time

null

null

subscription_at

required

Any of:

string

string format: date-time

null

null

pay_in_advance

required

Pay In Advance

boolean

previous_plan_id

required

Any of:

string

string format: uuid

null

null

downgraded_at

required

Any of:

string

string format: date-time

null

null

on_termination_action

required

On Termination Action

string

started_at

required

Any of:

string

string format: date-time

null

null

ending_at

required

Any of:

string

string format: date-time

null

null

canceled_at

required

Any of:

string

string format: date-time

null

null

paused_at

required

Any of:

string

string format: date-time

null

null

resumed_at

required

Any of:

string

string format: date-time

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

400

Invalid customer or plan reference

401

Unauthorized – invalid or missing API key

409

Subscription with this external_id already exists

422

Validation error