subscriptions/cancel

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Triggered when a customer cancels their subscription, containing details about the canceled subscription.

Sample payload

{
  "id": "h1i2j3k4-l5m6-n7o8-p9q0-r1s2t3u4v5w6",
  "plan": {
    "id": "75cbecd2-660c-4944-985a-9f739f6d230e",
    "name": "Pro Plan",
    "amount": 39.99,
    "public": true,
    "features": {
      "custom_reports": {
        "id": "8fca5ac8-6b79-4411-92cd-46d9560479c9",
        "name": "Custom Reports",
        "type": "boolean",
        "value": true,
        "description": "Generate detailed analytics reports",
        "displayOrder": 1
      },
      "api_calls": {
        "id": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
        "name": "API Calls",
        "type": "limit_with_overage",
        "value": "10000",
        "description": "Monthly API call limit",
        "displayOrder": 2
      }
    },
    "interval": "EVERY_30_DAYS",
    "createdAt": "2025-01-15T09:22:18.723Z",
    "trialDays": 14,
    "updatedAt": "2025-03-18T16:30:44.129Z",
    "description": "Advanced features for growing businesses",
    "currencyCode": "USD",
    "customFields": {
      "Recommended": "true",
      "IndustryFocus": "ecommerce"
    },
    "usageCharges": [
      {
        "id": "c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6",
        "type": "unit",
        "terms": null,
        "amount": 0.005,
        "eventName": null,
        "cappedAmount": 200
      }
    ],
    "featuresOrder": [
      "custom_reports",
      "api_calls"
    ]
  },
  "topic": "subscriptions/cancel",
  "active": false,
  "shopify": {
    "id": "gid://shopify/AppSubscription/46178912345"
  },
  "cancelOn": "2025-04-05T00:00:00.000Z",
  "customer": {
    "id": "j1k2l3m4-n5o6-p7q8-r9s0-t1u2v3w4x5y6",
    "name": "Urban Threads",
    "tags": [
      "seasonal",
      "fashion"
    ],
    "test": false,
    "email": "[email protected]",
    "shopify": {
      "id": "83456789012",
      "isPlus": false,
      "shopId": "83456789012",
      "planName": "Shopify",
      "isDevPlan": false,
      "myshopifyDomain": "urban-threads.myshopify.com"
    },
    "platformId": "83456789012",
    "installedAt": "2025-02-05T11:32:18.000Z",
    "billingStatus": "canceled",
    "lifetimeValue": 79.98,
    "trialStartsAt": "2025-02-05T11:32:18.000Z",
    "uninstalledAt": null,
    "trialExpiresAt": "2025-02-19T11:32:18.000Z",
    "averageMonthlyRevenue": 39.99
  },
  "features": {
    "custom_reports": {
      "id": "8fca5ac8-6b79-4411-92cd-46d9560479c9",
      "name": "Custom Reports",
      "type": "boolean",
      "value": true,
      "description": "Generate detailed analytics reports",
      "displayOrder": 1
    },
    "api_calls": {
      "id": "b1c2d3e4-f5g6-h7i8-j9k0-l1m2n3o4p5q6",
      "name": "API Calls",
      "type": "limit_with_overage",
      "value": "10000",
      "description": "Monthly API call limit",
      "displayOrder": 2
    }
  },
  "frozenAt": null,
  "createdAt": "2025-02-19T11:35:42.891Z",
  "canceledAt": "2025-03-18T15:47:22.568Z",
  "activatedAt": "2025-02-19T11:35:42.891Z",
  "usageCharges": [
    {
      "id": "c1d2e3f4-g5h6-i7j8-k9l0-m1n2o3p4q5r6",
      "type": "unit",
      "terms": null,
      "amount": 0.005,
      "eventName": null,
      "cappedAmount": 200
    }
  ],
  "featuresOrder": [
    "custom_reports",
    "api_calls"
  ],
  "confirmationUrl": null,
  "currentPeriodEnd": "2025-04-05T00:00:00.000Z",
  "usageBalanceUsed": 45.12,
  "usageCappedAmount": 200,
  "currentPeriodStart": "2025-03-05T11:35:42.891Z",
  "shopifySubscription": {
    "id": "gid://shopify/AppSubscription/46178912345"
  }
}
{
  "id": "sub_H1i2J3k4L5m6N7o8",
  "plan": {
    "id": "price_1P2xZjLpM7KT5gH3n0VqS2Rb",
    "name": "Pro Plan",
    "amount": 39.99,
    "public": true,
    "features": {
      "custom_reports": {
        "id": "feat_cr_8fca5ac86b79",
        "name": "Custom Reports",
        "type": "boolean",
        "value": true,
        "description": "Generate detailed analytics reports",
        "displayOrder": 1
      },
      "api_calls": {
        "id": "feat_api_b1c2d3e4f5g6",
        "name": "API Calls",
        "type": "limit_with_overage",
        "value": "10000",
        "description": "Monthly API call limit",
        "displayOrder": 2
      }
    },
    "interval": "month",
    "createdAt": "2025-01-15T09:22:18.723Z",
    "trialDays": 14,
    "updatedAt": "2025-03-18T16:30:44.129Z",
    "description": "Advanced features for growing businesses",
    "currencyCode": "USD",
    "customFields": {
      "Recommended": "true",
      "IndustryFocus": "ecommerce"
    },
    "usageCharges": [
      {
        "id": "uc_c1d2e3f4g5h6i7j8",
        "type": "unit",
        "terms": null,
        "amount": 0.005,
        "eventName": null,
        "cappedAmount": 200
      }
    ],
    "featuresOrder": [
      "custom_reports",
      "api_calls"
    ],
    "stripe": {
      "id": "price_1P2xZjLpM7KT5gH3n0VqS2Rb",
      "createdAt": "2025-01-15T09:22:18.723Z"
    }
  },
  "topic": "subscriptions/cancel",
  "active": false,
  "cancelOn": "2025-04-05T00:00:00.000Z",
  "customer": {
    "id": "cus_J1k2L3m4N5o6P7q8",
    "name": "Urban Threads",
    "tags": [
      "seasonal",
      "fashion"
    ],
    "test": false,
    "email": "[email protected]",
    "platformId": "83456789012",
    "installedAt": "2025-02-05T11:32:18.000Z",
    "billingStatus": "canceled",
    "lifetimeValue": 79.98,
    "trialStartsAt": "2025-02-05T11:32:18.000Z",
    "uninstalledAt": null,
    "trialExpiresAt": "2025-02-19T11:32:18.000Z",
    "averageMonthlyRevenue": 39.99
  },
  "features": {
    "custom_reports": {
      "id": "feat_cr_8fca5ac86b79",
      "name": "Custom Reports",
      "type": "boolean",
      "value": true,
      "description": "Generate detailed analytics reports",
      "displayOrder": 1
    },
    "api_calls": {
      "id": "feat_api_b1c2d3e4f5g6",
      "name": "API Calls",
      "type": "limit_with_overage",
      "value": "10000",
      "description": "Monthly API call limit",
      "displayOrder": 2
    }
  },
  "frozenAt": null,
  "createdAt": "2025-02-19T11:35:42.891Z",
  "canceledAt": "2025-03-18T15:47:22.568Z",
  "activatedAt": "2025-02-19T11:35:42.891Z",
  "usageCharges": [
    {
      "id": "uc_c1d2e3f4g5h6i7j8",
      "type": "unit",
      "terms": null,
      "amount": 0.005,
      "eventName": null,
      "cappedAmount": 200
    }
  ],
  "featuresOrder": [
    "custom_reports",
    "api_calls"
  ],
  "confirmationUrl": null,
  "currentPeriodEnd": "2025-04-05T00:00:00.000Z",
  "usageBalanceUsed": 45.12,
  "usageCappedAmount": 200,
  "currentPeriodStart": "2025-03-05T11:35:42.891Z",
  "stripe": {
    "id": "sub_H1i2J3k4L5m6N7o8",
    "createdAt": "2025-02-19T11:35:42.891Z"
  }
}
Body Params

A subscription was cancelled

string

The topic of the webhook

subscription
object
Response
200

Return a 200 status to indicate that the data was received successfully

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!