Skip to main content
WEBHOOK

Body

application/json
​
created_at
string<date-time>
required
​
currency
string
required
​
custom_properties
any
required

User-defined custom property values, keyed by definition key.

​
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

​
invoice_id
string<MeteroidId>
required
Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

​
settled_by_credit_notes
boolean
required

On invoice.paid: true when finalized credit notes, not a payment, settled the invoice's whole total. Nothing was collected, so it books no cash. False on every other event.

​
status
enum<string>
required
Available options:
DRAFT,
FINALIZED,
UNCOLLECTIBLE,
VOID,
CLOSED
​
tax_amount
integer<int64>
required
​
total
integer<int64>
required
​
id
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.closed,
invoice.consolidated,
invoice.deleted,
invoice.accounting_pdf_generated,
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,
refund.issued,
refund.settled,
refund.failed,
payment.reversed,
payment.reinstated,
payment.failed,
wallet.funded,
wallet.debited,
wallet.balance_low,
wallet.credit_unrecovered,
wallet.credit_recovered,
wallet.auto_top_up_failed,
wallet.auto_top_up_suspended,
wallet.auto_top_up_consent_changed,
wallet.depleted,
wallet.recovered,
wallet.auto_top_up_cap_reached,
credit_grant.expired,
entitlement.usage_threshold_reached,
entitlement.limit_reached,
budget.threshold_reached,
budget.exceeded,
entitlement.too_many_groups
​
consolidated_into_invoice_id
string<MeteroidId> | null

Set on invoice.consolidated: the parent invoice this one was merged into.

Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

​
invoice_number
string | null

Absent while the invoice is a draft — the number is assigned at finalization.

​
parent_invoice_id
string<MeteroidId> | null

Set on a corrective invoice: the cancelled invoice this one replaces ("cancels and replaces"). The original is credited in full by a credit note.

Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

Response

200

Webhook received successfully