Version
WEBHOOK

plan.created

A plan is first created on a project.

When this fires

A plan is created through the REST API (POST /v1/projects/{project}/plans) or the create_plan MCP tool, or a finished pass season is duplicated into its next season. Plans created from the creator dashboard or the bot do not emit this event. The plan is immediately eligible for purchase if it was created in the active state.

The two shapes are disjoint. The API and MCP path sends data.plan and nothing else; the season-duplication path sends the four flat keys and no data.plan object. Branch on whether data.plan or data.plan_id is present before reading any other field.

billing_cycle is only the unit. The multiplier lives in billing_cycle_count on the plan record and is not included in this payload: a "3 month" plan sends billing_cycle: "month" with no indication of the 3. Nor is trial_days. Fetch the plan with GET /v1/projects/{project}/plans/{plan} when you need the full cadence or trial configuration.

Caveats

  • A plan.created event does not imply the plan has been synced to a payment-provider catalog. Listen for plan.sync_completed for that.
  • Trial is configured at create time. A later trial-only edit is only applied, and only then fires plan.updated, when the PATCH also carries a kind key; without it the trial fields are dropped and no event is emitted.

Related events

  • plan.updated: subsequent edits.
  • plan.sync_completed: provider catalog sync.

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