Skip to main content
WEBHOOK

Body

application/json
​
created_at
string<date-time>
required
​
credit_note_id
string<MeteroidId>
required
Example:

"crn_7n42DGM5Tflk9n8mt7Fhc7"

​
credited_amount_cents
integer<int64>
required
​
currency
string
required
​
custom_properties
object
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"

​
line_items
object[]
required

Credited line items (negated amounts).

​
refunded_amount_cents
integer<int64>
required
​
status
enum<string>
required
Available options:
DRAFT,
FINALIZED,
VOIDED
​
subtotal
integer<int64>
required
​
tax_amount
integer<int64>
required
​
tax_breakdown
object[]
required

Per-rate tax (VAT) breakdown for the credited amount.

​
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.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
​
memo
string | null
​
reason
string | null

Response

200

Webhook received successfully