REST RPC APISubscriptions

Change Frequency

View as Markdown
Changes how often to place an order.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

subscription_idstringRequired
Unique subscription ID

Request

This endpoint expects an object.
everyintegerRequired
Number of periods
every_periodintegerRequired
Type of period

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