Get started
Webhooks

organization.billing.invoice

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.

Event typeWhat happened
organization.billing.invoice.paidAn invoice was paid.
organization.billing.invoice.payment_failedAn invoice's payment failed.
organization.billing.invoice.payment_action_requiredAn invoice's payment needs the payer's action.

The InvoiceEventObject 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.

object

string

required

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.

id

string

required

Identifier of the invoice, as the payment provider issues it. It is not a UUID.

organization_id

string (uuid)

required

Identifier of the organization the invoice is addressed to.

status

string

required

One of: draft, open, paid, void, uncollectible

The invoice's status once this change was made.

total

integer (int64)

required

The invoice's total, in the currency's minor unit.

amount_due

integer (int64)

required

What is left to pay, in the currency's minor unit.

currency

string

required

The invoice's currency, a lowercase ISO 4217 code.

created_at

string (date-time)

required

When the invoice was raised.

organization.billing.invoice.paid

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

type

string

required

One of: organization.billing.invoice.paid

Always organization.billing.invoice.paid.

data.object

InvoiceEventObject

required

Every other field is the envelope every webhook event shares.

organization.billing.invoice.payment_failed

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

type

string

required

One of: organization.billing.invoice.payment_failed

Always organization.billing.invoice.payment_failed.

data.object

InvoiceEventObject

required

Every other field is the envelope every webhook event shares.

organization.billing.invoice.payment_action_required

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

type

string

required

One of: organization.billing.invoice.payment_action_required

Always organization.billing.invoice.payment_action_required.

data.object

InvoiceEventObject

required

Every other field is the envelope every webhook event shares.