REST RPC APISubscriptions

Update

View as Markdown

Updates the “extra_data”, “price”, “components”, “offer”, and “cancel_reason” fields.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

subscription_idstringRequired
Unique subscription ID

Request

This endpoint expects an object.
extra_datastringOptionalformat: "json"

JSON object that should be JSON.parse() as key/value store for any extra information.

pricestringOptional

Price, must be in decimal form ex: 10.00

componentslist of anyOptional

Array of JSON objects to set product IDs that are the legacy bundle components. For example: “components”: [ {“product”:“123”}, {“product”:“456”}, {“product”:“789”} ],

offerstringOptional
Public ID of the new offer.
cancel_reasonstringOptional

Pipe-delimited cancel reason code and cancel reason details, e.g. “4|Overstocked”

Response

200
customerstring
merchantstring
productstring
paymentstring
shipping_addressstring
offerstring
subscription_typestring
componentslist of objects
extra_dataobject
public_idstring
product_attributeany
quantityintegerDefaults to 0
priceany
frequency_daysintegerDefaults to 0
reminder_daysintegerDefaults to 0
everyintegerDefaults to 0
every_periodintegerDefaults to 0
start_datestring
cancelledany
cancel_reasonany
cancel_reason_codeany
iterationany
sequenceany
session_idstring
merchant_order_idstring
customer_repany
clubany
createdstring
updatedstring
livebooleanDefaults to true

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error