Tip
Available from CRM.COM R8.0.0

Table of Contents

maxLevel	2

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

life_cycle_state

(optional)

String

If specified then only usage service catalogs having a life cycle state equal to the specified value will be retrieved. The supported values are DRAFT, EFFECTIVE, NOT_EFFECTIVE or CANCELLED

valid_as_of_date

(optional)

Date

If specified then only usage service catalogs which are valid on that date will be retrieved.

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier

If specified then only usage service catalogs related with the specified provisioning provider will be retrieved. The allowed provisioning provider identifier fields are the following:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

If specified then the only usage service catalogs which can be provided to the specified accounts receivable will be retrieved. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

subscription_identifier

(optional)

Subscription Identifier

If specified then the only usage service catalogs which can be provided to the specified subscription will be retrieved. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

termed_service_identifier

(optional)

Product Identifier

If specified then the only usage service catalogs which can be provided to the specified termed service will be retrieved. The allowed termed service identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

group_identifier

(optional)

Group Identifier

The identifier of the group that will be using the usage service catalog. The group is filtered against the usage service catalog's allowed organisational units. The allowed group identifier fields are the following:

Include Page

	V4:group_identifier
	V4:group_identifier

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be using the usage service catalog. The unit is filtered against the usage service catalog's allowed organisational units. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

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

...

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:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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:

Include Page

	V4:product_identifier
	V4:product_identifier

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:

Include Page

	V4:group_identifier
	V4:group_identifier

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

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

...

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_identifier

(semi-optional)

Usage Service Identifier

If specified then only usage services rates related with the specified usage service will be retrieved. The allowed usage service identifier fields are the following:

Include Page

	V4:product_identifier
	V4:product_identifier

usage_service_catalog_identifier

(semi-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:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

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:

Include Page

	V4:accounts_receivable_identifier
	V4:accounts_receivable_identifier

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:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

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:

Include Page

	V4:product_identifier
	V4:product_identifier

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:

Include Page

	V4:group_identifier
	V4:group_identifier

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:

Include Page

	V4:unit_identifier
	V4:unit_identifier

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

...

Expand

title	Example 2

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    [
        {
            "rate": 26,
            "minimum_usage": 1,
            "maximum_usage": 15,
            "source_category":
            {
                "name": "United Kingdom",
                "id": "3107A54E4DD840DA93A452B12CEF2246",
                "description": "United Kingdom",
                "code": "UK"
            },
            "device":
            {
                "name": "STB",
                "id": "FF9922EF7C43474AA5C6AD07A3911DA5",
                "description": null,
                "alternative_code": "STB"
            },
            "usage_start_time": "null:null",
            "id": "85CD14CF5BEA427D8E0BCCF898410AAA",
            "usage_end_time": "null:null",
            "usage_method":
            {
                "name": "Rental",
                "id": "250B5CB790CA4344A27299962868C57D",
                "description": "rental",
                "alternative_code": "rl"
            },
            "destination_category":
            {
                "name": "Voip Application",
                "id": "629C2E9E7B044012B0534787974E9D7C",
                "description": "VOIP APPLICATION",
                "code": "VOIP"
            }
        },
        {
            "rate": 45,
            "minimum_usage": null,
            "maximum_usage": null,
            "source_category":
            {
                "name": "VoiP Application",
                "id": "F504F4E00C724E9AB0C412EF0C0369D4",
                "description": "VoiP Application",
                "code": "VOIP"
            },
            "device":
            {
                "name": "Tablet",
                "id": "ACDED1DC999A4FB1AC375622CD1C6147",
                "description": "Tablet",
                "alternative_code": "Tablet"
            },
            "usage_start_time": "1:0",
            "id": "78867FDE96B64725885B79F922652D93",
            "usage_end_time": "9:15",
            "usage_method":
            {
                "name": "Download",
                "id": "665FCE1AF41F44CB87A74CD9E769C488",
                "description": "Download",
                "alternative_code": "Download"
            },
            "destination_category":
            {
                "name": "United Kingdom",
                "id": "B1B639D5526A4EA0A205DA649F30077D",
                "description": "UNITED KINGDOM",
                "code": "UK"
            }
        },
        {
            "rate": 26,
            "minimum_usage": 1,
            "maximum_usage": 15,
            "source_category":
            {
                "name": "United Kingdom",
                "id": "3107A54E4DD840DA93A452B12CEF2246",
                "description": "United Kingdom",
                "code": "UK"
            },
            "device":
            {
                "name": "STB",
                "id": "FF9922EF7C43474AA5C6AD07A3911DA5",
                "description": null,
                "alternative_code": "STB"
            },
            "usage_start_time": "null:null",
            "id": "3DE50B14250E44EC947B94BFC99141C1",
            "usage_end_time": "null:null",
            "usage_method":
            {
                "name": "Rental",
                "id": "250B5CB790CA4344A27299962868C57D",
                "description": "rental",
                "alternative_code": "rl"
            },
            "destination_category":
            {
                "name": "Voip Application",
                "id": "629C2E9E7B044012B0534787974E9D7C",
                "description": "VOIP APPLICATION",
                "code": "VOIP"
            }
        }
    ]
}

