Discount Plan Allowances
A discount plan allowance is a bucket of inclusive minutes, data or credit a customer receives from a discount plan. The platform creates and tracks these per customer per period, so the API exposes them for reading. See Tariff and Discount Detail Records for the field reference.
Methods
Section titled “Methods”Retrieve Single Discount Plan Allowance
Section titled “Retrieve Single Discount Plan Allowance”/backend/api/v1/discountPlanAllowances/ID - fetch the allowance with the specified ID.
List Discount Plan Allowances
Section titled “List Discount Plan Allowances”/backend/api/v1/discountPlanAllowances/ - list all discount plan allowances.
Additional Query Parameters
Section titled “Additional Query Parameters”| Parameter | Type | Required | Description |
|---|---|---|---|
idAfter | integer | No | Only include allowances with a higher ID |
createdSince | datetime | No | Only include allowances created since the given time |
updatedSince | datetime | No | Only include allowances updated since the given time |
Fields
Section titled “Fields”| Field | Name | Type | Description |
|---|---|---|---|
| startDate | Start Date | Date | Date when this discount plan allowance becomes active |
| endDate | End Date | Date | Date when this discount plan allowance expires |
| discountPlanAllowancePoolName | Allowance Pool Name | Text | Named pool identifier for grouping related allowances |
| discountPlan | Discount Plan | Preset Value | The discount plan this allowance is associated with |
| allowanceMinutes | Free Minutes | Number | Number of free minutes included in this allowance |
| allowanceBytes | Discounted Data (Bytes) | Number | Number of bytes of data included in this allowance |
| allowanceEvents | Discounted Events | Number | Number of events included in this allowance |
| allowanceCalls | Free Calls | Number | Number of free calls included in this allowance |
| allowanceValue | Cash Discount | Currency | Cash discount amount included in this allowance |
| nominalValue | Nominal Value | Currency | Nominal value of this allowance for accounting purposes |
| usedMinutes | Used Minutes | Number | Number of minutes consumed from this allowance |
| usedCalls | Used Calls | Number | Number of calls consumed from this allowance |
| usedValue | Used Discount | Currency | Cash discount amount consumed from this allowance |
| usedAValue | Used A Leg Discount | Currency | A-leg discount amount consumed from this allowance |
| allowanceConsumedStamp | Allowance Consumed | Date | Timestamp when this allowance was fully consumed |
| id | Discount Plan Allowance ID | Text | |
| transactionID | Transaction | Text | The ID of the transaction this discount plan allowance is for |