Cancel subscription

Changed on

This endpoint allows you to cancel an active or paused subscription, stopping all future billing and deliveries permanently or until reactivated by the customer or merchant.

post/2026-04/subscription/{subscriptionId}/cancel

Request

  • Base URL
    https://api.loopsubscriptions.com/storefront
  • URL
    https://api.loopsubscriptions.com/storefront/2026-04/subscription/{subscriptionId}/cancel
  • Auth
    API key in header Authorization

Path parameters

subscriptionIdinteger required

The unique identifier of the subscription in Loop.

Request body

cancellationFlowIdinteger

The unique identifier of the cancellation flow.

cancellationOfferIdinteger

The unique identifier of the cancellation offer.

commentstring

Optional key used to capture a message provided by the customer when canceling a subscription. Useful for collecting feedback or reasons for cancellation.

Response

Subscription cancelled successfully

successboolean
messagestring
codestring
pageInfounknown

Example response

{
  "success": true,
  "message": "Subscription cancelled successfully",
  "data": {
    "id": 801000,
    "shopifyId": 3760324761,
    "status": "CANCELLED",
    "totalLineItemDiscountedPrice": 90,
    "currencyCode": "USD"
  },
  "code": "SUCCESS"
}

Changes