Skip to main content
WEBHOOK

Body

application/json

Credit entered a customer's wallet.

​
amount
integer<int64>
required

In minor units of currency or credit_unit.

​
applicable_product_ids
string[]
required

The products whose charges the grant pays; empty when it pays every product.

​
applies_to
enum<string>
required

What the grant pays: ALL any charge, USAGE only usage charges.

Available options:
ALL,
USAGE
​
credit_grant_id
string<MeteroidId>
required

The grant the credit entered.

Example:

"cgr_7n42DGM5Tflk9n8mt7Fhc7"

​
customer_id
string<MeteroidId>
required
Example:

"cus_7n42DGM5Tflk9n8mt7Fhc7"

​
grant_type
enum<string>
required

PAID or PROMOTIONAL: whether the credit applies after or before tax.

Available options:
PAID,
PROMOTIONAL
​
ledger_entry_id
string<MeteroidId>
required

The credit ledger entry recording the movement.

Example:

"wle_7n42DGM5Tflk9n8mt7Fhc7"

​
source
enum<string>
required

Where the credit came from.

Available options:
MANUAL,
PURCHASE,
PLAN,
CREDIT_NOTE,
ADJUSTMENT,
MIGRATED,
ROLLOVER,
COUPON,
OVERPAYMENT
​
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
​
credit_note_id
string<MeteroidId> | null

The credit note that gave the credit back.

Example:

"crn_7n42DGM5Tflk9n8mt7Fhc7"

​
credit_unit
string | null

The credit unit (its code) the amounts are in; absent for a currency.

​
credit_unit_precision
integer<int32> | null

Decimal places of credit_unit: amounts are integers of 10^-precision credit.

Required range: x >= 0
​
currency
string | null

Absent when the amounts are in a credit unit.

​
invoice_id
string<MeteroidId> | null

The invoice that bought the credit, or whose void gave it back.

Example:

"inv_7n42DGM5Tflk9n8mt7Fhc7"

​
subscription_id
string | null

The subscription the grant belongs to: it pays only that subscription's charges. Null when it pays any of the customer's subscriptions.

Response

200

Webhook received successfully