Webhooks d’abonnement

Événements Webhook d’Abonnement

Un abonnement émet un événement à chaque étape de son cycle de vie :

Événement	Déclenché lorsque
`subscription.active`	Un abonnement est activé avec succès et les prélèvements récurrents sont planifiés.
`subscription.updated`	Un champ de l’abonnement est modifié (synchronisation en temps réel sans interrogation périodique).
`subscription.past_due`	Un renouvellement échoue et la période de grâce commence ; le client conserve son accès jusqu’à la date limite. Le payload inclut `past_due_ends_at`.
`subscription.on_hold`	Un abonnement est suspendu en raison d’un échec de renouvellement.
`subscription.paused`	Un abonnement est mis en pause.
`subscription.unpaused`	Un abonnement mis en pause reprend.
`subscription.renewed`	Un abonnement est renouvelé pour la prochaine période de facturation.
`subscription.plan_changed`	Un abonnement est mis à niveau, rétrogradé ou modifié avec des modules complémentaires différents.
`subscription.update_payment_method`	Le moyen de paiement d’un abonnement est mis à jour.
`subscription.cancelled`	Un abonnement est annulé par le marchand ou le client.
`subscription.failed`	La création d’un abonnement échoue lors de la création du mandat.
`subscription.expired`	Un abonnement arrive au terme de sa durée et expire.

Utilisation de `subscription.updated` pour la synchronisation en temps réel

Le webhook subscription.updated se déclenche chaque fois qu’un champ d’abonnement change, vous permettant de maintenir l’état de votre application synchronisé sans avoir à sonder l’API pour obtenir des mises à jour :

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 });
});

Abonnez-vous à subscription.updated pour recevoir des notifications en temps réel concernant tout changement d’abonnement, ce qui élimine la nécessité de sonder l’API pour obtenir des mises à jour.

Schéma de Charge Utile Webhook

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

addons

Addon Cart Response Item · object[]

requis

Addons associated with this subscription

Show child attributes

billing

object

requis

Billing address details for payments

Show child attributes

billing_mode

enum<string>

requis

invoice_led when invoices bill the subscription. normal otherwise.

Options disponibles:

normal,

invoice_led

brand_id

string

requis

Brand id this subscription belongs to

cancel_at_next_billing_date

boolean

requis

Indicates if the subscription will cancel at the next billing date

created_at

string<date-time>

requis

Timestamp when the subscription was created

credit_entitlement_cart

object[]

requis

Credit entitlement cart settings for this subscription

Show child attributes

currency

enum<string>

requis

Currency used for the subscription payments

Options disponibles:

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

requis

Customer details associated with the subscription

Show child attributes

has_payment_method

boolean

requis

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

metadata

Metadata · object

requis

Additional custom data associated with the subscription

Show child attributes

meter_credit_entitlement_cart

object[]

requis

Meter credit entitlement cart settings for this subscription

Show child attributes

meters

object[]

requis

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

Show child attributes

next_billing_date

string<date-time>

requis

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

on_demand

boolean

requis

Wether the subscription is on-demand or not

payment_frequency_count

integer<int32>

requis

Number of payment frequency intervals

payment_frequency_interval

enum<string>

requis

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

Options disponibles:

Day,

Week,

Month,

Year

previous_billing_date

string<date-time>

requis

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

product_id

string

requis

Identifier of the product associated with this subscription

quantity

integer<int32>

requis

Number of units/items included in the subscription

recurring_pre_tax_amount

integer<int32>

requis

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>

requis

Current status of the subscription

Options disponibles:

pending,

active,

on_hold,

paused,

cancelled,

failed,

expired,

past_due

subscription_id

string

requis

Unique identifier for the subscription

subscription_period_count

integer<int32>

requis

Number of subscription period intervals

subscription_period_interval

enum<string>

requis

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

Options disponibles:

Day,

Week,

Month,

Year

tax_inclusive

boolean

requis

Indicates if the recurring_pre_tax_amount is tax inclusive

trial_period_days

integer<int32>

requis

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

Options disponibles:

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.

Options disponibles:

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.

Dernière modification le 26 septembre 2026

{
  "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

Événements Webhook d’Abonnement

Utilisation de `subscription.updated` pour la synchronisation en temps réel

Schéma de Charge Utile Webhook

Événements Webhook d’Abonnement

Utilisation de subscription.updated pour la synchronisation en temps réel

Schéma de Charge Utile Webhook

Utilisation de `subscription.updated` pour la synchronisation en temps réel