Version
WEBHOOK

partner.referral_converted

The referred creator's first paid Starter or Growth invoice settled, locking the referral and fixing what it earns.

When this fires

Stripe reported a platform invoice of the referred creator paid for more than $0 on a Starter or Growth subscription while the referral was open, and the partner was active. Fires once per referral, immediately before the partner.reward_earned the same invoice produces.

The $0 trial invoice converts nothing, and neither does the Free plan. A card on trial is invoiced $0 and a creator on Free is invoiced only fees; the referral waits for the first paid plan invoice inside its window.

Caveats

  • A referral held for review converts quietly. When the card that paid the converting invoice matches the partner's own, or when the sign-up was held from the start, the referral is held under review and this event waits: it fires when Subscriby clears the referral, and the commissions written meanwhile are first heard of as partner.reward_approved. A rejected review emits partner.reward_reversed for each of them instead.
  • A later move to Free does not end the period. The creator's fee invoices keep earning until commission_ends_at.

Related events

  • partner.reward_earned: what the converting invoice earned.

Ability to subscribe

A token needs this to subscribe an endpoint to the event.

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.

Payload

JSONWhat Subscriby posts to your endpoint

The signed JSON envelope posted to your endpoint.

The envelope every event is delivered in.

Responses

2XXAny success status

Your endpoint acknowledged the delivery. Any 2xx status within 30 seconds marks it delivered; the response body is ignored.

defaultAny other status

Any other status, a connection failure, or no answer within 30 seconds counts as a failed attempt. The delivery is retried 8 times, after 10 seconds, 30 seconds, 2 minutes, 10 minutes, 1 hour, 6 hours, 1 day, 3 days; the last failure dead-letters it, and it can be retried from the dashboard or POST /v1/webhook-deliveries/{delivery}/retry. After 20 consecutive failures the endpoint is paused until it is resumed.

How is this guide?

Last updated on