Webhooks de suscripción

Eventos de Webhook de Suscripción

Una suscripción emite un evento en cada etapa de su ciclo de vida:

Evento	Se activa cuando
`subscription.active`	Una suscripción se activa correctamente y se programan los cargos recurrentes.
`subscription.updated`	Cualquier campo de la suscripción cambia (sincronización en tiempo real sin sondeo).
`subscription.past_due`	Una renovación falla y comienza el período de gracia; el cliente mantiene el acceso hasta la fecha límite. La carga útil incluye `past_due_ends_at`.
`subscription.on_hold`	Una suscripción se pone en espera debido a un error en la renovación.
`subscription.paused`	Una suscripción se pausa.
`subscription.unpaused`	Se reanuda una suscripción pausada.
`subscription.renewed`	Una suscripción se renueva para el siguiente período de facturación.
`subscription.plan_changed`	Una suscripción se actualiza, degrada o modifica con complementos diferentes.
`subscription.update_payment_method`	Se actualiza el método de pago de una suscripción.
`subscription.cancelled`	El comerciante o el cliente cancela una suscripción.
`subscription.failed`	La creación de una suscripción falla durante la creación del mandato.
`subscription.expired`	Una suscripción llega al final de su plazo y caduca.

Usando `subscription.updated` para sincronización en tiempo real

El webhook subscription.updated se activa cada vez que cambia cualquier campo de la suscripción, lo que te permite mantener el estado de tu aplicación sincronizado sin tener que hacer polling:

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

Suscríbete a subscription.updated para recibir notificaciones en tiempo real sobre cualquier cambio en la suscripción, eliminando la necesidad de hacer polling a la API para obtener actualizaciones.

Esquema de Carga Útil del Webhook

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

addons

Addon Cart Response Item · object[]

requerido

Addons associated with this subscription

Show child attributes

billing

object

requerido

Billing address details for payments

Show child attributes

billing_mode

enum<string>

requerido

invoice_led when invoices bill the subscription. normal otherwise.

Opciones disponibles:

normal,

invoice_led

brand_id

string

requerido

Brand id this subscription belongs to

cancel_at_next_billing_date

boolean

requerido

Indicates if the subscription will cancel at the next billing date

created_at

string<date-time>

requerido

Timestamp when the subscription was created

credit_entitlement_cart

object[]

requerido

Credit entitlement cart settings for this subscription

Show child attributes

currency

enum<string>

requerido

Currency used for the subscription payments

Opciones 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

requerido

Customer details associated with the subscription

Show child attributes

has_payment_method

boolean

requerido

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

metadata

Metadata · object

requerido

Additional custom data associated with the subscription

Show child attributes

meter_credit_entitlement_cart

object[]

requerido

Meter credit entitlement cart settings for this subscription

Show child attributes

meters

object[]

requerido

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

Show child attributes

next_billing_date

string<date-time>

requerido

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

on_demand

boolean

requerido

Wether the subscription is on-demand or not

payment_frequency_count

integer<int32>

requerido

Number of payment frequency intervals

payment_frequency_interval

enum<string>

requerido

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

Opciones disponibles:

Day,

Week,

Month,

Year

previous_billing_date

string<date-time>

requerido

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

product_id

string

requerido

Identifier of the product associated with this subscription

quantity

integer<int32>

requerido

Number of units/items included in the subscription

recurring_pre_tax_amount

integer<int32>

requerido

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>

requerido

Current status of the subscription

Opciones disponibles:

pending,

active,

on_hold,

paused,

cancelled,

failed,

expired,

past_due

subscription_id

string

requerido

Unique identifier for the subscription

subscription_period_count

integer<int32>

requerido

Number of subscription period intervals

subscription_period_interval

enum<string>

requerido

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

Opciones disponibles:

Day,

Week,

Month,

Year

tax_inclusive

boolean

requerido

Indicates if the recurring_pre_tax_amount is tax inclusive

trial_period_days

integer<int32>

requerido

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

Opciones 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.

Opciones 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.

Última modificación el 26 de septiembre de 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

Eventos de Webhook de Suscripción

Usando `subscription.updated` para sincronización en tiempo real

Esquema de Carga Útil del Webhook

Eventos de Webhook de Suscripción

Usando subscription.updated para sincronización en tiempo real

Esquema de Carga Útil del Webhook

Usando `subscription.updated` para sincronización en tiempo real