latestOpenAPI 3.0.42026-08-213579001013.0 KB
5f993bd211f5
Billing
Closes a billing period, writing off whatever it would still have invoiced.
The remaining amount is covered by a write-off voucher carrying the caller and the reason, so the period ends up closed and fully covered; nothing is sent to the payment provider. Answers 409 Conflict for a period that has already been invoiced, is being reconciled, or was already closed this way. The close is sticky: later changes to the period's billing inputs no longer bring it back for review, and undoing it means calling POST /billing-period/{billingPeriodId}/resettle with reopen set.
post/billing-period/{billingPeriodId}/close
Path parameters
billingPeriodIdstring required
The billing period to close.
Request body
Response
OK