Skip to main content
DELETE
/
api
/
external
/
v2
/
subscription-contracts
/
{id}
Cancel a subscription contract
curl --request DELETE \
  --url https://subscription-admin.appstle.com/api/external/v2/subscription-contracts/{id}

Documentation Index

Fetch the complete documentation index at: https://appstleinc-aeca3e0a.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

id
integer<int64>
required

The unique identifier of the subscription contract to cancel. Must be a valid contract ID that belongs to the authenticated shop.

Required range: x >= 1

Query Parameters

cancellationFeedback
string

Optional feedback from the customer about why they are cancelling. This information is valuable for understanding cancellation reasons and improving retention. Common values include: 'Too expensive', 'No longer needed', 'Found alternative', 'Quality issues', 'Delivery issues', 'Customer service', 'Product not as expected', etc. This field is stored permanently with the contract for analytics.

Maximum string length: 500
cancellationNote
string

Optional internal note for recording additional cancellation context. This field is for internal use and not visible to customers. Can be used to track special circumstances, support ticket references, competitor information, or other relevant details about why the customer cancelled. This note is stored permanently with the contract.

Maximum string length: 1000

Response

Subscription successfully cancelled. No content returned.