Abonnement

Abonnement Webhook-Ereignisse

Die folgenden Webhook-Ereignisse stehen zur Verfügung, um Änderungen im Lebenszyklus von Abonnements zu verfolgen:

Ereignis	Beschreibung
`subscription.active`	Abonnement wurde erfolgreich aktiviert
`subscription.updated`	Abonnement-Objekt wurde aktualisiert (jede Feldänderung löst dieses Ereignis aus)
`subscription.on_hold`	Abonnement wurde aufgrund fehlgeschlagener Verlängerung pausiert
`subscription.renewed`	Abonnement wurde für den nächsten Abrechnungszeitraum verlängert
`subscription.plan_changed`	Abonnement-Plan wurde aktualisiert, herabgestuft oder geändert
`subscription.cancelled`	Abonnement wurde storniert
`subscription.failed`	Erstellung des Abonnements ist während der Mandatserstellung fehlgeschlagen
`subscription.expired`	Abonnement hat das Ende seiner Laufzeit erreicht

Verwendung von `subscription.updated` für Echtzeitsynchronisierung

Der subscription.updated Webhook wird ausgelöst, wenn sich ein beliebiges Abonnementfeld ändert, sodass Sie den Status Ihrer Anwendung ohne Polling synchron halten können:

app.post('/webhooks/dodo', async (req, res) => {
  const event = 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 });
});

Abonnieren Sie subscription.updated, um Echtzeitbenachrichtigungen über Änderungen an Abonnements zu erhalten, wodurch die Notwendigkeit entfällt, die API auf Updates zu überprüfen.

Webhook-Nutzlastschema

Response struct representing subscription details

addons

Addon Cart Response Item · object[]

required

Addons associated with this subscription

Anzeigen untergeordnete attribute

addons.addon_id

string

required

addons.quantity

integer<int32>

required

billing

object

required

Billing address details for payments

Anzeigen untergeordnete attribute

billing.country

enum<string>

required

Two-letter ISO country code (ISO 3166-1 alpha-2)

Verfügbare Optionen:

AF,

AX,

AL,

DZ,

AS,

AD,

AO,

AI,

AQ,

AG,

AR,

AM,

AW,

AU,

AT,

AZ,

BS,

BH,

BD,

BB,

BY,

BE,

BZ,

BJ,

BM,

BT,

BO,

BQ,

BA,

BW,

BV,

BR,

IO,

BN,

BG,

BF,

BI,

KH,

CM,

CA,

CV,

KY,

CF,

TD,

CL,

CN,

CX,

CC,

CO,

KM,

CG,

CD,

CK,

CR,

CI,

HR,

CU,

CW,

CY,

CZ,

DK,

DJ,

DM,

DO,

EC,

EG,

SV,

GQ,

ER,

EE,

ET,

FK,

FO,

FJ,

FI,

FR,

GF,

PF,

TF,

GA,

GM,

GE,

DE,

GH,

GI,

GR,

GL,

GD,

GP,

GU,

GT,

GG,

GN,

GW,

GY,

HT,

HM,

VA,

HN,

HK,

HU,

IS,

IN,

ID,

IR,

IQ,

IE,

IM,

IL,

IT,

JM,

JP,

JE,

JO,

KZ,

KE,

KI,

KP,

KR,

KW,

KG,

LA,

LV,

LB,

LS,

LR,

LY,

LI,

LT,

LU,

MO,

MK,

MG,

MW,

MY,

MV,

ML,

MT,

MH,

MQ,

MR,

MU,

YT,

MX,

FM,

MD,

MC,

MN,

ME,

MS,

MA,

MZ,

MM,

NA,

NR,

NP,

NL,

NC,

NZ,

NI,

NE,

NG,

NU,

NF,

MP,

NO,

OM,

PK,

PW,

PS,

PA,

PG,

PY,

PE,

PH,

PN,

PL,

PT,

PR,

QA,

RE,

RO,

RU,

RW,

BL,

SH,

KN,

LC,

MF,

PM,

VC,

WS,

SM,

