Version
WEBHOOK

partner.reward_earned

A paid platform invoice of a referred creator earned the partner a commission.

When this fires

Stripe reported an invoice of a converted referral paid, inside the commission period: the converting invoice itself, every renewal after it, an addon invoice, and the fee invoices of a creator who later moved to Free. One event per invoice. The commission is priced from the invoice's total before tax and after any discount, so the referred creator's 20% off their first three months lowers the first three commissions: a Starter month earns "9.3600" on a "31.2000" base, then "11.7000" on "39.0000".

Money waits. A commission is born pending behind a 30-day hold, so a refund inside the window can take it back; hold_until says when it becomes payable.

Caveats

  • A redelivered invoice earns nothing twice. A second invoice.paid for the same invoice finds its row and writes no other.
  • A suspended partner earns nothing, and the invoice is not revisited when they are reinstated.
  • A referral under review earns silently. Its rows are written but not announced until the review is decided.

Related events

  • partner.reward_approved: the hold passes.
  • partner.reward_reversed: a refund takes it back.

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