usage_subscription_service_short
George Rossides (Unlicensed)
p_demou (Deactivated)
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved usage subscription service |
life_cycle_state | String | The life cycle state of the usage subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED |
udf_string_1 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_2 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_3 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_4 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_5 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_6 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_7 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_string_8 | String | User Defined Field of type String Available from CRM.COM R14.3.0 |
udf_float_1 | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 |
udf_float_2 | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 |
udf_float_3 | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 |
udf_float_4 | Float | User Defined Field of type Float Available from CRM.COM R14.3.0 |
udf_date_1 | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 |
udf_date_2 | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 |
udf_date_3 | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 |
udf_date_4 | Date | User Defined Field of type Date Available from CRM.COM R14.3.0 |
| product | Product object | The product classified as usage service which is related with the retrieved usage subscription service |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
| 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 Available from CRM.COM R12.3.0 |
| global_rate | Global Rate Object | The global rate of the retrieved product Available from CRM.COM R15.0.0 |
| product_type | Product type object | The type of the product |
Referred Objects Response Data
| 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 Available from CRM.COM R14.0.0 |
Referred Objects Response Data
| 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
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 |
| 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
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 |
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:
From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED |
| 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
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
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 |