Sign in
Billing
billing

Create One Off Charge

Changed on

Charge a customer a one-off amount against one of their contract's service periods.

For charges outside the contract schedule, e.g. a mid-term price increase applied retroactively to an already-billed period. Creates a single-item live billing run and charges the customer's default payment method right away. The charge gets its own entry in the customer's Billing History and its own receipt (emailed on completion like any other payment), and never stops the regular bill for that period from going out. Developer only.

post/billing/developer/one-off-charges/{customer_id}

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/billing/developer/one-off-charges/{customer_id}
  • Auth: none declared

Path parameters

customer_idstring uuid required

Request body

billing_contract_idstring uuid required
period_startstring date required

Start date of the contract service period the charge applies to (e.g. 2026-08-31)

amount_centsinteger required
descriptionstring required

Response

Successful Response

billing_run_item_idstring uuid required
billing_run_idstring uuid required
customer_idstring uuid required
customer_namestring nullable
billing_contract_idstring uuid required
statusstring required
period_startstring date-time required
period_endstring date-time required
billing_datestring date-time required
gross_amount_centsinteger required
gross_amount_displaystring required
adjustment_amount_centsinteger required
adjustment_amount_displaystring required
amount_centsinteger required
amount_displaystring required
call_countinteger nullable
one_off_descriptionstring nullable
moov_transfer_idstring nullable
moov_transfer_statusstring nullable
payment_confirmed_atstring date-time nullable
error_messagestring nullable
created_atstring date-time required

Changes