{
"type": "invoice.finalized",
"data": {
"object": "invoice.finalized",
"id": "inv_2b3c4d5e6f7g8h",
"customer_id": "acme_corp",
"entity_id": null,
"plan_ids": [
"enterprise"
],
"stripe_id": "in_1A2B3C4D5E6F7G8H",
"processor_type": "stripe",
"status": "open",
"total": 4505,
"amount_paid": null,
"refunded_amount": 0,
"currency": "usd",
"created_at": 1788220800000,
"hosted_invoice_url": "https://api.useautumn.com/invoices/hosted_invoice_url/inv_2b3c4d5e6f7g8h",
"items": [
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Enterprise plan",
"plan_id": "enterprise",
"feature_id": null,
"feature_name": null,
"quantity": null,
"amount": 2400,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": []
},
{
"id": "invoice_li_3c4d5e6f7g8h9i",
"description": "AI credits",
"plan_id": "enterprise",
"feature_id": "ai_credits",
"feature_name": "AI Credits",
"quantity": 842000,
"amount": 1684,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": [
{
"entity_id": "acme-docs-prod",
"quantity": 842000,
"amount": 1684
}
]
}
]
}
}Invoice
Invoice Finalized
Fired when a Stripe invoice is finalized and its line items have been reconciled. The body is the invoice as returned by invoices.list, with items populated and each item carrying a per-entity entities breakdown.
WEBHOOK
invoice.finalized
{
"type": "invoice.finalized",
"data": {
"object": "invoice.finalized",
"id": "inv_2b3c4d5e6f7g8h",
"customer_id": "acme_corp",
"entity_id": null,
"plan_ids": [
"enterprise"
],
"stripe_id": "in_1A2B3C4D5E6F7G8H",
"processor_type": "stripe",
"status": "open",
"total": 4505,
"amount_paid": null,
"refunded_amount": 0,
"currency": "usd",
"created_at": 1788220800000,
"hosted_invoice_url": "https://api.useautumn.com/invoices/hosted_invoice_url/inv_2b3c4d5e6f7g8h",
"items": [
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Enterprise plan",
"plan_id": "enterprise",
"feature_id": null,
"feature_name": null,
"quantity": null,
"amount": 2400,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": []
},
{
"id": "invoice_li_3c4d5e6f7g8h9i",
"description": "AI credits",
"plan_id": "enterprise",
"feature_id": "ai_credits",
"feature_name": "AI Credits",
"quantity": 842000,
"amount": 1684,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": [
{
"entity_id": "acme-docs-prod",
"quantity": 842000,
"amount": 1684
}
]
}
]
}
}Payload Fields
string
required
The Autumn invoice ID
string[]
required
Array of plan IDs included in this invoice
string
required
The Stripe invoice ID
'stripe' | 'revenuecat'
required
The billing processor that owns this invoice.
string
required
The status of the invoice
number
required
The total amount of the invoice
number | null
required
The amount paid on the invoice, in major currency units. Null on invoices recorded before amounts paid were tracked.
number
required
The total amount refunded on the invoice, in major currency units
string
required
The currency code for the invoice
number
required
Timestamp when the invoice was created
string | null
URL to the Stripe-hosted invoice page
string | null
required
The ID of the customer this invoice belongs to. Null for customers created without an ID.
string | null
required
The ID of the entity this invoice belongs to, if entity-scoped
object[]
Line items on the invoice, one per line as shown in Stripe. Capped at 100. Empty for invoices recorded before line item storage.
Show properties
Show properties
string
required
The Autumn invoice line item ID. Stable across reads, and can be used to reference this line in later calls.
string
required
Description of the invoice line item
number | null
required
Timestamp when the billing period starts
number | null
required
Timestamp when the billing period ends
string | null
required
The plan this line item came from. Null for lines with no Autumn plan behind them.
string | null
required
The ID of the feature associated with this line item
string | null
required
The name of the feature associated with this line item
number | null
required
Quantity actually charged on this line. Null on fixed-price lines.
number
required
Amount charged on this line, pre-discount and pre-tax. Negative for credits.
object[]
required
How this line splits by entity. Empty for customer-level lines. Only populated for invoices finalized after entity attribution shipped.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
The webhook event type.
Allowed value:
"invoice.finalized"Show child attributes
Show child attributes
Example:
{
"object": "invoice.finalized",
"id": "inv_2b3c4d5e6f7g8h",
"customer_id": "acme_corp",
"entity_id": null,
"plan_ids": ["enterprise"],
"stripe_id": "in_1A2B3C4D5E6F7G8H",
"processor_type": "stripe",
"status": "open",
"total": 4505,
"amount_paid": null,
"refunded_amount": 0,
"currency": "usd",
"created_at": 1788220800000,
"hosted_invoice_url": "https://api.useautumn.com/invoices/hosted_invoice_url/inv_2b3c4d5e6f7g8h",
"items": [
{
"id": "invoice_li_2b3c4d5e6f7g8h",
"description": "Enterprise plan",
"plan_id": "enterprise",
"feature_id": null,
"feature_name": null,
"quantity": null,
"amount": 2400,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": []
},
{
"id": "invoice_li_3c4d5e6f7g8h9i",
"description": "AI credits",
"plan_id": "enterprise",
"feature_id": "ai_credits",
"feature_name": "AI Credits",
"quantity": 842000,
"amount": 1684,
"period_start": 1785542400000,
"period_end": 1788220800000,
"entities": [
{
"entity_id": "acme-docs-prod",
"quantity": 842000,
"amount": 1684
}
]
}
]
}
Response
200
Webhook received successfully.