ST,

SA,

SN,

RS,

SC,

SL,

SG,

SX,

SK,

SI,

SB,

SO,

ZA,

GS,

SS,

ES,

LK,

SD,

SR,

SJ,

SZ,

SE,

CH,

SY,

TW,

TJ,

TZ,

TH,

TL,

TG,

TK,

TO,

TT,

TN,

TR,

TM,

TC,

TV,

UG,

UA,

AE,

GB,

UM,

US,

UY,

UZ,

VU,

VE,

VN,

VG,

VI,

WF,

EH,

YE,

ZM,

ZW

billing.city

string | null

City name

billing.state

string | null

State or province name

billing.street

string | null

Street address including house number and unit/apartment if applicable

billing.zipcode

string | null

Postal code or ZIP code

cancel_at_next_billing_date

boolean

required

Indicates if the subscription will cancel at the next billing date

created_at

string<date-time>

required

Timestamp when the subscription was created

currency

enum<string>

required

Currency used for the subscription payments

Verfügbare Optionen:

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

required

Customer details associated with the subscription

Anzeigen untergeordnete attribute

customer.customer_id

string

required

Unique identifier for the customer

customer.email

string

required

Email address of the customer

customer.name

string

required

Full name of the customer

customer.metadata

object

Additional metadata associated with the customer

Anzeigen untergeordnete attribute

customer.metadata.{key}

string

customer.phone_number

string | null

Phone number of the customer

metadata

object

required

Additional custom data associated with the subscription

Anzeigen untergeordnete attribute

metadata.{key}

string

meters

object[]

required

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

Anzeigen untergeordnete attribute

meters.currency

enum<string>

required

Verfügbare Optionen:

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

meters.free_threshold

integer<int64>

required

meters.measurement_unit

string

required

meters.meter_id

string

required

meters.name

string

required

meters.price_per_unit

string

required

Example:

"10.50"

meters.description

string | null

next_billing_date

string<date-time>

required

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

on_demand

boolean

required

Wether the subscription is on-demand or not

payment_frequency_count

integer<int32>

required

Number of payment frequency intervals

payment_frequency_interval

enum<string>

required

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

Verfügbare Optionen:

Day,

Week,

Month,

Year

previous_billing_date

string<date-time>

required

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

product_id

string

required

Identifier of the product associated with this subscription

quantity

integer<int32>

required

Number of units/items included in the subscription

recurring_pre_tax_amount

integer<int32>

required

Amount charged before tax for each recurring payment in smallest currency unit (e.g. cents)

status

enum<string>

required

Current status of the subscription

Verfügbare Optionen:

pending,

active,

on_hold,

cancelled,

failed,

expired

subscription_id

string

required

Unique identifier for the subscription

subscription_period_count

integer<int32>

required

Number of subscription period intervals

subscription_period_interval

enum<string>

required

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

Verfügbare Optionen:

Day,

Week,

Month,

Year

tax_inclusive

boolean

required

Indicates if the recurring_pre_tax_amount is tax inclusive

trial_period_days

integer<int32>

required

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

cancelled_at

string<date-time> | null

Cancelled timestamp if the subscription is cancelled

discount_cycles_remaining

integer<int32> | null

Number of remaining discount cycles if discount is applied

discount_id

string | null

The discount id if discount is applied

expires_at

string<date-time> | null

Timestamp when the subscription will expire

payment_method_id

string | null

Saved payment method id used for recurring charges

tax_id

string | null

Tax identifier provided for this subscription (if applicable)

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

Abonnement Webhook-Ereignisse

Verwendung von `subscription.updated` für Echtzeitsynchronisierung

Webhook-Nutzlastschema

Getting Started

Features

Integrate

Merchant of Record

Miscellaneous

​Abonnement Webhook-Ereignisse

​Verwendung von subscription.updated für Echtzeitsynchronisierung

​Webhook-Nutzlastschema

Abonnement Webhook-Ereignisse

Verwendung von `subscription.updated` für Echtzeitsynchronisierung

Webhook-Nutzlastschema