v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

Reactivate

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

patch/subscriptions/{subscription_id}/reactivate/

Path parameters

subscription_idstring required

Unique subscription ID

Request body

everyinteger required

Number of periods

every_periodinteger required

Type of period

start_datestring date required

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_datestring date

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

componentsobject[]

extra_dataobject

public_idstring

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:product_attribute","oasType":"schema","type":"unknown"}

quantityinteger

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:price","oasType":"schema","type":"unknown"}

frequency_daysinteger

reminder_daysinteger

everyinteger

every_periodinteger

start_datestring

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:cancelled","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:cancel_reason","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:cancel_reason_code","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:iteration","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:sequence","oasType":"schema","type":"unknown"}

session_idstring

merchant_order_idstring

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:customer_rep","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/subscriptions/{subscription_id}/reactivate/:patch:responses:200:content:application/json:schema:properties:club","oasType":"schema","type":"unknown"}

createdstring

updatedstring

liveboolean

Example response

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070000693",
  "payment": "070001bc02fd11e99542bc764e1043b0",
  "shipping_address": "66c25cd0564011e9abc5bc764e107990",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "public_id": "607daa2accc811e88516bc764e106cf4",
  "quantity": 21,
  "frequency_days": 180,
  "reminder_days": 10,
  "every": 6,
  "every_period": 3,
  "start_date": "2018-12-27",
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "created": "2018-10-10 15:09:21",
  "updated": "2019-04-04 11:28:39",
  "live": true
}