payment.succeeded

A provider confirms a successful charge.

Ability to subscribeproject-subscription:view

When this fires

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

Caveats

  • For first-time paid checkouts, subscription.activated is the matching subscription-level event, not subscription.created, which never fires for paid purchases.
  • Renewals pair payment.succeeded with subscription.renewed.
  • Card numbers, PAN, and CVV are never included in payloads.

Related events

  • subscription.activated (first payment), subscription.renewed (renewals): paired subscription events.
  • payment.failed: alternative outcome.

Header Parameters

SB-Signature*string

t=<unix seconds>,v1=<hex>: the HMAC-SHA256 of "<t>.<raw body>" under the endpoint's secret. Verify it before acting, and refuse a t more than 300 seconds from now. During a secret rotation a v0= signature under the previous secret may precede v1=.

SB-Event-Id*string

The event's ULID, bare. The envelope's id is the same ULID prefixed evt_, so strip the prefix before comparing. Deduplicate on it: a retry carries the same id.

SB-Event-Name*string

The event name, the same as the envelope's type.

Content-Type*string

Always application/json.

User-Agent*string

Always Subscriby-Webhooks/1.0.

Request Body

application/json

The signed JSON envelope posted to your endpoint.

TypeScript Definitions

Use the request body type in TypeScript.

The envelope every event is delivered in.

Response Body

Example Requests

POST/payment.succeeded

How is this guide?