You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 19
Next »
Name | Type | Description |
|---|
| code | String | The code of the retrieved price plan rate |
| rate_model | String | The rate model of the retrieved price plan rate. Available values are: - FLATRATEQUANTITYBASED
- TIEREDRATEQUANTITYBASED
- FLATRATEMATURITYBASED
- TIEREDRATEMATURITYBASED
- FLATRATEDURATIONBASED
- TIEREDRATEDURATIONBASED
- FLATRATEQUANTITYANDMATURITYBASED
- TIEREDRATEQUANTITYANDMATURITYBASED
- FLATRATE
|
| base_amount | Number | The base rate that is applied if not tiered rates are applied |
| effective_starting_from | Sting | The date option that determines when a recurring charges will become active. Applicable only for termed services. The applicable values are: BINDINGSTARTDATE, SERVICEEFFECTIVEDATE, AGREEMENTDATE and LATESTRATEDUPTODATE |
| uot | Sting | The unit of time that can be used to measure time. This is mandatory information only for termed services.The applicable values are: - SECONDS
- MINUTES
- HOUR
- DAY
- WEEK
- MONTH
- YEAR
|
| time_period | Time Period Object | The period and unit of time used to calculate the rates for termed services. This is applicable only on termed services rates. Only days, weeks, months and years are applicable for termed services rates. |
| price_plan | Price Plan Object | The base price plan related with the retrieved price plan. This information is available only if the retrieved price plan is a conditional price plan |
| product | Product Object | The physical good or service whose price plan rate is returned as a result. |
| product_bundle | Product Object | The product bundle related with the selected product whose price plan rate is returned as a result.. This information is applicable only if the specified product is used as a product component belonging to a product having a type classified as flexible bundle product. |
| tiered_rates_set | Set of Tiered Rates Objects | A list of tiered rates related to the specified product. This information is applicable only for tiered price plan rate models. |
| termed_services_tiered_rates_set | Set of Termed Services Tiered Rates Objects | A list of tiered rates related to the specified termed service. This information is applicable only for tiered price plan rate models defined for termed services |
| additional_price_plan_rates | Set of Additional Price Plan Rates Objects | A list of base rates in various currencies for the same product within the specified price plan. |
| additional_price_plan_tiered_rates | Set of Additional Price Plan Tiered Rates Objects | A list of tiered rates in various currencies for the same product within the specified price plan.
|
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 |
price_plan object data response
| Name | Type | Description |
|---|
| Id | String | The ID of the retrieved price plan |
| name | String | The Name of the retrieved price plan |
| code | String | The Code of the retrieved price plan |
| description | String | The Description of the retrieved price plan |
| type | String | The Type of the retrieved price plan which can be BASE or CONDITIONAL |
| effective_date | Date | The Effective Date of the retrieved price plan |
| expiration_date | Date | The Expiration Date of the retrieved price plan |
| currency | Currency Object | The Currency of the retrieved price plan |
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 |
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 |
tiered rates object response data
| | |
|---|
| tier_level | String | The level of the tiered rate |
| tier_rate_from | Number | The tiered rate's number from which the tiered amount is applicable (inclusive) |
| tier_rate_to | Number | The tiered rate's number until which the tiered amount is applicable (inclusive). This information is optional. |
| tier_rate_to_option | String | The option that defines how the tier rate's to will be used. The available options are SPECIFIC_NUMBER, UNLIMITED and BINDING_END_DATE. If the SPECIFIC_NUMBER option is set, then the tier rate to value is also returned. |
| tiered_amount | Number | The tiered rate amount |
termed services tiered rates object response data
| | |
|---|
| level | String | The level of the tiered rate |
| from_maturity_period | Number | The beginning of the maturity period, inclusive, that will provide the specified rate |
| to_maturity_period | Number | The end of the maturity period (inclusive) that will provide the specified rate |
| from_quantity | Number | The minimum quantity (number of times that the service is distributed), inclusive, that will provide the specified rate |
| to_quantity | Number | The maximum quantity (number of times that the service is distributed), inclusive, that will provide the specified rate |
| amount | Number | The tiered rate amount provided if the maturity period and the quantity (number of times that the service is distributed) are within the ranges specified above |
additional currency rates object response data
| | |
|---|
| base_amount | Number | The base amount of the additional currency |
| currency | Currency Object | The Currency in which the base amount is specified |
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 |
additional currency rates object response data
| | |
|---|
| tiered_amount | Number | The tiered amount of the additional currency |
| currency | Currency Object | The Currency in which the tiered amount is specified |
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 |