Update a subscription

PUT

subscriptions

{external_id}

object

status

enum<string>

subscription

object

name

string

ending_at

string

subscription_at

string

plan_overrides

object

amount_cents

integer

amount_currency

enum<string>

description

string

invoice_display_name

string

name

string

tax_codes

array

trial_period

number

minimum_commitment

object

lago_id

string

plan_code

string

amount_cents

integer

invoice_display_name

string

interval

enum<string>

created_at

string

updated_at

string

taxes

array

charges

array

usage_thresholds

array

Authorizations

Authorization

string

headerrequired

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

Path Parameters

external_id

string

required

External ID of the existing subscription

Body

application/json

status

enum<string>

If the field is not defined and multiple active and pending subscriptions exists, Lago will update the active subscription. However, if you wish to update a pending subscription, please ensure that you include the status attribute with the pending value in your request body.

Available options:

active,

pending

subscription

object

required

Response

200 - application/json

subscription

object

required

Was this page helpful?

Create a subscription Terminate a subscription

API Reference

Authorizations

Path Parameters

Body

Response