<- Subscriptions API

Subscriptions API

Update subscription

PUT

 /v2/subscriptions/{subscription_id}

Updates a subscription.

You can set, modify, and clear the subscription field values.

Permissions:CUSTOMERS_READ, PAYMENTS_WRITE, SUBSCRIPTIONS_WRITE, ITEMS_READ, ORDERS_WRITE, INVOICES_WRITE

Guide

Subscriptions Guide

Try in API Explorer
Link to section

Path parameters

Example code

Link to section

subscription_id

string

Required

The ID of the subscription to update.

Link to section

Request body

Link to section

subscription

The subscription object containing the current version, and fields to update. Unset fields will be left at their current server values, and JSON null values will be treated as a request to clear the relevant data.

Show attributes
Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Show attributes
Link to section

subscription

The updated subscription.

Show attributes

Error descriptions