subscriptions/approaching_capped

Time	Status	User Agent
Retrieving recent requests…
Time
Status
User Agent
Retrieving recent requests…
Triggered when a customer's usage approaches the capped limit set for their subscription (typically at 90% of their cap).
Sample payload

{
  "id": "c48e9f72-514b-42d3-b6a8-79e517c8f3d2",
  "topic": "subscriptions/usage_charge_exceeds_limit",
  "plan": {
    "id": "1c4ad139-3363-40b7-88de-82dbd34d5329",
    "name": "Pro",
    "amount": 29.99,
    "interval": "EVERY_30_DAYS",
    "currencyCode": "USD",
    "trialDays": 7,
    "public": true,
    "description": "Professional plan with API access and usage-based billing",
    "customFields": {
      "Recommended": "true"
    },
    "features": {
      "custom_reports": {
        "id": "25cc2437-6162-4d68-a81d-c8d1548ae518",
        "name": "Custom Reports",
        "type": "boolean",
        "value": true,
        "description": "Generate customized reports",
        "displayOrder": 0
      },
      "api_calls": {
        "id": "b3a34df8-eab8-4ad2-a13e-068285dd67e4",
        "name": "API Calls",
        "type": "limit_with_overage",
        "value": "10000",
        "description": "Monthly API call limit with overage charges",
        "displayOrder": 1
      }
    },
    "featuresOrder": [
      "custom_reports",
      "api_calls"
    ],
    "usageCharges": [
      {
        "id": "7d9e1b5a-c23f-48e6-90a7-3f5d8e12b946",
        "type": "unit",
        "terms": "Per API call over 10,000",
        "amount": 0.002,
        "eventName": "api_call",
        "cappedAmount": 50
      }
    ],
    "createdAt": "2025-01-22T14:40:39.436Z",
    "updatedAt": "2025-03-18T13:14:07.696Z"
  },
  "active": true,
  "cancelOn": null,
  "activatedAt": "2025-03-01T10:25:56.806Z",
  "canceledAt": null,
  "frozenAt": null,
  "currentPeriodStart": "2025-03-01T00:00:00.000Z",
  "currentPeriodEnd": "2025-04-01T00:00:00.000Z",
  "features": {
    "custom_reports": {
      "id": "25cc2437-6162-4d68-a81d-c8d1548ae518",
      "name": "Custom Reports",
      "type": "boolean",
      "value": true,
      "description": "Generate customized reports",
      "displayOrder": 0
    },
    "api_calls": {
      "id": "b3a34df8-eab8-4ad2-a13e-068285dd67e4",
      "name": "API Calls",
      "type": "limit_with_overage",
      "value": "10000",
      "description": "Monthly API call limit with overage charges",
      "displayOrder": 1
    }
  },
  "featuresOrder": [
    "custom_reports",
    "api_calls"
  ],
  "usageCharges": [
    {
      "id": "7d9e1b5a-c23f-48e6-90a7-3f5d8e12b946",
      "type": "unit",
      "terms": "Per API call over 10,000",
      "amount": 0.002,
      "eventName": "api_call",
      "cappedAmount": 50
    }
  ],
  "usageCappedAmount": 50,
  "usageBalanceUsed": 50,
  "createdAt": "2025-03-01T10:25:49.900Z",
  "confirmationUrl": "https://high-volume-store.myshopify.com/admin/charges/145072685057/39547699428/RecurringApplicationCharge/confirm_recurring_application_charge?signature=BAh7BzoHaWRsKwjkADo1CQA6EmF1dG9fYWN0aXZhdGVU--6ae0b6d3af7fcf6c7b650e20a36367f63eb8b2b9",
  "shopify": {
    "id": "gid://shopify/AppSubscription/39547699428"
  },
  "customer": {
    "id": "21d0a23a-30d7-406d-aee9-455bbd0b5bbd",
    "name": "high-volume-store",
    "email": "[email protected]",
    "tags": [
      "high-volume",
      "enterprise"
    ],
    "test": false,
    "platformId": "72364687588",
    "shopify": {
      "id": "72364687588",
      "shopId": "72364687588",
      "myshopifyDomain": "high-volume-store.myshopify.com",
      "planName": "Advanced",
      "isDevPlan": false,
      "isPlus": false
    },
    "installedAt": "2025-02-15T10:25:14.000Z",
    "uninstalledAt": null,
    "trialStartsAt": "2025-02-22T00:00:00.000Z",
    "trialExpiresAt": "2025-03-01T00:00:00.000Z",
    "billingStatus": "active",
    "lifetimeValue": 129.99,
    "averageMonthlyRevenue": 29.99
  }
}