Ordergroove Developer Documentation

Cancels a subscription and any subsequent shipments.

x-api-keystring

API Key authentication via header

subscription_idstringRequired

Unique Subscription ID

This endpoint expects an object.

cancel_reasonstringOptional

Pipe-delimited cancel reason code and cancel reason details

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

cancelledstring

cancel_reasonstring

cancel_reason_codeintegerDefaults to 0

iterationany

sequenceany

session_idstring

merchant_order_idstring

customer_repany

clubany

createdstring

updatedstring

livebooleanDefaults to true

400

Bad Request Error

$	curl -X PATCH https://restapi.ordergroove.com/subscriptions/subscription_id/cancel/ \
>	-H "x-api-key: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{}'