Billing

Closes a billing period, writing off whatever it would still have invoiced.

Changed on

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

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/billing-period/{billingPeriodId}/close
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

billingPeriodIdstring required

The billing period to close.

Request body

reasonstring required

Why the remaining amount will never be invoiced.

Response

OK

billingPeriodIdstring required

The closed billing period.

writtenOffAmountnumber double required

The amount that was written off.

writeOffVoucherIdstring nullable

The voucher that absorbed the written-off amount, or null when there was nothing left.

Changes