Skip to main content
WEBHOOK
subscription
{
  "event_type": "subscription",
  "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_timestamp": "2023-11-07T05:31:56Z",
  "is_livemode": true,
  "subtype": "starting_trial",
  "external_id": "<string>",
  "subscription": {
    "subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "is_active": true,
    "price_point": {
      "ident": "<string>",
      "currency": {
        "code": "<string>",
        "minor_units": 123,
        "title": "<string>",
        "symbol": "<string>"
      },
      "intro_type": "no_intro",
      "features": [
        {
          "ident": "<string>"
        }
      ],
      "lifetime_price": 123,
      "intro_free_trial_period": 123,
      "intro_free_trial_period_duration": "minutes",
      "intro_paid_trial_price": 123,
      "intro_paid_trial_period": 123,
      "intro_paid_trial_period_duration": "minutes",
      "next_price": 123,
      "next_period": 123,
      "next_period_duration": "minutes"
    },
    "status": [
      "<string>"
    ],
    "started_at": "2023-11-07T05:31:56Z",
    "current_period_starts_at": "2023-11-07T05:31:56Z",
    "current_period_ends_at": "2023-11-07T05:31:56Z",
    "next_check_at": "2023-11-07T05:31:56Z",
    "iteration": 123,
    "available_actions": [
      "pause"
    ],
    "initial_order_metadata": {}
  },
  "user": {
    "external_id": "<string>",
    "email": "<string>"
  },
  "order": {
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "amount": 123,
    "currency_code": "<string>",
    "external_id": "<string>",
    "user_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "initial_order_metadata": {},
    "psp": "<string>",
    "status": "settled",
    "subs_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "oneoff_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "retry_step": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "decline_reason": {
      "message": "<string>",
      "type": "<string>",
      "code": "<string>",
      "decline_type": "<string>"
    }
  }
}

Body

application/json

Sent when a subscription changes state. Subtypes describe changes across the subscription lifecycle:

  • STARTING_TRIAL - Trial period starts
  • CONVERTION - Trial converts to paid subscription
  • RENEWING - Subscription renews (regular charge)
  • UNSUBSCRIPTION - User cancels subscription (auto-renewal disabled)
  • PLANNING_POSTPONED_SUBSCRIPTION - Subscription with UPCOMING status scheduled to start when delayed_start migration is used
  • PAUSING - Subscription paused
  • DEFERRING - Next charge date postponed
  • RESUMING - Paused subscription resumes
  • RECOVERING_AUTORENEW - Auto-renewal restored after failure
  • EXPIRATION - Subscription expired
  • UNKNOWN - Unknown or unclassified event
  • START_GRACE - Grace period starts after failed charge
  • START_RETRY - Retry attempts start without grace period
  • FINISH_GRACE - Grace period ends
  • RECOVERING - Recovered from grace/retry state
​
event_type
enum<string>
required
Available options:
subscription,
oneoff,
order,
refund
​
event_id
string<uuid>
required
​
event_timestamp
string<date-time>
required
​
is_livemode
boolean
required
​
subtype
enum<string>
required
Available options:
starting_trial,
convertion,
renewing,
unsubscription,
planning_postponed_subscription,
pausing,
defering,
resuming,
recovering_autorenew,
expiration,
unknown,
start_grace,
start_retry,
finish_grace,
recovering
​
external_id
string
required
​
subscription
object
required
​
user
object
required
​
order
object