Skip to main content
WEBHOOK
order
{
  "event_type": "subscription",
  "event_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "event_timestamp": "2023-11-07T05:31:56Z",
  "is_livemode": true,
  "user": {
    "external_id": "<string>",
    "email": "<string>"
  },
  "subtype": "settled",
  "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>"
    }
  },
  "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": {}
  },
  "oneoff": {
    "oneoff_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"
    },
    "started_at": "2023-11-07T05:31:56Z",
    "initial_order_metadata": {},
    "order_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revoked_at": "2023-11-07T05:31:56Z"
  }
}

Body

application/json

Sent when a payment reaches Settled status. You can also receive Declined events (disabled by default).

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
user
object
required
subtype
enum<string>
required
Available options:
settled,
declined
order
object
subscription
object
oneoff
object