subscription.trial_started

Trial-enabled plan starts free window.

Ability to subscribeproject-subscription:view

When this fires

A subscriber starts a trial on a trial-enabled plan. Three paths emit it: a cardless trial, an access-code redemption against a trial plan, or a Stripe checkout that begins in a trial window.

Trial checkouts through the other providers (PayPal, Paystack, Razorpay, Skrill, CeyPay, CoinPayments) do not currently emit this event; only Stripe reports the trialing status transition back to Subscriby.

Pairs with member.trial_joined: both fire together when a subscriber starts a trial on the cardless-trial and access-code paths.

The data keys differ by path. Absent keys are omitted entirely, not sent as null.

Caveats

  • On the cardless-trial and access-code paths this is paired with subscription.created and member.trial_joined for the same subscription_id. On the Stripe path it is paired with subscription.activated instead, and no member.* join event fires.
  • Plans with trial_days = 0 skip this event entirely.

Related events

  • subscription.trial_converting: fires 24h before trial_ends_at.
  • subscription.trial_expired: fires if no conversion occurs.

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/subscription.trial_started

How is this guide?