payment.succeeded

When this fires

A payment provider confirms a successful charge against a subscriber. Fires for both initial checkouts and recurring renewals.

Required ability

project-subscription:view-any — token must carry this at mint time to subscribe an endpoint to this event.

Payload

{
  "id": "evt_01HX...",
  "type": "payment.succeeded",
  "created_at": "2026-05-18T10:05:00Z",
  "api_version": "2026-05-01",
  "project_id": "prj_01HX...",
  "data": {
    "subscription_id": "sub_01HX...",
    "plan_id": "pln_01HX...",
    "subscriber_id": "usr_01HX...",
    "provider": "stripe",
    "external_payment_id": "pi_3Nxy..",
    "amount": "29.00",
    "currency": "USD",
    "billing_reason": "subscription_create"
  }
}

Field reference

Field	Type	Notes
`id`	string ULID	Unique event id, prefixed `evt_`. Use for idempotent processing.
`type`	string	Always `payment.succeeded` for this event.
`created_at`	ISO 8601 timestamp	Server-side emission time.
`api_version`	string	Webhook API contract version.
`project_id`	string ULID	Project this event belongs to.
`data.subscription_id`	string ULID	Subscription identifier.
`data.plan_id`	string ULID	Plan the subscription is on.
`data.subscriber_id`	string ULID	Subscriber's project-scoped user id.
`data.provider`	string	Provider slug.
`data.external_payment_id`	string	Provider charge id.
`data.amount`	string	Charged amount in major units of `currency`, formatted as a string.
`data.currency`	string	ISO 4217 currency code.
`data.billing_reason`	string \| undefined	Provider-specific billing reason, e.g. Stripe's `subscription_create`, `subscription_cycle`. Omitted for providers that don't supply it.

Caveats

For first-time checkouts, subscription.created is the canonical "subscription exists" event — don't act on payment.succeeded alone.
Renewals pair payment.succeeded with subscription.renewed.
Card numbers, PAN, and CVV are never included in payloads.

subscription.created, subscription.renewed — paired subscription events.
payment.failed — alternative outcome.
Payment events overview — back to family overview.