订阅 Webhook

订阅 Webhook 事件

订阅在其生命周期的每个阶段都会发出一个事件：

事件	触发时机
`subscription.active`	订阅成功激活并安排定期扣款时。
`subscription.updated`	订阅的任何字段发生变化时（无需轮询即可实时同步）。
`subscription.past_due`	续费失败且宽限期开始时；客户在截止时间前仍可继续使用。payload 包含 `past_due_ends_at`。
`subscription.on_hold`	由于续费失败，订阅被暂停时。
`subscription.paused`	订阅被暂停时。
`subscription.unpaused`	已暂停的订阅恢复时。
`subscription.renewed`	订阅续订至下一个计费周期时。
`subscription.plan_changed`	订阅升级、降级或修改为不同的附加项时。
`subscription.update_payment_method`	订阅的付款方式更新时。
`subscription.cancelled`	订阅由商家或客户取消时。
`subscription.failed`	创建 mandate 期间订阅创建失败时。
`subscription.expired`	订阅达到其期限结束并过期时。

使用 `subscription.updated` 进行实时同步

当任何订阅字段发生更改时，subscription.updated webhook 会触发，从而使您无需轮询即可保持应用程序状态同步：

app.post('/webhooks/dodo', async (req, res) => {
  // Verify the signature first. See /developer-resources/webhooks#verifying-signatures.
  // With express.raw(), req.body is a Buffer, so parse it after verification.
  const event = JSON.parse(req.body);
  
  if (event.type === 'subscription.updated') {
    const subscription = event.data;
    
    // Sync subscription changes to your database
    await syncSubscription(subscription.subscription_id, {
      status: subscription.status,
      next_billing_date: subscription.next_billing_date,
      metadata: subscription.metadata,
      // ... other fields you want to track
    });
    
    console.log(`Subscription ${subscription.subscription_id} updated`);
  }
  
  res.json({ received: true });
});

订阅 subscription.updated 以获取有关任何订阅更改的实时通知，从而无需轮询 API 以获取更新。

Webhook 有效负载架构

Subscription payload sent on a webhook. It carries every field of SubscriptionResponse, plus the grace-period deadline.

addons

Addon Cart Response Item · object[]

必填

Addons associated with this subscription

Show child attributes

billing

object

必填

Billing address details for payments

Show child attributes

billing_mode

enum<string>

必填

invoice_led when invoices bill the subscription. normal otherwise.

可用选项:

normal,

invoice_led

brand_id

string

必填

Brand id this subscription belongs to

cancel_at_next_billing_date

boolean

必填

Indicates if the subscription will cancel at the next billing date

created_at

string<date-time>

必填

Timestamp when the subscription was created

credit_entitlement_cart

object[]

必填

Credit entitlement cart settings for this subscription

Show child attributes

currency

enum<string>

必填

Currency used for the subscription payments

可用选项:

AED,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BWP,

BYN,

BZD,

CAD,

CHF,

CLP,

CNY,

COP,

CRC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STN,

SVC,

SZL,

THB,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW

customer

object

必填

Customer details associated with the subscription

Show child attributes

has_payment_method

boolean

必填

Whether a payment method is on file. False while a card-optional subscription waits for the customer to add one.

metadata

Metadata · object

必填

Additional custom data associated with the subscription

Show child attributes

meter_credit_entitlement_cart

object[]

必填

Meter credit entitlement cart settings for this subscription

Show child attributes

meters

object[]

必填

Meters associated with this subscription (for usage-based billing)

Show child attributes

next_billing_date

string<date-time>

必填

Timestamp of the next scheduled billing. Indicates the end of current billing period

on_demand

boolean

必填

Wether the subscription is on-demand or not

payment_frequency_count

integer<int32>

必填

Number of payment frequency intervals

payment_frequency_interval

enum<string>

必填

Time interval for payment frequency (e.g. month, year)

可用选项:

Day,

Week,

Month,

Year

previous_billing_date

string<date-time>

必填

Timestamp of the last payment. Indicates the start of current billing period

product_id

string

必填

Identifier of the product associated with this subscription

quantity

integer<int32>

必填

Number of units/items included in the subscription

recurring_pre_tax_amount

integer<int32>

必填

Amount charged before tax for each recurring payment in the currency's smallest unit (cents for USD, yen for JPY, fils for KWD)

status

enum<string>

必填

Current status of the subscription

可用选项:

pending,

active,

on_hold,

paused,

cancelled,

failed,

expired,

past_due

subscription_id

string

必填

Unique identifier for the subscription

subscription_period_count

integer<int32>

必填

Number of subscription period intervals

subscription_period_interval

enum<string>

必填

Time interval for the subscription period (e.g. month, year)

可用选项:

Day,

Week,

Month,

Year

tax_inclusive

boolean

必填

Indicates if the recurring_pre_tax_amount is tax inclusive

trial_period_days

integer<int32>

必填

Number of days in the trial period (0 if no trial)

cancellation_comment

string | null

Free-text cancellation comment, if any

cancellation_feedback

null | enum<string>

Customer-supplied churn reason, if any

可用选项:

too_expensive,

missing_features,

switched_service,

unused,

customer_service,

low_quality,

too_complex,

other

cancelled_at

string<date-time> | null

Cancelled timestamp if the subscription is cancelled

cancelled_by

null | object

The caller that cancelled the subscription or scheduled its cancel. null when no caller is known, for example when the system cancelled the subscription.

Show child attributes

collection_method

null | enum<string>

