This method returns the usage services, which are included in effective usage service catalogs and are allowed to be used by subscribers, during the specified date. Multiple usage services are returned by each call
Resource URL
Parameters
Name | Type | Description | ||||||||||||
token | String | The token retrieved from the login method | ||||||||||||
valid_as_of_date (mandatory) | Date | If specified then only usage services included in usage service catalogs which are valid on that date will be retrieved. | ||||||||||||
usage_service_catalog_identifier (optional) | Usage Service Catalog Identifier | If specified then only usage services included in that usage service catalogs will be retrieved. The allowed usage service catalog identifier fields are the following:
| ||||||||||||
provisioning_provider_identifier (optional) | Provisioning Provider Identifier | If specified then only usage services included in usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:
Deprecated from CRM.COM R16.1.0 | ||||||||||||
accounts_receivable_identifier (optional) | Accounts Receivable Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:
| ||||||||||||
subscription_identifier (optional) | Subscription Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:
| ||||||||||||
termed_service_identifier (optional) | Product Identifier | If specified then the only usage services included in usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:
| ||||||||||||
group_identifier (optional) | Group Identifier | The identifier of the group that will be using the usage services. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:
| ||||||||||||
unit_identifier (optional) | Unit Identifier | The identifier of the unit that will be using the usage services. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:
Deprecated from CRM.COM R18.0.0 | ||||||||||||
business_unit_identifier (optional) | Business Unit Identifier | The identifier of the business unit that will be using the usage services. The business unit is filtered against the usage service catalog's allowed organisational units. The allowed business unit identifier fields are the following: Unable to render {include} The included page could not be found. Available from CRM.COM R18.0.0 | ||||||||||||
number_of_results (optional) | Number | The number of results that can be retrieved through each call Available from CRM.COM R13.0.0 | ||||||||||||
offset (optional) | Number | Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number Available from CRM.COM R13.0.0 | ||||||||||||
fields_set (optional) | List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the retrieved usage service catalog usage service |
| base_rate | Float | The base rate of the retrieved usage service catalog usage service Deprecated from CRM.COM R15.0.0 |
| start_date | String | The date and time during which the provisioning of the usage service catalog usage service will start Deprecated from CRM.COM R17.0.0 |
| end_date | String | The date and time during which the provisioning of the usage service catalog usage service will end Deprecated from CRM.COM R17.0.0 |
| provisioning_id | String | The ID used to provision the specified usage service. This information is applicable only if the related usage service is classified as a provisioning service Deprecated from CRM.COM R15.0.0 |
| pre_rated | Boolean | It defines if the retrieved usage service catalog usage service is a pre-rated service or not. It the value is true then it means that the service is pre-rated. It the value is false then it means that the service is post-rated Note that if the service is pre-rated then the base rate and tier rates are not applicable Available from CRM.COM R12.0.0 Deprecated from CRM.COM R15.0.0 |
| apply_additional_discount | Boolean | It defines if additional discount will be applicable on the pre-rated usage service. This option is applicable only if the usage service is classified as pre-rated Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.0.0 |
udf_string_1 | String | User Defined Field of type String |
udf_string_2 | String | User Defined Field of type String |
udf_string_3 | String | User Defined Field of type String |
udf_string_4 | String | User Defined Field of type String |
udf_string_5 | String | User Defined Field of type String |
udf_string_6 | String | User Defined Field of type String |
udf_string_7 | String | User Defined Field of type String |
udf_string_8 | String | User Defined Field of type String |
udf_float_1 | Float | User Defined Field of type Float |
udf_float_2 | Float | User Defined Field of type Float |
udf_float_3 | Float | User Defined Field of type Float |
udf_float_4 | Float | User Defined Field of type Float |
udf_date_1 | Date | User Defined Field of type Date |
udf_date_2 | Date | User Defined Field of type Date |
udf_date_3 | Date | User Defined Field of type Date |
udf_date_4 | Date | User Defined Field of type Date |
| currency | Currency Object | The currency in which the rate is returned Available from CRM.COM R14.2.0 Deprecated from CRM.COM R15.0.0 |
| tiered_rates_set | Set of Usage Service Tiered Rates Objects | The tiered rates related with the retrieved usage service catalog usage service, which are different than the specified base rate, and are applied upon meeting a set of conditions Deprecated from CRM.COM R15.0.0 |
| usage_service | Product Object | The related usage service |
| log_information | Log Information Object | The log information of the retrieved usage service catalog usage service |
Referred Objects Response Data
Examples
HTTP Method: GET
Request:
Response:
{
"data": [
{
"end_date": "2017-02-01T00:00:00",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-19T10:03:26",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "66CEFA0579514853BB38A431D9C9870B",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "Serendipity",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "S_1",
"description": "VOD: Serendipity ",
"id": "BD3ACEE7D6244DCAA375D0744DA75540"
},
"provisioning_id": "102",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": "2017-02-01T00:00:00",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-19T10:03:14",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": false,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "3ACDEAF6765947B7BC22AD54C0B1A038",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "MAD MAX",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "MM",
"description": "VOD: MAD MAX",
"id": "4FAF233199054FD18C181D83377FB3FD"
},
"provisioning_id": "202",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": 5,
"pre_rated": false,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
},
{
"end_date": "2017-02-01T00:00:00",
"log_information": {
"created_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"updated_by_unit": {
"alternative_code": "adminunit",
"name": "Admin Unit",
"description": "admin unit",
"id": "1"
},
"created_date": "2016-02-19T10:02:57",
"updated_date": "2017-03-28T18:12:07",
"updated_by_user": {
"person_name": "MPAdministrator",
"id": "1",
"username": "MPAdministrator"
},
"created_by_user": {
"person_name": "pdemou",
"id": "6403BD50DF4A4EA59C406FF686FEAB54",
"username": "pdemou"
}
},
"udf_date_2": null,
"udf_date_1": null,
"udf_date_4": null,
"udf_date_3": null,
"apply_additional_discount": true,
"udf_float_3": null,
"unit_of_measurement": {
"alternative_code": "A",
"name": "Amount",
"description": null,
"id": "0F24D08950AA4B5DB5C5F52FA5A4A7D1"
},
"udf_float_4": null,
"id": "24EB97E8ABE04705B8408125FB439379",
"udf_float_1": null,
"udf_float_2": null,
"start_date": "2016-02-19T00:00:00",
"udf_string_2": null,
"udf_string_3": null,
"usage_service": {
"code": "CREED",
"product_type": {
"service_type": "USAGE",
"used_for_provisioning": true,
"alternative_code": "V",
"udr_type": {
"alternative_code": "V",
"name": "VOD",
"description": null,
"id": "B3CFC986221548279752B1ABC6F4C480"
},
"composition_method": "FLAT",
"name": "Usage Services",
"description": "Used for VOD , PPV, TELEPHONE CALLS ETC",
"id": "751C638AA3534B768408AAC4D73CF516",
"classification": "SERVICES",
"physical_good_type": null
},
"alternative_code": "C",
"description": "VOD: CREED",
"id": "A465D282F44C46AC834BAE50A81CA2F1"
},
"provisioning_id": "101",
"udf_string_4": null,
"udf_string_5": null,
"udf_string_1": null,
"tiered_rates_set": [],
"base_rate": null,
"pre_rated": true,
"udf_string_6": null,
"udf_string_7": null,
"udf_string_8": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}
HTTP Method: GET
Request:
Response:
{
"status":
{
"message": "",
"description": "",
"code": "OK"
},
"data":
[
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-11T16:23:10",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "5F60B19CFD634F7D9B9EC401C74ACB16",
"description": "Movie 1",
"code": "Movie 1",
"alternative_code": "MOV_1"
},
"tiered_rates_set":
[
{
"rate": 2.75,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "774BE3E888B440DA92F6084EC1360328",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "218FA0FCAE6C4CA4921163C8E54F083D",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "70AB25DE293148AE8EB0B40B8776D9F7",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "42D9DEBD12C049CD91FDB5BF2797F942",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.75
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-11T16:23:51",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "33F396002DE74BB8BA5439CA943E7FEF",
"description": "Movie 2",
"code": "Movie 2",
"alternative_code": "MOV_2"
},
"tiered_rates_set":
[
{
"rate": 2.65,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "0FEA32908C13460292CB076F0F8B1962",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "3DF98A93ACD84D978F664D7FE8A327CD",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "C460582870974DC89437BF160D1BC097",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "94032F7B72AA4E528AC960D73CFF027A",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.65
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-14T08:54:11",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "48EF1EF8896448DE871E359454D856FF",
"description": "Movie 3",
"code": "Movie 3",
"alternative_code": "MOV_3"
},
"tiered_rates_set":
[
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "163D0E9964BE41B9AB24C04C09A8062E",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 1,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"usage_start_time": "null:null",
"id": "89AF39865820492EA69A5F80E91D704F",
"usage_end_time": "null:null",
"destination_category": null
},
{
"rate": 2.55,
"minimum_usage": null,
"maximum_usage": null,
"source_category": null,
"device": null,
"usage_start_time": "null:null",
"id": "B2F571C7AB5A4B08BDDAF868C0E3A23C",
"usage_end_time": "null:null",
"destination_category": null
}
],
"id": "70C7AE56C6144B97BB2E5360F74C1947",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 1.55
},
{
"log_information":
{
"updated_date": "2015-09-14T14:42:49",
"created_date": "2015-09-14T08:54:42",
"created_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"updated_by_unit":
{
"id": "48305F8849E3C18B227C5BE3A27BA6DF",
"name": "Admin Unit",
"description": "r1 Test Description for resource request tab.Test Description for resource request tab.",
"alternative_code": "MG"
},
"created_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
},
"updated_by_user":
{
"person_name": "MPAdministrator",
"username": "MPAdministrator",
"id": "1"
}
},
"end_date": null,
"usage_service":
{
"product_type":
{
"service_type": "USAGE",
"physical_good_type": null,
"used_for_provisioning": true,
"classification": "SERVICES",
"composition_method": "FLAT",
"id": "219FBB8FBAA1433AB0A33446B61637F9",
"name": "Usage - Flat",
"description": "Usage - Flat",
"alternative_code": "U-F"
},
"id": "8993F9B282894DACB291AE2AC614A2CC",
"description": "Phone Calls",
"code": "Phone Calls",
"alternative_code": "PHONE_CALLS"
},
"tiered_rates_set":
[
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "0:0",
"id": "6F67A99EAF2A467695929863701E1A45",
"usage_end_time": "7:0",
"usage_method": null
},
{
"rate": 0.06,
"minimum_usage": 1,
"maximum_usage": 10,
"device": null,
"usage_start_time": "null:null",
"id": "A75BF46E2D7B4936AFE52B1BFD361A42",
"usage_end_time": "null:null",
"usage_method": null
},
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "22:0",
"id": "08CC891B8AC346518835AA06F0768ADC",
"usage_end_time": "0:0",
"usage_method": null
},
{
"rate": 0,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "null:null",
"id": "07107E57E2A64363B771B81D813E1566",
"usage_end_time": "null:null",
"usage_method": null
},
{
"rate": 0.05,
"minimum_usage": null,
"maximum_usage": null,
"device": null,
"usage_start_time": "19:0",
"id": "2A1B981439A041CB80C1D7B5DFD15905",
"usage_end_time": "22:0",
"usage_method": null
}
],
"id": "3B71BDF4612D426D8F097D8C6758F7AA",
"start_date": "2015-09-01T00:00:00",
"provisioning_id": "9C4930E3523BD2C8F0B513035322C423",
"base_rate": 0.07
}
]
}