Billing Runs
A billing run produces invoices for your customers on a chosen date. It controls which call charges are included up to the call cutoff date, optionally which non-call charges up to a separate transaction cutoff date, the invoice date, and the payment due date. See the Billing Run guide for the full workflow.
Methods
Section titled “Methods”Retrieve Single Billing Run
Section titled “Retrieve Single Billing Run”/backend/api/v1/billingRuns/ID - fetch the billing run with the specified ID.
List Billing Runs
Section titled “List Billing Runs”/backend/api/v1/billingRuns/ - list all billing runs.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include runs with a higher ID |
createdSince | datetime | No | Only include runs created since the given time |
updatedSince | datetime | No | Only include runs updated since the given time |
/backend/api/v1/billingRuns/ - create a new billing run. The newly-added run will be returned.
/backend/api/v1/billingRuns/ID - update the billing run with the specified ID. The modified run will be returned.
The date fields lock once bills are requested for a run, so they can only be changed while the run is still pending.
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| name | Name | Text | Descriptive name for this billing run |
| status | Status | Preset Value | Status name of the billing run |
| subrun | Billing Subrun | Preset Value | Subrun identifier for this billing run in multirun environments |
| invoiceMessage | Invoice Message | Preset Value | Invoice message name for this billing run |
| invoiceAmount | Invoice Amount | Currency | Total amount of all invoices in this billing run |
| invoiceDate | Invoice Date | Date | Date to appear on invoices generated in this billing run |
| cutoffDate | Cutoff Date | Date | Call cutoff date for including call charges in this billing run |
| transactionCutoffDate | Transaction Cutoff Date | Date | Optional non-call cutoff date for including charges by transaction date in this billing run |
| dueDate | Due Date | Date | Payment due date for invoices in this billing run |
| id | Billing Run ID | Text | The unique identifier for this billing run |
| commencedDate | Commenced Date | Date | Date and time when this billing run was commenced |
| completedDate | Completed Date | Date | Date and time when this billing run was completed |