Subscriptions
Update a subscription
Cancel auto-renew or change the end date of a subscription.
POST
/
api
/
subscriptions
/
{subscription_id}
/
update
/
Authorizations
Authorization
string
headerrequiredToken-based authentication with required prefix "Token"
Path Parameters
subscription_id
string
requiredThe ID of the subscription to update.
Body
turn_off_auto_renew
boolean
Turn off auto renew for the subscription
end_date
string
Change the end date for the subscription.
metadata
object
Update the metadata for the subscription.
Response
200 - application/json
subscription_id
string
requiredstart_date
string
requiredThe time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
end_date
string
requiredThe time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.
auto_renew
boolean
requiredWhether the subscription automatically renews. Defaults to true.
is_new
boolean
requiredWhether this subscription came from a renewal or from a first-time. Defaults to true on creation.
subscription_filters
object[]
requiredcustomer
object
requiredbilling_plan
object
requiredfully_billed
boolean
requiredaddons
object[]
requiredmetadata
object
required