v1

latestOpenAPI 3.1.02026-07-24920300.7 KB

Cancel

Cancels a subscription and any subsequent shipments.

patch/subscriptions/{subscription_id}/cancel/

Path parameters

subscription_idstring required

Unique Subscription ID

Request body

cancel_reasonstring

Pipe-delimited cancel reason code and cancel reason details

Response

200

customerstring

merchantstring

productstring

paymentstring

shipping_addressstring

offerstring

subscription_typestring

componentsobject[]

extra_dataobject

public_idstring

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

quantityinteger

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

frequency_daysinteger

reminder_daysinteger

everyinteger

every_periodinteger

start_datestring

cancelledstring

cancel_reasonstring

cancel_reason_codeinteger

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

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

session_idstring

merchant_order_idstring

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

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

createdstring

updatedstring

liveboolean

Example response

{
  "customer": "00026001",
  "merchant": "ac4f7938383a11e89ecbbc764e1107f2",
  "product": "0070067689",
  "payment": "443ddf72094711e9a5afbc764e1043b0",
  "shipping_address": "394aee16d61611e88b4abc764e1043b0",
  "offer": "a748aa648ac811e8af3bbc764e106cf4",
  "subscription_type": "replenishment",
  "public_id": "0ff0f88accc511e8b6c0bc764e106cf4",
  "quantity": 4,
  "frequency_days": 120,
  "reminder_days": 10,
  "every": 4,
  "every_period": 3,
  "start_date": "2018-12-27",
  "cancelled": "2019-04-02 13:54:12",
  "cancel_reason": "4|Overstocked",
  "cancel_reason_code": 4,
  "session_id": "ac4f7938383a11e89ecbbc764e1107f2.896371.1539022086",
  "merchant_order_id": "2906548",
  "created": "2018-10-10 14:45:38",
  "updated": "2019-04-02 13:54:12"
}