Subscriptionended webhook - Meteroid Documentation

{ "id": "evt_7n42DGM5Tflk9n8mt7Fhc7", "type": "subscription.ended", "subscription_id": "sub_7n42DGM5Tflk9n8mt7Fhc7", "customer_id": "cus_7n42DGM5Tflk9n8mt7Fhc7", "customer_alias": "ACME", "customer_name": "Acme Corporation", "billing_day_anchor": 1, "currency": "EUR", "start_date": "1970-01-01", "plan_name": "default", "version": 0, "created_at": "1970-01-01T00:00:00.000Z", "net_terms": 0, "mrr_cents": 0, "period": "MONTHLY", "status": "PENDING_ACTIVATION", "auto_advance_invoices": true, "charge_automatically": true, "timestamp": "1970-01-01T00:00:00.000Z" }

Body

application/json

auto_advance_invoices

boolean

required

billing_day_anchor

integer<int32>

required

Required range: x >= 0

charge_automatically

boolean

required

created_at

string<date-time>

required

currency

string

required

customer_id

string<MeteroidId>

required

Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

customer_name

string

required

mrr_cents

integer<int64>

required

Required range: x >= 0

net_terms

integer<int32>

required

Required range: x >= 0

period

enum<string>

required

Available options:

MONTHLY,

QUARTERLY,

SEMIANNUAL,

ANNUAL

plan_name

string

required

start_date

string<date>

required

status

enum<string>

required

Available options:

PENDING_ACTIVATION,

PENDING_CHARGE,

TRIAL_ACTIVE,

ACTIVE,

TRIAL_EXPIRED,

PAUSED,

SUSPENDED,

CANCELLED,

ABORTED,

COMPLETED,

SUPERSEDED,

ERRORED

subscription_id

string<MeteroidId>

required

Example:

"sub_7n42DGM5Tflk9n8mt7Fhc7"

version

integer<int32>

required

Required range: x >= 0

string<MeteroidId>

required

Example:

"evt_7n42DGM5Tflk9n8mt7Fhc7"

timestamp

string<date-time>

required

type

enum<string>

required

Available options:

metric.created,

customer.created,

subscription.created,

subscription.updated,

subscription.cancelled,

subscription.ended,

invoice.created,

invoice.finalized,

invoice.paid,

invoice.voided,

invoice.consolidated,

quote.accepted,

quote.converted,

credit_note.created,

credit_note.finalized,

credit_note.voided,

plan.created,

plan.published,

plan.archived,

product.created,

product.updated,

product.archived,

metric.updated,

metric.archived,

coupon.created,

coupon.updated,

coupon.archived,

addon.created,

addon.updated,

addon.archived

activated_at

string<date-time> | null

billing_start_date

string<date> | null

cancellation_reason

string | null

Present on subscription.cancelled when a reason was supplied.

change_type

enum<string> | null

Present on subscription.updated: which mutation fired the event.

Available options:

activated,

trial_ended,

billing_configuration_updated,

plan_changed,

amended,

units_changed,

paused,

cancellation_scheduled

customer_alias

string | null

end_date

string<date> | null

invoice_memo

string | null

invoice_threshold

string | null

purchase_order

string | null

trial_duration

integer<int32> | null

Required range: x >= 0

Response

200

Webhook received successfully