Update subscription

PUT

/v1/subscriptions/{subscription_id}

Update a subscription.

Parameters

Path Parameters

subscription_id

required

Subscription Id

string format: uuid

Request Body ^required

SubscriptionUpdate

object

plan_id

Any of:

string

string format: uuid

null

null

status

Any of:

SubscriptionStatus

SubscriptionStatus

string

Allowed values: pending active paused canceled terminated

null

null

ending_at

Any of:

string

string format: date-time

null

null

canceled_at

Any of:

string

string format: date-time

null

null

billing_time

Any of:

BillingTime

BillingTime

string

Allowed values: calendar anniversary

null

null

trial_period_days

Any of:

integer

integer

null

null

trial_ended_at

Any of:

string

string format: date-time

null

null

subscription_at

Any of:

string

string format: date-time

null

null

pay_in_advance

Any of:

boolean

boolean

null

null

previous_plan_id

Any of:

string

string format: uuid

null

null

downgraded_at

Any of:

string

string format: date-time

null

null

on_termination_action

Any of:

TerminationAction

TerminationAction

string

Allowed values: generate_invoice generate_credit_note skip

null

null

Responses

200

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

401

Unauthorized – invalid or missing API key

404

Subscription not found

422

Validation error