Reactivate

PATCH

https://restapi.ordergroove.com/subscriptions/:subscription_id/reactivate/

PATCH

/subscriptions/:subscription_id/reactivate/

curl -X PATCH https://restapi.ordergroove.com/subscriptions/subscription_id/reactivate/ \
     -H "x-api-key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "every": 1,
  "every_period": 1,
  "start_date": "2023-01-15"
}'

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "70000693",
  "payment": "070001bc02fd11e99542bc764e1043b0",
  "shipping_address": "66c25cd0564011e9abc5bc764e107990",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "components": [],
  "extra_data": {},
  "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
}

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

customerstringOptional

merchantstringOptional

productstringOptional

paymentstringOptional

shipping_addressstringOptional

offerstringOptional

subscription_typestringOptional

componentslist of objectsOptional

extra_dataobjectOptional

public_idstringOptional

product_attributemap from strings to any or nullOptional

quantityintegerOptionalDefaults to 0

pricedouble or nullOptional

frequency_daysintegerOptionalDefaults to 0

reminder_daysintegerOptionalDefaults to 0

everyintegerOptionalDefaults to 0

every_periodintegerOptionalDefaults to 0

start_datestringOptional

cancelledboolean or nullOptional

cancel_reasonstring or nullOptional

cancel_reason_codestring or nullOptional

iterationdouble or nullOptional

sequencedouble or nullOptional

session_idstringOptional

merchant_order_idstringOptional

customer_repmap from strings to any or nullOptional

clubmap from strings to any or nullOptional

createdstringOptional

updatedstringOptional

livebooleanOptionalDefaults to true

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error