subscriptions/usage_charge_exceeds_limit

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

Triggered when a customer's usage charges reach the capped limit set for their subscription.

Sample payload

{
  "id": "8c7b329d-e451-49f2-b3a5-c14f25de78f9",
  "plan": {
    "id": "6fe55235-ea13-42ea-9100-f389a205bc19",
    "name": "Growth Plan",
    "amount": 24.99,
    "public": true,
    "features": {
      "data_exports": {
        "id": "b3a34df8-eab8-4ad2-a13e-068285dd67e4",
        "name": "Data Exports",
        "type": "limit_with_overage",
        "value": "500",
        "description": "Number of exports per month",
        "displayOrder": 4
      },
      "priority_support": {
        "id": "25cc2437-6162-4d68-a81d-c8d1548ae518",
        "name": "Priority Support",
        "type": "boolean",
        "value": true,
        "description": "Get priority support from our team",
        "displayOrder": 0
      }
    },
    "interval": "EVERY_30_DAYS",
    "createdAt": "2025-02-05T14:10:54.431Z",
    "trialDays": 14,
    "updatedAt": "2025-03-15T09:24:52.742Z",
    "description": "Perfect for growing businesses",
    "currencyCode": "USD",
    "customFields": {
      "Popular": "true",
      "Recommended": "true"
    },
    "usageCharges": [
      {
        "id": "5e9a7c2b-d43f-48e1-bc92-a81675f23d14",
        "type": "unit",
        "terms": "Per export over 500",
        "amount": 0.03,
        "eventName": "data_export",
        "cappedAmount": 75
      }
    ],
    "featuresOrder": [
      "priority_support",
      "data_exports"
    ]
  },
  "topic": "subscriptions/usage_charge_exceeds_limit",
  "active": true,
  "shopify": {
    "id": "gid://shopify/AppSubscription/45678931108"
  },
  "cancelOn": null,
  "customer": {
    "id": "34f9a12b-58e3-492c-b7a1-89c432d67ef5",
    "name": "urban-gadgets",
    "tags": [
      "retail",
      "electronics"
    ],
    "test": false,
    "email": "[email protected]",
    "shopify": {
      "id": "85429176432",
      "isPlus": false,
      "shopId": "85429176432",
      "planName": "Shopify",
      "isDevPlan": false,
      "myshopifyDomain": "urban-gadgets.myshopify.com"
    },
    "platformId": "85429176432",
    "installedAt": "2025-02-12T09:32:14.000Z",
    "billingStatus": "active",
    "lifetimeValue": 74.97,
    "trialStartsAt": "2025-01-29T00:00:00.000Z",
    "uninstalledAt": null,
    "trialExpiresAt": "2025-02-12T00:00:00.000Z",
    "averageMonthlyRevenue": 24.99
  },
  "features": {
    "data_exports": {
      "id": "b3a34df8-eab8-4ad2-a13e-068285dd67e4",
      "name": "Data Exports",
      "type": "limit_with_overage",
      "value": "500",
      "description": "Number of exports per month",
      "displayOrder": 4
    },
    "priority_support": {
      "id": "25cc2437-6162-4d68-a81d-c8d1548ae518",
      "name": "Priority Support",
      "type": "boolean",
      "value": true,
      "description": "Get priority support from our team",
      "displayOrder": 0
    }
  },
  "frozenAt": null,
  "createdAt": "2025-02-12T09:33:38.633Z",
  "canceledAt": null,
  "activatedAt": "2025-02-12T09:33:55.817Z",
  "usageCharges": [
    {
      "id": "5e9a7c2b-d43f-48e1-bc92-a81675f23d14",
      "type": "unit",
      "terms": "Per export over 500",
      "amount": 0.03,
      "eventName": "data_export",
      "cappedAmount": 75
    }
  ],
  "featuresOrder": [
    "priority_support",
    "data_exports"
  ],
  "confirmationUrl": "https://urban-gadgets.myshopify.com/admin/charges/145987654321/45678931108/RecurringApplicationCharge/confirm_recurring_application_charge?signature=BAh7BzoHaWRsKwjkgAA1CQA6EmF1dG9fYWN0aXZhdGVU--b59cfc49678911145436b682fc0aecea2f89e88e",
  "currentPeriodEnd": "2025-03-12T09:33:55.817Z",
  "usageBalanceUsed": 75,
  "usageCappedAmount": 75,
  "currentPeriodStart": "2025-02-12T09:33:55.817Z",
  "shopifySubscription": {
    "id": "gid://shopify/AppSubscription/45678931108"
  }
}
Body Params

A subscription usage charge exceeds its capped amount

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!