Skip to navigation
API ReferencePlans and billingInvoices

Finalize an invoice now

Invoices finalize on their own at finalizes_at (period end plus the plan’s grace period). Call this to finalize a draft early. A finalized invoice never changes: charges confirmed later, and events dated inside a closed period, go on the next invoice.

Authentication

AuthorizationBearer

A secret key (rl_sk_test_..., rl_sk_live_...) or a restricted key with limited scopes (rl_rk_test_..., rl_rk_live_...). A restricted key can carry agent: true and an expires_at, and is what a coding agent should hold. Keys end in a checksum so secret scanners can recognize them. People create, roll and revoke keys in the dashboard; GET /v1/api_keys lists them, masked.

Path parameters

invoice_idstringRequired

The invoice ID (inv_...).

Response

The finalized invoice.
idstring
object"invoice"
customerstring
subscriptionstring
statusenum

draft fills during the period. open is finalized and awaiting payment. paid is settled at the provider.

Allowed values:
currencystring
period_startdatetime
period_enddatetime
lineslist of objects
totalinteger
Sum of the lines, in minor units, never below zero. If credits exceed charges, the rest carries to the next invoice.
amount_dueinteger
amount_paidinteger
finalizes_atdatetime
collection_methodenum

charge_automatically charges the saved payment method. send_invoice emails a payment link from the provider.

Allowed values:
payment_statusenum
Allowed values:
livemodeboolean
created_atdatetime
numberstringOptional
Assigned at finalization.
finalized_atdatetimeOptional
due_atdatetimeOptional
paid_atdatetimeOptional
hosted_payment_urlstringOptionalformat: "uri"
The provider's payment page, once finalized.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error