<- Subscriptions API

Subscriptions API

Update subscription

PUT

 /v2/subscriptions/{subscription_id}

Updates a subscription by modifying or clearing subscription field values.

To clear a field, set its value to null.

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

Guide

Update Subscriptions

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.

Link to section

Response fields

Link to section

errors

Errors encountered during the request.

Link to section

subscription

The updated subscription.

Error descriptions