organization.billing.invoice
Subscribe an endpoint to every event on this page with organization.billing.invoice.*. Each is the envelope every webhook event shares, with the InvoiceEventObject object as its data.object.
An invoice as a webhook event carries it: its identifier, its status and its amounts. The links to the invoice's page and document are never carried: getOrganizationBillingInvoices lists them.
objectstring
One of: organization.billing.invoice
The kind of object this is, always organization.billing.invoice: the family of the event types that carry it, and what tells the members of WebhookEventObject apart.
idstring
Identifier of the invoice, as the payment provider issues it. It is not a UUID.
organization_idstring (uuid)
Identifier of the organization the invoice is addressed to.
statusstring
One of: draft, open, paid, void, uncollectible
The invoice's status once this change was made.
totalinteger (int64)
The invoice's total, in the currency's minor unit.
amount_dueinteger (int64)
What is left to pay, in the currency's minor unit.
currencystring
The invoice's currency, a lowercase ISO 4217 code.
created_atstring (date-time)
When the invoice was raised.
An invoice addressed to the organization was paid.
Triggered by
organization.billing.invoice.record: When the invoice is paid.- The payment provider: The payment provider reports an invoice paid, a payment failed, or a payment waiting for the payer.
Payload
typestring
One of: organization.billing.invoice.paid
Always organization.billing.invoice.paid.
data.objectInvoiceEventObject
The invoice.
Every other field is the envelope every webhook event shares.
A payment of an invoice addressed to the organization failed. The payment provider tries again on its own schedule.
Triggered by
organization.billing.invoice.record: When a payment of it fails.- The payment provider: The payment provider reports an invoice paid, a payment failed, or a payment waiting for the payer.
Payload
typestring
One of: organization.billing.invoice.payment_failed
Always organization.billing.invoice.payment_failed.
data.objectInvoiceEventObject
The invoice.
Every other field is the envelope every webhook event shares.
A payment of an invoice addressed to the organization needs the payer to confirm it, as a card's own authentication asks.
Triggered by
organization.billing.invoice.record: When a payment of it waits for the payer to confirm it.- The payment provider: The payment provider reports an invoice paid, a payment failed, or a payment waiting for the payer.
Payload
typestring
One of: organization.billing.invoice.payment_action_required
Always organization.billing.invoice.payment_action_required.
data.objectInvoiceEventObject
The invoice.
Every other field is the envelope every webhook event shares.