Billing
billing

Start Billing Run

Start a new billing run. Creates a BillingRun record and dispatches a Celery task.

Developer only.

post/billing/developer/runs

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/runs
  • Auth: none declared

Request body

is_dry_runboolean

If true, compute billable periods but do not execute transfers

Response

Successful Response

billing_run_idstring uuid required
statusstring required
is_dry_runboolean required
initiated_bystring uuid nullable
total_customersinteger required
total_itemsinteger required
successful_itemsinteger required
failed_itemsinteger required
skipped_itemsinteger required
total_amount_centsinteger required
total_amount_displaystring required
error_messagestring nullable
celery_task_idstring nullable
started_atstring date-time nullable
completed_atstring date-time nullable
created_atstring date-time required

Changes

No recorded changes to this operation across all 57 revisions of this API.