Skip to main content

When this fires

A daily scan finds trials ending within the next 3 days and emits this event once per trial. The idempotency key is derived from the subscription and the trial end date, so re-running the scan never sends a duplicate. Use it to remind the customer that billing starts on trialEndsAt — the single most effective moment to prevent involuntary churn and surprise charges. If the trial end date changes after this event fired (for example, the customer converts early), trial.converted or trial.expired reflects the final outcome.

Body

application/json
id
string
required
event
string
required
Allowed value: "trial.will_end"
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.