Discount Plan Allowance Usage
An allowance usage record is the running tally of how much of a discount plan allowance a customer has used in a billing period. These are maintained by the platform during billing, so the API exposes them read-only.
Methods
Section titled “Methods”Retrieve Single Allowance Usage Record
Section titled “Retrieve Single Allowance Usage Record”/backend/api/v1/discountPlanAllowanceUsage/ID - fetch the usage record with the specified ID.
List Allowance Usage Records
Section titled “List Allowance Usage Records”/backend/api/v1/discountPlanAllowanceUsage/ - list all allowance usage records.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include records with a higher ID |
createdSince | datetime | No | Only include records created since the given time |
updatedSince | datetime | No | Only include records updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| invoiceID | Invoice ID | Text | The ID of the invoice this allowance usage is for |
| discountPlanAllowanceID | Discount Plan Allowance ID | Text | The ID of the discount plan allowance this usage record is for |
| usedMinutes | Used Minutes | Number | Number of minutes consumed from the allowance |
| usedBytes | Used Bytes | Number | Number of bytes consumed from the allowance |
| usedEvents | Used Events | Number | Number of events consumed from the allowance |
| usedCalls | Used Calls | Number | Number of calls consumed from the allowance |
| usedValue | Used Discount | Currency | Monetary value of discount consumed from the allowance |
| usedAValue | Used A Leg Discount | Currency | Monetary value of A leg discount consumed from the allowance |
| id | ID | Text | The unique identifier for this allowance usage record |