Expand

title	Example 3

HTTP Method: GET

Request:

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "data": [
    {
      "end_date": null,
      "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": "2017-05-11T15:51:30",
        "updated_date": "2017-05-12T15:05:38",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "71187B1A53904566BDABF838311BF849",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "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": {
            "unit_of_measurement": null,
            "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": null,
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [
        {
          "minimum_usage": 101,
          "maximum_usage": 200,
          "usage_start_time": null,
          "rate": 1.055,
          "source_category": null,
          "usage_end_time": null,
          "usage_method": null,
          "id": "E074C097CA7B47568377FD62D41B6393",
          "device": null,
          "destination_category": null
        },
        {
          "minimum_usage": 1,
          "maximum_usage": 100,
          "usage_start_time": null,
          "rate": 1.056,
          "source_category": null,
          "usage_end_time": null,
          "usage_method": null,
          "id": "A9B08C4D087E442CAD73FE955E259E04",
          "device": null,
          "destination_category": null
        }
      ],
      "base_rate": 5,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "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": "2017-05-11T16:26:19",
        "updated_date": "2017-05-11T16:32:49",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": true,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "5668DC76868A4EEAAAA6CDEC485F7D77",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Petrol",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "EP",
        "description": "Petrol",
        "id": "E1EB6B2EBFC444A1BEA9A030A5B4D56D"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 0.5,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "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": "2017-05-11T16:26:50",
        "updated_date": "2017-05-11T16:27:35",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": false,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "D5C736D9C2B245029ADBC47C92822554",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Unleaded",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "EU",
        "description": "Exxon Unleaded",
        "id": "3F174D8E87474A2AB115A2BFD2750FBB"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 1,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    },
    {
      "end_date": null,
      "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": "2017-05-11T16:33:42",
        "updated_date": "2017-05-11T16:33:48",
        "updated_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        },
        "created_by_user": {
          "person_name": "MPAdministrator",
          "id": "1",
          "email": null,
          "username": "MPAdministrator"
        }
      },
      "udf_date_2": null,
      "udf_date_1": null,
      "udf_date_4": null,
      "udf_date_3": null,
      "apply_additional_discount": true,
      "udf_float_3": null,
      "udf_float_4": null,
      "id": "E7F1ABB30B71457C9229CC40ADE55494",
      "udf_float_1": null,
      "udf_float_2": null,
      "start_date": null,
      "udf_string_2": null,
      "udf_string_3": null,
      "usage_service": {
        "code": "Exxon Super",
        "product_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "E",
          "udr_type": {
            "unit_of_measurement": {
              "alternative_code": "L",
              "name": "Litre",
              "description": "Littres",
              "id": "A588A14FFA214303BD2182BCF6E9ACCF"
            },
            "alternative_code": "T",
            "name": "Test",
            "description": null,
            "id": "C72DCF90AD66467388FA0B7725A24E21"
          },
          "composition_method": "FLAT",
          "name": "Exxon",
          "description": null,
          "id": "ACA2649D85044264AADC31B5DB0BC567",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "alternative_code": "ES",
        "description": "Exxon Super Unleaded",
        "id": "056447D7931F49D49970D8753AA97688"
      },
      "udf_string_4": null,
      "udf_string_5": null,
      "udf_string_1": null,
      "tiered_rates_set": [],
      "base_rate": 0.75,
      "pre_rated": false,
      "udf_string_6": null,
      "udf_string_7": null,
      "udf_string_8": null
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

POST usage_service_catalogs/create

...

Parameters

Name

Type

Description

name

(mandatory)

String

The Name of the usage service catalog

alternative_code

(mandatory)

String

The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name

description

(optional)

String

The Description of the usage service catalog

termed_service_requirements

(mandatory)

String

Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:

REQUIRES_EFFECTIVE_TERMED_SERVICE
REQUIRES_EFFECTIVE_OR_NOT_EFFECTIVE_TERMED_SERVICE
DOES_NOT_REQUIRE_TERMED_SERVICE

Tip
Available from CRM.COM R13.0.0

create_as_draft

(optional)

Boolean

If set to true then the usage service catalog will be created as draft. If set to false or not specified at all, then the usage service catalog will be created as effective

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier

The provisioning provider related with the usage service catalog that will be created. The allowed provisioning provider identifier fields are the following:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

validity_set

(optional)

Set of Usage Service Catalog Validity Objects

The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available

usage_services_set

(mandatory)

Set of Usage Service Catalog Usage Services

The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified.

...

Name

Type

Description

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The usage service catalog that will be updated. The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

name

(optional)

String

The Name of the usage service catalog

alternative_code

(optional)

String

The Alternative Code of the usage service catalog. If not specified then it is generated automatically based on the specified name

description

(optional)

String

The Description of the usage service catalog

termed_service_requirements

(mandatory)

String

Defines the settings related to whether a termed service will be required when adding a Usage Service on a Subscription. Applicable values are:

REQUIRES_EFFECTIVE_TERMED_SERVICE
REQUIRES_EFFECTIVE_OR_NOT_EFFECTIVE_TERMED_SERVICE
DOES_NOT_REQUIRE_TERMED_SERVICE

Tip
Available from CRM.COM R13.0.0

Boolean

If set to true then the usage service catalog will be updated as draft. If set to false or not specified at all, then the usage service catalog will be updated as effective. This is applicable only if the usage service catalog that will be updated is in draft life cycle state

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier

The provisioning provider related with the usage service catalog that will be updated. The allowed provisioning provider identifier fields are the following:

Include Page

	V4:provisioning_provider_identifier
	V4:provisioning_provider_identifier

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

validity_set

(optional)

Set of Usage Service Catalog Validity Objects

The time periods during which the usage service catalog will be available to be used. If not specified then the usage service catalog will be always be available

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

usage_services_set

(mandatory)

Set of Usage Service Catalog Usage Services

The usage services offered through the usage service catalog and their rates. At least one usage service should be specified. Each usage service can be included in a usage service catalog just once. Only products classified as usage services can be specified.

Include Page

	V4:Web API - Updating Sets
	V4:Web API - Updating Sets

Note that usage services already included in a usage service catalog can be removed only if the usage service catalog is still draft, or if the usage service catalog is effective or not effective and there are no usage subscription services which are posted, billable and still not billed

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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

...

Name

Type

Description

token

String

The token retrieved from the login method

usage_service_catalog_identifier

(mandatory)

Usage Service Catalog Identifier

The identifier of the usage service catalog .The allowed usage service catalog identifier fields are the following:

Include Page

	V4:usage_service_catalog_identifier
	V4:usage_service_catalog_identifier

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

...

Versions Compared

Old Version 35

New Version 36

Key

POST usage_service_catalogs/create

Parameters

Page Comparison

Versions Compared

Old Version 35

New Version 36

Key

POST usage_service_catalogs/create

Parameters