🔴DELETE

Cancel a Subscription Contract

delete

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.

delete

HTTPcURLJavaScriptPython

DELETE /subscriptions/{contractId} HTTP/1.1
Host: localhost:3002
Accept: */*

{
  "success": true,
  "data": {
    "id": "text",
    "failedBillingCount": 1,
    "subscriptionTotal": 1,
    "draft": true,
    "createdAt": "text",
    "notification_at": "2025-06-27T09:17:39.892Z",
    "notified": true,
    "billingInterval": "text",
    "billingIntervalCount": 1,
    "maxCycles": 1,
    "isPrepaid": true,
    "minCycles": 1,
    "billingAnchorType": "text",
    "billingAnchorDay": 1,
    "billingAnchorMonth": 1,
    "currencyCode": "text",
    "customer": {
      "id": "text",
      "addresses": [
        {
          "id": "text",
          "address1": "text",
          "address2": "text",
          "city": "text",
          "company": "text",
          "country": "text",
          "countryCodeV2": "text",
          "firstName": "text",
          "lastName": "text",
          "phone": "text",
          "province": "text",
          "provinceCode": "text",
          "zip": "text"
        }
      ],
      "tags": [
        "text"
      ],
      "firstName": "text",
      "lastName": "text",
      "email": "text",
      "phone": "text",
      "state": "text",
      "createdAt": "text",
      "imageUrl": "text"
    },
    "deliveryPrice": 1,
    "customAttributes": [
      {
        "key": "text",
        "value": "text"
      }
    ],
    "orderIds": [
      "text"
    ],
    "status": "text",
    "shop": "text",
    "lines": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "quantity": 1,
        "taxable": true,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": true,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 1,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "addons": [
      {
        "id": "text",
        "sku": "text",
        "title": "text",
        "productId": "text",
        "variantId": "text",
        "variantTitle": "text",
        "sellingPlanName": "text",
        "displayName": "text",
        "sellingPlanId": "text",
        "quantity": 1,
        "taxable": true,
        "handle": "text",
        "variantImage": {
          "url": "text"
        },
        "currentPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "lineDiscountedPrice": {
          "amount": "text",
          "currencyCode": "text"
        },
        "requiresShipping": true,
        "customAttributes": [
          {
            "key": "text",
            "value": "text"
          }
        ],
        "discountAllocations": [
          {
            "amount": {
              "amount": "text",
              "currencyCode": "text"
            },
            "discount": "text"
          }
        ],
        "pricingPolicy": {
          "basePrice": {
            "amount": "text",
            "currencyCode": "text"
          },
          "cycleDiscounts": [
            {
              "adjustmentType": "text",
              "adjustmentValue": {
                "SellingPlanPricingPolicyPercentageValue": {
                  "percentage": "text"
                }
              },
              "afterCycle": 1,
              "computedPrice": {
                "amount": "text",
                "currencyCode": "text"
              }
            }
          ]
        }
      }
    ],
    "deliveryMethod": {
      "shippingOption": {
        "code": "text",
        "description": "text"
      }
    },
    "originOrder": {
      "id": "text",
      "legacyResourceId": "text",
      "name": "text",
      "createdAt": "text",
      "amount": "text"
    }
  }
}