How an invoice-led subscription collects each invoice. null for normal.

可用选项:

auto_charge,

manual

custom_field_responses

object[] | null

Customer's responses to custom fields collected during checkout

Show child attributes

customer_business_name

string | null

Business / legal name associated with the tax id (B2B). When set this is used on the invoice in place of the customer's personal name.

discount_cycles_remaining

integer<int32> | null

DEPRECATED: Use discounts[].cycles_remaining instead.

discount_id

string | null

DEPRECATED: Use discounts instead. Returns the first discount's ID if present.

discounts

object[] | null

All stacked discounts applied, ordered by position

Show child attributes

expires_at

string<date-time> | null

Timestamp when the subscription will expire

paused_at

string<date-time> | null

Timestamp when the subscription was paused, if it currently is (or is OnHold due to an unresolved pause settlement). null otherwise.

payment_method_id

string | null

Saved payment method id used for recurring charges

payment_terms_days

integer<int32> | null

Days from the invoice date to the due date. null for normal.

scheduled_change

null | object

Scheduled plan change details, if any

Show child attributes

tax_id

string | null

Tax identifier provided for this subscription (if applicable)

trial_amount

integer<int32> | null

Per-unit trial amount after discounts, snapshotted at subscription creation (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no trial.

past_due_ends_at

string<date-time> | null

Time when the grace period ends. The subscription moves to on_hold or to cancelled at this time.

Read in the same query as the rest of the payload, so it always comes from the row snapshot that produced status. It is set whenever the subscription sits in a window at that moment. A delayed event of another type therefore carries the deadline too, next to a past_due status.

payment_id

string | null

Identifier of the payment that caused this event. It is set only for subscription.renewed. It is null for all other subscription events.

最后修改于 2026年9月26日

{
  "addons": [
    {
      "addon_id": "<string>",
      "quantity": 123
    }
  ],
  "billing": {
    "city": "<string>",
    "state": "<string>",
    "street": "<string>",
    "zipcode": "<string>"
  },
  "brand_id": "<string>",
  "cancel_at_next_billing_date": true,
  "created_at": "2023-11-07T05:31:56Z",
  "credit_entitlement_cart": [
    {
      "credit_entitlement_id": "<string>",
      "credit_entitlement_name": "<string>",
      "credits_amount": "<string>",
      "overage_balance": "<string>",
      "overage_enabled": true,
      "product_id": "<string>",
      "remaining_balance": "<string>",
      "rollover_enabled": true,
      "unit": "<string>",
      "expires_after_days": 123,
      "low_balance_threshold_percent": 123,
      "max_rollover_count": 123,
      "overage_limit": "<string>",
      "rollover_percentage": 123,
      "rollover_timeframe_count": 123
    }
  ],
  "customer": {
    "customer_id": "<string>",
    "email": "<string>",
    "name": "<string>",
    "metadata": {},
    "phone_number": "<string>"
  },
  "has_payment_method": true,
  "metadata": {},
  "meter_credit_entitlement_cart": [
    {
      "credit_entitlement_id": "<string>",
      "meter_id": "<string>",
      "meter_name": "<string>",
      "meter_units_per_credit": "<string>",
      "product_id": "<string>"
    }
  ],
  "meters": [
    {
      "free_threshold": 123,
      "measurement_unit": "<string>",
      "meter_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "price_per_unit": "10.50"
    }
  ],
  "next_billing_date": "2023-11-07T05:31:56Z",
  "on_demand": true,
  "payment_frequency_count": 123,
  "previous_billing_date": "2023-11-07T05:31:56Z",
  "product_id": "<string>",
  "quantity": 123,
  "recurring_pre_tax_amount": 123,
  "subscription_id": "<string>",
  "subscription_period_count": 123,
  "tax_inclusive": true,
  "trial_period_days": 123,
  "cancellation_comment": "<string>",
  "cancelled_at": "2023-11-07T05:31:56Z",
  "cancelled_by": {
    "email": "<string>",
    "name": "<string>"
  },
  "custom_field_responses": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "customer_business_name": "<string>",
  "discount_cycles_remaining": 123,
  "discount_id": "<string>",
  "discounts": [
    {
      "amount": 123,
      "business_id": "<string>",
      "code": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "discount_id": "<string>",
      "metadata": {},
      "position": 123,
      "preserve_on_plan_change": true,
      "restricted_to": [
        "<string>"
      ],
      "times_used": 123,
      "cycles_remaining": 123,
      "expires_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "subscription_cycles": 123,
      "usage_limit": 123
    }
  ],
  "expires_at": "2023-11-07T05:31:56Z",
  "paused_at": "2023-11-07T05:31:56Z",
  "payment_method_id": "<string>",
  "payment_terms_days": 123,
  "scheduled_change": {
    "addons": [
      {
        "addon_id": "<string>",
        "name": "<string>",
        "quantity": 123
      }
    ],
    "created_at": "2023-11-07T05:31:56Z",
    "effective_at": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "product_id": "<string>",
    "quantity": 123,
    "product_description": "<string>",
    "product_name": "<string>"
  },
  "tax_id": "<string>",
  "trial_amount": 123,
  "past_due_ends_at": "2023-11-07T05:31:56Z",
  "payment_id": "<string>"
}

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

订阅 Webhook 事件

使用 `subscription.updated` 进行实时同步

Webhook 有效负载架构

订阅 Webhook 事件

使用 subscription.updated 进行实时同步

Webhook 有效负载架构

使用 `subscription.updated` 进行实时同步