View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.Webhook for payment status update of an invoice.
application/json
Details of the invoice when the payment status is updated.
TypeScript Definitions
Use the request body type in TypeScript.
linksobject<Link>[]Optionalresource_typeenum<ResourceType>Requiredevent_typeenum<EventType>Requiredresourceobject<InvoiceWithId>Requiredbilling_entity_codestring<BillingEntityCode>Optionalpayment_statusenum<PaymentStatus>Optionalamountobject<AmountWithBreakdown>Optionaltotal_amountobject<Amount>Optionalcurrency_codestring<Currency>Requiredbreakdownobject<AmountBreakdown>Optionalfeesobject<Amount>Optionalcurrency_codestring<Currency>Requiredcredit_notesobject<Amount>Optionalcurrency_codestring<Currency>Requiredsub_total_excluding_taxesobject<Amount>Optionalcurrency_codestring<Currency>Requiredtaxesobject<Amount>Optionalcurrency_codestring<Currency>Requiredsub_total_including_taxesobject<Amount>Optionalcurrency_codestring<Currency>Requiredprepaid_creditobject<Amount>Optionalcurrency_codestring<Currency>Requiredfeesobject<FeeObject>[]Optionaldue_datestring<Date>Optionalissued_datestring<Date>Optionalcustomerobject<CustomerWithId>Optionalemailstring<EmailAddress>Requiredbilling_entity_codestring<BillingEntityCode>Optionaladdressobject<Address>Optionalpayment_method_tokenstring<PaymentMethodToken>Optionalpayment_method_typeenum<PaymentMethodType>Optionaltaxesobject<TaxResponse>[]Optionalcodestring<TaxCode>Optionalmetadataobject<CustomerMetadata>[]Optionalpayment_method_tokenstring<PaymentMethodToken>Optionalpayment_method_typeenum<PaymentMethodType>Optionalsubscription_from_datetimestring<DateTimeWithZone>Optionalsubscription_to_datetimestring<DateTimeWithZone>Optionalcharges_from_datetimestring<DateTimeWithZone>Optionalupdated_atstring<DateTimeWithZone>Optionalapplied_taxesobject<BaseAppliedTax>[]Optionalamountobject<Amount>Optionalcurrency_codestring<Currency>Requiredcreated_atstring<DateTimeWithZone>Optionalfees_amountobject<AmountNoCurrency>OptionalExample Requests
/usage-billing.invoice.payment.succeeded