WEBHOOK
subscription.billing_month.ends_soon
{
  "type": "subscription.billing_month.ends_soon",
  "messageId": "a6ce...",
  "traceId": "549a...",
  "entityId": "subscription-uuid",
  "id": "subscription-id",
  "status": "ACTIVE",
  "paymentCollection": "NOT_REQUIRED",
  "startDate": "2023-06-10T11:22:33.001Z",
  "currentBillingMonthStart": "2024-10-10T11:22:33.001Z",
  "currentBillingMonthEnd": "2024-11-10T11:22:33.001Z",
  "currentBillingPeriodStart": "2024-06-10T11:22:33.001Z",
  "currentBillingPeriodEnd": "2025-06-10T11:22:33.001Z",
  "billingPeriod": "ANNUALLY",
  "billingCurrency": "ils",
  "entitlements": [
    {
      "feature": {
        "id": "feature-01-stores",
        "name": "Stores",
        "description": "",
        "unit": "Store",
        "units": "Stores"
      },
      "usageLimit": 5,
      "currentUsage": 3,
      "usagePeriodAnchor": null,
      "usagePeriodStart": null,
      "usagePeriodEnd": null,
      "resetPeriod": null
    }
  ]
}

Body

application/json

Minimal subscription object embedded in events.

​
entityId
string | null

Stigg UUID of the subscription entity.

​
id
string

Subscription identifier in Stigg.

​
billingId
string | null

Identifier for the subscription in the billing provider.

​
status
string

Current subscription status (e.g., ACTIVE, PAYMENT_PENDING).

​
startDate
string<date-time> | null

Subscription start timestamp (ISO 8601).

​
endDate
string<date-time> | null

Subscription end timestamp if scheduled/ended.

​
cancellationDate
string<date-time> | null

Effective cancellation timestamp, if canceled.

​
trialEndDate
string<date-time> | null

Trial end timestamp, if in trial or recently converted.

​
currentBillingPeriodStart
string<date-time> | null

Start timestamp of the current billing period.

​
currentBillingPeriodEnd
string<date-time> | null

End timestamp of the current billing period.

​
billingPeriod
string | null

Billing interval for the plan (e.g., MONTHLY, ANNUALLY).

​
billingCurrency
string | null

ISO currency code for this subscription’s charges.

​
isTrialSubscription
boolean | null

Whether the subscription is currently a trial.

​
paymentCollection
string | null

Whether payment collection is required (e.g., NOT_REQUIRED).

​
resource
any

Resource scoping for the subscription, if resource-based.

​
plan
object

Minimal plan object embedded in events.

​
addons
object[]

Add-ons currently attached to the subscription.

​
metadata
object | null

Arbitrary key-value metadata attached to the subscription.

​
currentBillingMonthStart
string<date-time>
​
currentBillingMonthEnd
string<date-time>
​
entitlements
object[]