Sign in
latestOpenAPI 3.0.42026-08-213579001013.0 KB

5f993bd211f5

Billing

Recomputes a billing period's invoiceable amount and voucher coverage, and returns the result.

Idempotent. A period that was closed by an operator is left untouched unless reopen is set, in which case its write-off is revoked and its real remaining amount comes back for review. The response reports skipped with a reason when the period's status puts it beyond settlement — invoiced, void or being reconciled.

post/billing-period/{billingPeriodId}/resettle

Path parameters

billingPeriodIdstring required

The billing period to re-settle.

Request body

reopenboolean

Whether to undo an operator's close before re-settling, bringing the period's remaining amount back for review. Defaults to false, which leaves a closed period alone.

Response

OK

billingPeriodIdstring required

The re-settled billing period.

status'Open' | 'Invoiced' | 'Void' | 'Reconciling' | 'PendingReview' | 'Closed' required
netInvoiceableAmountnumber double nullable

What an invoice for this period would now charge.

voucherCoveragenumber double nullable

How much of the period's billable usage vouchers absorbed.

settledAtstring date-time nullable

When the period was settled by this call.

skippedboolean required

Whether the period was left untouched.

skippedReasonstring nullable

Why the period was left untouched, when it was.