REST RPC APISubscriptions

Reactivate

View as Markdown

Changes a subscription from canceled/inactive to live/active.

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
start_datedateRequired

The date the subscription becomes active. Expected format: YYYY-MM-DD. Also used as the base for calculating the first order date when next_order_date is not provided (start_date + frequency).

next_order_datedateOptional

Optional - Sets the date for the first order after reactivation. Expected format: YYYY-MM-DD. Must not be in the past. If not provided, the order date defaults to start_date + frequency (derived from every and every_period fields).

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