Skip to main content

When this fires

A daily scan finds active subscriptions renewing within the next 3 days and emits this event once per renewal. The idempotency key is derived from the subscription and the renewal date, so re-running the scan never sends a duplicate. Subscriptions with a scheduled cancellation are excluded — no renewal invoice will be issued for them. Use it to notify the customer before they are charged. The payload intentionally carries no amount: usage-based charges are only final at renewal time, when invoice.created delivers the actual invoice.

Body

application/json
id
string
required
event
string
required
Allowed value: "invoice.upcoming"
timestamp
string
required
organizationId
string
required
mode
enum<string>
required
Available options:
live,
sandbox
apiVersion
string
required
data
object
required

Response

200

Return any 2xx status code to acknowledge receipt of the event.