Name | Type | Description |
|---|
| discount_option | String | The type of discount which will be applied, which can be one of the following - AMOUNT
- AMOUNT_PER_PERIOD
- PERCENTAGE
- PERCENTAGE_PER_PERIOD
- FREE_USAGE
|
| discount_amount | Number | The discount amount that will be applied, if the additive discount definition is set up to provide a range of discount based on amount. |
| discount_percentage | Number | The discount percentage that will be applied, if the additive discount definition is set up to provide a range of discount based on percentage |
| discount_free_usage | Number | The free usage discount that will be applied, if the additive discount definition is set up to provide a range of discount based on usage. The UOM depends on the UOM of the usage service being discounted |
| for | For Object | The discounted period every time the discount is given when the Discount Option is Percentage per Period or Amount per Period. The possible options are the following: |
| renew | Renew Object | How often the discount is renewed (provided again) when the Discount Option is Percentage per Period or Amount per Period which can have one of the following options: - Never
- Every_x_UOT
- Every_Billing_Cycle
|
| from_date | Date | The date that the auto apply additive discount will be applicable from |
| to_date | Date | The date that the auto apply additive discount will be applicable to |
| currency | Currency Object | The currency in which the discount amount is returned |
| additive_discount_definition | Additive Discount Definition Object | The auto apply additive discount definition that will be applied |
| product | Product Object | The product that will be discounted by the specified auto apply additive discount definition |
Referred Objects Response Data
currency object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved currency |
| code | String | The code of the retrieved currency |
| prefix_symbol | String | The prefix symbol for the specified currency |
suffix_symbol | String | The suffix symbol for the specified currency |
| life_cycle_state | String | The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE |
| integer_part_name | String | The integer part name for the specified currency |
| decimal_part_name | String | The decimal part name for the specified currency |
additive_discount_definition object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved additive discount definition |
| alternative_code | String | The alternative code of the retrieved additive discount definition |
| name | String | The name of the retrieved additive discount definition |
| life_cycle_state | String | The life cycle state of the retrieved additive discount definition. The supported life cycle states are EFFECTIVE or NOT_EFFECTIVE |
| classification | String | The classification of the retrieved additive discount definition which can be either SUBSCRIPTIONS, JOBS or GENERAL |
| type | String | The type of the additive discount definition which can be AUTO_APPLY or AD_HOC |
product object response data
| | |
|---|
| Id | String | The ID of the product |
| code | String | The code of product |
alternative_code | String | The alternative code of product |
description | String | The description of product |
| priority_level | Integer | The priority level of the product |
| global_rate | Global Rate Object | The global rate of the retrieved product |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
product_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved product type |
| name | String | The Name of the retrieved product type |
| alternative_code | String | The Alternative Code of the retrieved product type |
| description | String | The Description of the retrieved product type |
| classification | String | The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS |
| service_type | String | The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE |
| physical_good_type | String | The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE |
| composition_method | String | The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE |
| used_for_provisioning | Boolean | The flag shows if the retrieved product type is used for provisioning |
| udr_type | Usage Detail Record Type | The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE |
| meter_reading_type | Meter Reading Type | The Meter Reading type related with the product type. This is applicable only for traceable physical goods |
Referred Objects Response Data
usage_detail_record_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved usage detail record type |
| name | String | The Name of the retrieved usage detail record type |
| alternative_code | String | The Alternative Code of the retrieved usage detail record type |
| description | String | The Description of the retrieved usage detail record type |
| unit_of_measurement | String | The Unit of measurement of the retrieved usage detail record type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
meter_reading_type object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved meter reading type |
| name | String | The Name of the retrieved meter reading type |
| alternative_code | String | The Alternative Code of the retrieved meter reading type |
| classification | String | The Classification of the retrieved meter reading type |
| description | String | The Description of the retrieved meter reading type |
| unit_of_measurement | String | The Unit of measurement of the retrieved meter reading type |
Referred Objects Response Data
unit_of_measurement object response data
Name | Type | Description |
| id | String | The identifier of the Unit of measurement |
name | String | The name of the Unit of measurement |
description | String | The description of the Unit of measurement |
| alternative_code | String | The alternative code of the Unit of measurement |
global rate object response data
Name | Type | Description |
|---|
id | String | The ID of the retrieved rate |
| rate_model | String | The price plan rate model which can be one of the following: - QUANTITYBASED
- QUANTITYANDPERIODBASED
- BILLABLEPERIODBASED
- DURATIONBASED
- FLATFEEBASED
- USAGEBASED
|
| global_base_amount | Number | The base price of the product in the Global Price Plan |
| base_rate_applied_per | String | The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between |
| uot | String | The 'UOT' applicable for the rate
- Seconds
- Minute
- Hour
- Day
- Week
- Month
- Year
Available for one-time services |
| time_period | Time Period Object | The period and unit of time for which the base amount is applicable for. This is available only on termed services rates. |
| uom | String | The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification |
Referred Objects Response Data
period object response data
Name | Type | Description |
|---|
| time_period_value | Number | The time period value |
time_period_uot | String | The time period unit of time. The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS |
additive dicsount for object response data
Name | Type | Description |
|---|
| for_option | String | The period for which the discount is for: - For_X_UOT
- 1_BILLING_PERIOD
|
| for_value | Number | The for period value when the for_option is set to 'For X UOT' |
for_uot | String | The For unit of time when the for_option is set to 'For X UOT'. The supported values are the following: DAYS, WEEKS, MONTHS, YEARS |
additive discount renew object response data
Name | Type | Description |
|---|
| renew_option | String | How often the discount is renewed (provided again) which can have one of the following options: - Never
- Every_x_UOT
- Every_Billing_Cycle
|
| renew_value | Number | The renew every 'x' value when the renew option is set to Every X UOT |
renew_uot | String | The renew period unit of time when the renew option is set to Every X UOT. The supported values are the following: DAYS, WEEKS, MONTHS, YEARS |