post
https://appapi.heymantle.com/v1/webhooks/subscriptions/billing_cycle_started
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Triggered when a new billing cycle begins for a subscription, providing details about the billing period and subscription status.
Sample payload
{
"id": "b77de932-5f19-4953-96ca-47e4fd2ccdfb",
"plan": {
"id": "8ad66346-fc24-53fb-a211-g490b316cd20",
"name": "Professional",
"amount": 39.99,
"public": true,
"features": {
"analytics": {
"id": "d5b45ef9-fbc9-5be3-c24f-179396ee78f5",
"name": "Analytics",
"type": "limit_with_overage",
"value": "1000",
"description": "Monthly analytics reports",
"displayOrder": 4
},
"automation": {
"id": "36dd3548-7273-6e79-b92e-d9e2659bf629",
"name": "Automation",
"type": "boolean",
"value": true,
"description": "Automated workflows",
"displayOrder": 0
}
},
"interval": "EVERY_30_DAYS",
"createdAt": "2025-01-15T16:10:54.431Z",
"trialDays": 14,
"updatedAt": "2025-03-16T08:02:53.616Z",
"description": "Full suite of professional tools",
"currencyCode": "USD",
"customFields": {
"Flagship": "true",
"Recommended": "true"
},
"usageCharges": [
{
"id": "e8f9g0h1-i2j3-k4l5-m6n7-o8p9q0r1s2t3",
"type": "unit",
"terms": "Per analytics report over included limit",
"amount": 0.04,
"eventName": "analytics_report",
"cappedAmount": 120
}
],
"featuresOrder": [
"automation",
"analytics"
]
},
"topic": "subscriptions/billing_cycle_started",
"active": true,
"shopify": {
"id": "gid://shopify/AppSubscription/67890123456"
},
"cancelOn": null,
"customer": {
"id": "45h0b34c-69f8-507e-c8b2-566ccd3c6cce",
"name": "fashion-outlet",
"tags": [
"retail",
"apparel"
],
"test": false,
"email": "[email protected]",
"shopify": {
"id": "86543219876",
"isPlus": false,
"shopId": "86543219876",
"planName": "Shopify",
"isDevPlan": false,
"myshopifyDomain": "fashion-outlet.myshopify.com"
},
"platformId": "86543219876",
"installedAt": "2025-01-25T12:50:14.000Z",
"billingStatus": "active",
"lifetimeValue": 119.97,
"trialStartsAt": "2025-01-11T00:00:00.000Z",
"uninstalledAt": null,
"trialExpiresAt": "2025-01-25T00:00:00.000Z",
"averageMonthlyRevenue": 39.99
},
"features": {
"analytics": {
"id": "d5b45ef9-fbc9-5be3-c24f-179396ee78f5",
"name": "Analytics",
"type": "limit_with_overage",
"value": "1000",
"description": "Monthly analytics reports",
"displayOrder": 4
},
"automation": {
"id": "36dd3548-7273-6e79-b92e-d9e2659bf629",
"name": "Automation",
"type": "boolean",
"value": true,
"description": "Automated workflows",
"displayOrder": 0
}
},
"frozenAt": null,
"createdAt": "2025-01-25T12:55:10.377Z",
"canceledAt": null,
"activatedAt": "2025-01-25T12:55:19.119Z",
"usageCharges": [
{
"id": "e8f9g0h1-i2j3-k4l5-m6n7-o8p9q0r1s2t3",
"type": "unit",
"terms": "Per analytics report over included limit",
"amount": 0.04,
"eventName": "analytics_report",
"cappedAmount": 120
}
],
"featuresOrder": [
"automation",
"analytics"
],
"confirmationUrl": "https://fashion-outlet.myshopify.com/admin/charges/146098765432/67890123456/RecurringApplicationCharge/confirm_recurring_application_charge?signature=BAh7BzoHaWRsKwjkgD41CQA6EmF1dG9fYWN0aXZhdGVU--11170cda4e2f2f046b341f5384b71e0f7eaf4443",
"currentPeriodEnd": "2025-03-25T12:55:19.119Z",
"usageBalanceUsed": 0,
"usageCappedAmount": 120,
"currentPeriodStart": "2025-02-25T12:55:19.119Z",
"shopifySubscription": {
"id": "gid://shopify/AppSubscription/67890123456"
},
"previousBillingPeriod": {
"start": "2025-01-25T12:55:19.119Z",
"end": "2025-02-25T12:55:19.119Z"
}
}{
"id": "sub_B77de9325f194953",
"plan": {
"id": "price_8ad66346fc2453fb",
"name": "Professional",
"amount": 39.99,
"public": true,
"features": {
"analytics": {
"id": "feat_analytics_d5b45ef9",
"name": "Analytics",
"type": "limit_with_overage",
"value": "1000",
"description": "Monthly analytics reports",
"displayOrder": 4
},
"automation": {
"id": "feat_auto_36dd35487273",
"name": "Automation",
"type": "boolean",
"value": true,
"description": "Automated workflows",
"displayOrder": 0
}
},
"interval": "month",
"createdAt": "2025-01-15T16:10:54.431Z",
"trialDays": 14,
"updatedAt": "2025-03-16T08:02:53.616Z",
"description": "Full suite of professional tools",
"currencyCode": "USD",
"customFields": {
"Flagship": "true",
"Recommended": "true"
},
"usageCharges": [
{
"id": "uc_e8f9g0h1i2j3k4l5",
"type": "unit",
"terms": "Per analytics report over included limit",
"amount": 0.04,
"eventName": "analytics_report",
"cappedAmount": 120
}
],
"featuresOrder": [
"automation",
"analytics"
],
"stripe": {
"id": "price_8ad66346fc2453fb",
"createdAt": "2025-01-15T16:10:54.431Z"
}
},
"topic": "subscriptions/billing_cycle_started",
"active": true,
"cancelOn": null,
"customer": {
"id": "cus_45h0b34c69f8507e",
"name": "fashion-outlet",
"tags": [
"retail",
"apparel"
],
"test": false,
"email": "[email protected]",
"platformId": "86543219876",
"installedAt": "2025-01-25T12:50:14.000Z",
"billingStatus": "active",
"lifetimeValue": 119.97,
"trialStartsAt": "2025-01-11T00:00:00.000Z",
"uninstalledAt": null,
"trialExpiresAt": "2025-01-25T00:00:00.000Z",
"averageMonthlyRevenue": 39.99
},
"features": {
"analytics": {
"id": "feat_analytics_d5b45ef9",
"name": "Analytics",
"type": "limit_with_overage",
"value": "1000",
"description": "Monthly analytics reports",
"displayOrder": 4
},
"automation": {
"id": "feat_auto_36dd35487273",
"name": "Automation",
"type": "boolean",
"value": true,
"description": "Automated workflows",
"displayOrder": 0
}
},
"frozenAt": null,
"createdAt": "2025-01-25T12:55:10.377Z",
"canceledAt": null,
"activatedAt": "2025-01-25T12:55:19.119Z",
"usageCharges": [
{
"id": "uc_e8f9g0h1i2j3k4l5",
"type": "unit",
"terms": "Per analytics report over included limit",
"amount": 0.04,
"eventName": "analytics_report",
"cappedAmount": 120
}
],
"featuresOrder": [
"automation",
"analytics"
],
"confirmationUrl": null,
"currentPeriodEnd": "2025-03-25T12:55:19.119Z",
"usageBalanceUsed": 0,
"usageCappedAmount": 120,
"currentPeriodStart": "2025-02-25T12:55:19.119Z",
"previousBillingPeriod": {
"start": "2025-01-25T12:55:19.119Z",
"end": "2025-02-25T12:55:19.119Z"
},
"stripe": {
"id": "sub_B77de9325f194953",
"createdAt": "2025-01-25T12:55:10.377Z"
}
} 200Return a 200 status to indicate that the data was received successfully