- Created by George Rossides, last modified on Apr 20, 2017
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 8 Next »
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved termed subscription service |
| provisioning_distributor_labels | String | The label of the provisioning distributor for that specific subscription Available from CRM.COM R10.0.0 |
| subscription_service | Termed subscription service object | The termed subscription service |
| provisioning_distributor | Provisioning distributor object | The provisioning distributor |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved termed subscription service |
life_cycle_state | String | The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0 |
| mandatory | Boolean | Defines whether the retrieved termed service was added on the subscription as a mandatory or an additional one. Available from CRM.COM R15.0.0 |
| first_activated_date | Date | The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0 |
| rating_state | String | The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
| rated_up_to | Date | The date up until which the termed service was rated. Available from CRM.COM R9.0.0 |
| free | Boolean | Indicates whether the retrieved service is classified as Free or a Paid one. If true then the service is a free service Available from CRM.COM R14.2.0 |
| trial_end_date | Date | Defines the end of the service's trial period, if any Available from CRM.COM R14.17.0 |
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 |
| period_billed_in_advance | Period Billed in Advance Object | Defines the period that the specified service will be billed in advance. Applicable only for prepaid pre-rated services Available from CRM.COM R14.0.0 |
| product | Product object | The product classified as termed service which is related with the retrieved termed subscription service |
| service_bundle | Subscription Service Bundle Object | The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle. |
Referred Objects Response Data
Name | Type | Description |
|---|---|---|
period_billed_in_advance | Integer | Defines the period for which the the service will be pre-rated. Applicable only for prepaid services of PRERATE billing type |
period_billed_in_advance_uot | String | The unit of time that measures the specified period billed in advance for the service. The supported values are DAYS, WEEKS or MONTHS. Applicable only for prepaid services of PRERATE billing type |
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 |
Name | Type | Description |
|---|---|---|
id | String | The ID of the retrieved termed subscription service |
life_cycle_state | String | The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0 |
| first_activated_date | Date | The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0 |
| rating_state | String | The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0 |
| rated_up_to | Date | The date up until which the termed service was rated. Available from CRM.COM R9.0.0 |
| product | Product object | The product classified as termed service which is related with the retrieved termed 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 |
Name | Type | Description |
|---|---|---|
id | String | The id of the retrieved provisioning distributor |
name | String | The name of the retrieved provisioning distributor |
alternative_code | String | The alternative code of the retrieved provisioning distributor |
- No labels