Skip to content

Discount Plans

A discount plan is the template for a customer discount or allowance, such as 500 inclusive UK minutes a month or 20% off international calls. See the Discount Plans guide for how plans work, and Tariff and Discount Detail Records for the allowance buckets they create.

/backend/api/v1/discountPlans/ID - fetch the discount plan with the specified ID.

/backend/api/v1/discountPlans/ - list all discount plans.

ParameterTypeRequiredDescription
idAfterintegerNoOnly include discount plans with a higher ID
createdSincedatetimeNoOnly include discount plans created since the given time
updatedSincedatetimeNoOnly include discount plans updated since the given time

/backend/api/v1/discountPlans/ - add a new discount plan. The newly-added discount plan will be returned.

/backend/api/v1/discountPlans/ID - update the discount plan with the specified ID. The modified discount plan will be returned.

/backend/api/v1/discountPlans/ID - delete the discount plan with the specified ID.

FieldNameTypeDescription
discountPlanNameDiscount Plan NameTextName of the discount plan as it appears throughout the system
discountPlanShortNameDiscount Plan Name (Short)TextAbbreviated name for display in reports and summaries
discountPlanDescriptionDiscount Plan DescriptionTextDetailed description of what this discount plan provides
discountPercentDiscount PercentNumberPercentage discount to apply to qualifying calls
discountPencePerCallDiscount Per CallNumberFixed discount amount per qualifying call
discountPencePerMinuteDiscount Per MinuteNumberFixed discount amount per minute of qualifying calls
availabilityDiscount Plan AvailabilityPreset ValueControls who can see and use this discount plan
currencyCurrencyPreset ValueCurrency this discount plan is denominated in
customerIDCustomerTextThe ID of the customer this discount plan is for
customerGroupsCustomer GroupsTextCustomer groups that can use this discount plan
allowanceMinutesDiscounted MinutesNumberNumber of minutes to discount or include in allowance pool
allowanceBytesDiscounted Data (Bytes)NumberNumber of bytes to discount or include in allowance pool
allowanceEventsDiscounted EventsNumberNumber of events to discount or include in allowance pool
allowanceCallsDiscounted CallsNumberNumber of calls to discount or include in allowance pool
allowanceValueCash DiscountNumberMonetary amount to discount or include in allowance pool
nominalValueNominal ValueNumberNominal value of the discount plan for reporting purposes
customerWideCustomer-WidePreset ValueWhether allowances are shared across all customer numbers
useAllowancePoolFill / Use Allowance PoolPreset ValueWhether this discount plan uses shared allowance pools
allowancePoolAttachedNumberAllowance Pool Used By Attached NumberPreset ValueWhether the allowance pool is used by the number this feature is attached to
allowancePoolAllNumbersAllowance Pool Used By All NumbersPreset ValueWhether the allowance pool is used by all customer numbers
allowancePoolNumberTypesAllowance Pool Used By Number TypesPreset Value(s)Number types that can use this allowance pool
discountALegDiscount Matching A LegPreset ValueWhether to discount the A leg of matching calls
callPartialDiscountActionPart-Free CallPreset ValueHow to handle calls that are partially covered by allowances
roundSecondsRound Used Duration Up To NextNumberRound call duration up to the next specified number of seconds
roundBytesRound Used Bytes Up To NextNumberRound data usage up to the next specified number of bytes
roundEventsRound Used Events Up To NextNumberRound event usage up to the next specified number of events
roundPenceRound Used Cost Up To NextTextRound cost up to the next specified amount in pence
applyToAllCallTypesAll Call TypesPreset ValueWhether this discount applies to all call types
applyToTariffGroupUse Discount Plan on TariffPreset ValueWhether to apply this discount plan to tariff calculations
daytimeCallTypeGroupsStandard Call Type Groups (Daytime)Preset Value(s)Array of call type group IDs for daytime discounts
eveningCallTypeGroupsStandard Call Type Groups (Evening)Preset Value(s)Array of call type group IDs for evening discounts
weekendCallTypeGroupsStandard Call Type Groups (Weekend)Preset Value(s)Array of call type group IDs for weekend discounts
daytimeCallTypeCustomGroupsCustom Call Type Groups (Daytime)Preset Value(s)Array of custom call type group IDs for daytime discounts
eveningCallTypeCustomGroupsCustom Call Type Groups (Evening)Preset Value(s)Array of custom call type group IDs for evening discounts
weekendCallTypeCustomGroupsCustom Call Type Groups (Weekend)Preset Value(s)Array of custom call type group IDs for weekend discounts
daytimeCallTypesCall Types (Daytime)Preset Value(s)Array of call type IDs for daytime discounts
eveningCallTypesCall Types (Evening)Preset Value(s)Array of call type IDs for evening discounts
weekendCallTypesCall Types (Weekend)Preset Value(s)Array of call type IDs for weekend discounts
applyToCallCarriersCall CarriersPreset Value(s)Carriers this discount applies to
useCallTypeWeightsUse Call Type WeightsPreset ValueWhether to use call type weights in discount calculations
applyToCallCostsCall CostsPreset ValueCall cost ranges this discount applies to
discountAccessChargeCalls With Access ChargePreset ValueHow to handle calls with access charges
weightAccessChargeAccess Charge WeightNumberWeight percentage for access charge discounting
discountOriginationSurchargeCalls With Origination SurchargePreset ValueHow to handle calls with origination surcharges
weightOriginationSurchargeOrigination Surcharge WeightNumberWeight percentage for origination surcharge discounting
discountRecordingSurchargeCalls With Recording SurchargePreset ValueHow to handle calls with recording surcharges
weightRecordingSurchargeRecording Surcharge WeightNumberWeight percentage for recording surcharge discounting
applyToDurationMinMinimum Call DurationNumberMinimum call duration for discount to apply
applyToDurationMaxMaximum Call DurationNumberMaximum call duration for discount to apply
idDiscount Plan IDTextThe unique identifier for this discount plan