Cancels a specific subscription contract by setting its status to "CANCELLED". This endpoint also triggers configured integration actions, such as sending a cancellation email via Klaviyo.
Path parameters
contractIdstringRequired
The unique identifier of the subscription contract to be canceled.
Query parameters
shopstringRequired
The shop domain associated with the subscription contract.
customerIdstringOptional
The customer ID associated with the subscription contract. Used for additional validation or for integration actions.
Responses
200
Successfully canceled the subscription contract. Returns information about the canceled subscription and any integration actions triggered.
application/json
500
Server error, such as when cancellation fails due to backend issues or integration triggers encounter errors.