Page Comparison

...

Available from CRM.COM R7.0.0

Excerpt
This method adds the usage of one or multiple subscription services belonging on a specific subscription.

Resource URL

Parameters

...

Name

...

Type

...

Description

...

token

...

String

...

The token retrieved from the login method

...

subscription_identifier

(semi-optional)

...

The subscription to be modified. The allowed subscription identifier fields are the following:

...

Tip
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory

...

accounts_receivable_identifier

(semi-optional)

...

Tip
Available from CRM.COM R7.0.0

Excerpt
This method adds the usage of one or multiple subscription services belonging on a specific subscription.

Resource URL

Parameters

The action type that should be used. The allowed subscription action type identifier fields are the following:

Thesub actiontype that should be used. The allowed subscription sub action type identifier fields are the following:

The user that actually performed the action. The allowed user identifier fields are the following:

billing_effective_datebillable_period_start_datescheduled_dateintended_currency_identifierV4:currency_identifierString2 3 4 1234

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

Tip
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

Note
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

Tip
Available from CRM.COM R13.0.0

action_type_identifier

(optional)

Subscription action type identifier

The action type that should be used. The allowed subscription action type identifier fields are the following:

Include Page

	V4:subscription_action_type_identifier
	V4:subscription_action_type_identifier

Tip
Deprecated from CRM.COM R15.0.0

sub_action_type_identifier

(optional)

Subscription sub action type identifier

The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:

Include Page

	V4:subscription_sub_action_type_identifier
	V4:subscription_sub_action_type_identifier

Tip
Deprecated from CRM.COM R15.0.0

classification_identifier

(optional)

Subscription Action Classification Identifier

The subscription action's classification. The allowed subscription action classification identifier fields are the following:

Include Page

	V4:subscription_action_classification_identifier
	V4:subscription_action_classification_identifier

Tip
Available from CRM.COM R18.0.0

payment_gateway_card_identifier

(optional)

Payment Gateway Card Identifier

The payment gateway card that will be used to post a payment against the accounts receivable of the subscription. Applicable and required only for Subscriptions following the "Pay before bill" payment model. The applicable payment gateway card identifier fields are the following:

Include Page

	V4:payment_gateway_card_identifier
	V4:payment_gateway_card_identifier

Tip
Available from CRM.COM R14.3.0

transaction_reference_number

(optional)

String

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

Tip
Available from CRM.COM R13.0.0

performed_by_user_identifier

(optional)

User identifier

The user that actually performed the action. The allowed user identifier fields are the following:

Include Page

	V4:user_identifier
	V4:user_identifier

performed_by_unit_identifier

(optional)

Unit Identifier

The unit that performed the action. The allowed unit identifier fields are the following:

Include Page

	V4:unit_identifier
	V4:unit_identifier

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R18.0.0

performed_by_business_unit_identifier

(optional)

Business Unit Identifier

The business unit that performed the action. The allowed business unit identifier fields are the following:

Include Page

	V4:

accounts

business_

receivable

unit_identifier

_post


	V4:

accounts

business_

receivable

unit_identifier

_post

Note
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

Tip
Available from CRM.COM R13.0.0

action_type_identifier

(optional)

Subscription action type identifier

Include Page

V4:subscription_action_type_identifier

sub_action_type_identifier

(optional)

Subscription sub action type identifier

Include Page

V4:subscription_sub_action_type_identifier

transaction_reference_number

(optional)

String

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions

Tip
Available from CRM.COM R18.0.0

performed_on

(optional)

Date

The date that the action was actually performed

billing_effective_date

(optional)

Date

Determines when the subscription services that are affected by the subscription action should be billed by the billing engine.

billable_period_start_date

(optional)

Date

Determines the start date of the billable period of each subscription service (it answerstothe question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

Date

Defines the scheduled date of the subscription action. If not specified, then the subscription action will be immediately executed

Tip
Available from CRM.COM R12.1.0

use_proposed_scheduled_date

(optional)

Boolean

Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.

Tip
Available from CRM.COM R13R15.0.0

performedintended_by_usercurrency_identifier

(optional)

User identifier

Include Page

V4:user_identifier

performed_by_unit_identifier

(optional)

Unit Identifier

The unit that performed the action. The allowed unit Currency Identifier

The currency that the user was intended to use for the added usage. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an erroris throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page

	V4:unitcurrency_identifier
	V4:unit_identifiercurrency_identifier

Tip
Available from CRM.COM R12.0.0

usage_authorisation_id

(optional)

String

The unique identifier of the usage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.

Tip
Available from CRM.COM R14R13.0.0

performed_on

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)

Date

The date that the action was actually performed

String

User Defined Field of type String

udf_string_4

(optional)

Date

Determines when the subscription services that are affected by the subscription action should be billed by the billing engine.

String

User Defined Field of type String

udf_string_5

(optional)

Date

Determines the start date of the billable period of each subscription service (it answerstothe question “from which date should I start billing this service) that is affected by the subscription action.

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

Date

Defines the scheduled date of the subscription action. If not specified, then the subscription action will be immediately executed

Tip
Available from CRM.COM R12.1.0

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

Currency Identifier

The currency that the user was intended to use for the added usage. If specified then it is validated against the currency of the specified accounts receivable and if they don't match then an erroris throw. Note that the intended currency is not saved within CRM.COM; it is just used for validation purposes. The allowed currency identifier fields are the following:

Include Page

V4:currency_identifier

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_10

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R12R14.02.0

usageudf_authorisationstring_id11

(optional)

String

User Defined Field of type String

The unique identifier of the usage authorisation. Only usage authorizations in Blocked life cycle state is allowed to be specified.

Tip
Available from CRM.COM R14.2.0

udf_string_12

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R13R14.02.0

udf_string_1 13

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_

14

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_

15

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_

16

(optional)

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_stringfloat_51

(optional)

String

Float

User Defined Field of type StringFloat

udf_stringfloat_6 2

(optional)

String

Float

User Defined Field of type StringFloat

udf_stringfloat_73

(optional)

String

Float

User Defined Field of type StringFloat

udf_stringfloat_84

(optional)

String

Float

User Defined Field of type StringFloat

udf_float_

5

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_

6

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_

7

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_

8

(optional)

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

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

usage_detail_record_set

Usage Detail Record Objects Set

The set of usage detail records that should be added for each existing subscription service, classified as termed services

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

Tip
Available from CRM.COM R10.0.0

Anchor
services_add_usage referred objects parameters
services_add_usage referred objects parameters
Referred Parameter Objects Data

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

{
    "token":"E2CA46AC1DD04F08842777BBF3823FA3",
    "subscription_identifier":{"number":"S60555"},
    "usage_detail_record_set" :[
        { 
            "product_identifier" : { "code" : "Movie 2" },
        	"source_system_identifier":{ "name" : "IVR" },
        	"type_identifier":{ "name" : "Discounted" },
            "device_identifier":{"name":"Tablet"},
            "usage_method_identifier":{"name":"Download"},
        	"billing_directive":"TO_BE_BILLED",
            "usage_service_catalog_identifier":{ "name" : "Catalog Story board 5" },
        	"from_date": "2015-09-23T19:07:44",
        	"to_date": "2015-09-30T19:07:44",
        	"usage_amount" : 20,
        	"subscription_service" : {"service_identifier": {"code":"Silver"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"},
			"provisioning_distributor_identifier":{"id":"B192D909D9B041F89FA8A197DC0F709A"}
		},
		{ 
            "product_identifier" : { "code" : "Movie 3" },
        	"source_system_identifier":{ "name" : "IVR" },
        	"type_identifier":{ "name" : "Discounted" },
            "device_identifier":{"name":"Tablet"},
            "usage_method_identifier":{"name":"Download"},
        	"billing_directive":"TO_BE_BILLED",
            "usage_service_catalog_identifier":{ "name" : "Catalog Story board 5" },
        	"from_date": "2015-09-23T19:07:44",
        	"to_date": "2015-09-30T19:07:44",
        	"usage_amount" : 20,
        	"subscription_service" : {"service_identifier": {"code":"Silver"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"}
        }
    ]
}

Response

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "status":
    {
        "message": "",
        "description": "",
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-09-24T11:45:58",
        "submitted_on": "2015-09-24T11:45:58",
        "action_type": null,
        "sub_action_type": null,
        "business_classification_code": "ADD_SERVICE_USAGE",
        "number": "1939",
        "executed_on": "2015-09-24T11:46:11",
        "life_cycle_state": "EXECUTED",
        "performed_by": null,
        "behavior_code": "ADD_SERVICE_USAGE",
        "id": "D9C5C4685973423895E6A291C15AA8A4",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "subscription":
        {
            "life_cycle_state": "EFFECTIVE",
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Ioannou97",
                    "middle_name": null,
                    "life_cycle_state": "FINANCIAL",
                    "company_profile": null,
                    "title": null,
                    "first_name": "Marios",
                    "type": "PERSON",
                    "id": "82CAA74F74324D26825E444460F4B65C",
                    "name": "Ioannou97 Marios",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "social_security_number": null,
                        "passport_number": null,
                        "industry_sector": null,
                        "country_of_residence":
                        {
                            "three_character_code": "USA",
                            "two_character_code": "US",
                            "id": "127",
                            "name": "UNITED STATES",
                            "alternative_code": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "id_number": "435345",
                        "industry": null,
                        "id_issued_by_country": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "ACR000778",
                "id": "917763A6499545B593DFBBC21A3689CB",
                "name": "mar97"
            },
            "number": "S60555",
            "type":
            {
                "udf_float_1": null,
                "udf_float_2": null,
                "udf_date_1": null,
                "udf_float_3": null,
                "udf_date_2": null,
                "udf_float_4": null,
                "udf_date_3": null,
                "udf_date_4": null,
                "name": "London",
                "udf_string_1": null,
                "udf_string_2": null,
                "udf_string_3": null,
                "udf_string_4": null,
                "udf_string_5": null,
                "udf_string_6": null,
                "udf_string_7": null,
                "log_information":
                {
                    "updated_date": "2015-09-15T10:02:30",
                    "created_date": "2014-06-23T14:59:40",
                    "created_by_unit":
                    {
                        "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "name": "Admin Unit",
                        "group_name": "Main Group",
                        "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",
                        "group_name": "Main Group",
                        "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"
                    }
                },
                "udf_string_8": null,
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": null,
                "alternative_code": "LND"
            },
            "id": "16C09DFDDF444C25A97953191DE653DC"
        },
        "performed_on": null
    }
}

...

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
    "token":"E2CA46AC1DD04F08842777BBF3823FA3",
     "fields_set":"number,submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{
        "number":"S60708"
    },
"usage_detail_record_set" :[
        {
            "product_identifier" : { "code" : "Movie 2" },
            "type_identifier":{ "name" : "Discounted" },
            "usage_service_catalog_identifier":{"name":"Test Product"},
            "billing_directive":"TO_BE_BILLED",
            "from_date": "2015-09-23T19:07:44",
            "to_date": "2015-09-30T19:07:44",
            "usage_amount" : 20,
            "subscription_service" : {"service_identifier": {"code":"Gold"}},
            "destination_category_identifier":{"name":"Voip Application"},
            "source_category_identifier":{"name":"United Kingdom"},
            "provisioning_distributor_identifier":{"name":"Nagra Media Live 1"}
        }
    ]
}

Response:

Code Block

language	javascript
theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": null,
    "sub_action_type": null,
    "number": "4345",
    "submitted_by": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email": "sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Mika",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Ms",
          "first_name": "Dina",
          "type": "PERSON",
          "id": "9ED00E7228634EF986807DF4D86A3F84",
          "name": "Mika Dina",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "USA",
              "two_character_code": "US",
              "id": "127",
              "name": "UNITED STATES",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "14587522",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000525",
        "id": "C8A54A6BB4B9423AA560D6B955CD1271",
        "name": "Dina Mika"
      },
      "number": "S60708",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "C9EE8F9CC81143538BE2462684D04733",
      "first_activated_date": "2016-02-18T14:42:41",
      "rating_state": "PENDING"
    }
  }
}

...

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

language

language	javascript
theme	Confluence
javascript	linenumbers	true

{
"token":"eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9",
    "subscription_identifier":{
        "number":"S0000009206"
    },
"usage_detail_record_set" :[
        {
            "product_identifier" : { "code" : "Usage Service 3" },
            "usage_service_catalog_identifier":{"name":"Test"},
            "billing_directive":"TO_BE_BILLED",
            "usage_amount" : 5,
            "subscription_service" : {"service_identifier": {"code":"Bronze"}}
        },
        {
            "product_identifier" : { "code" : "Serendipity" },
            "usage_service_catalog_identifier":{"name":"Require Installed Item"},
            "billing_directive":"TO_BE_BILLED",
            "usage_amount" : 5,
            "subscription_service" : {"service_identifier": {"code":"Bronze"}},
            "installed_item_identifier":{"serial_number":"smartcard_7385_01"}
        }
    ]
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

    {
        "data":
        {
            "performed_by": null,
            "action_type": null,
            "transaction_reference_number": null,
            "submitted_by":
            {
                "person_name": "CRM COM",
                "id": "1",
                "username": "MPAdministrator"
            },
            "executed_on": "2017-10-18T10:07:48",
            "life_cycle_state": "EXECUTED",
            "subscription":
            {
                "number": "S0000009206",
                "first_activated_date": "2017-10-18T08:48:58",
                "rating_state": "PENDING",
                "accounts_receivable":
                {
                    "number": "ACR0000012733",
                    "name": "ACR0000012733 Test 7738_02",
                    "id": "8A0A9CCA05BB4B5F8625CB20C73C123A",
                    "life_cycle_state": "ACTIVE",
                    "account_owner":
                    {
                        "company_profile": null,
                        "company_name": null,
                        "name": "Test 7738_02",
                        "last_name": "7738_02",
                        "id": "A3755B28A26A4E76B294093F159BDDBA",
                        "life_cycle_state": "FINANCIAL",
                        "middle_name": null,
                        "title": null,
                        "type": "PERSON",
                        "first_name": "Test",
                        "demographics":
                        {
                            "name_day":
                            {
                                "month": null,
                                "day": null
                            },
                            "id_number": "7738_02",
                            "gender": null,
                            "country_of_residence":
                            {
                                "alternative_code": "CYP",
                                "three_character_code": "CYP",
                                "name": "CYPRUS",
                                "id": "181",
                                "two_character_code": "CY"
                            },
                            "date_of_birth":
                            {
                                "month": null,
                                "year": null,
                                "day": null
                            },
                            "industry_sector": null,
                            "passport_number": null,
                            "industry": null,
                            "social_security_number": null,
                            "id_issued_by_country": null,
                            "passport_issued_by_country": null
                        }
                    }
                },
                "id": "9B6C8150B5CB401F982729D1FF5AED56",
                "life_cycle_state": "EFFECTIVE",
                "type":
                {
                    "alternative_code": "normalsub",
                    "name": "Normal",
                    "description": null,
                    "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
                }
            },
            "scheduled_date": "2017-10-18T10:07:25",
            "performed_on": null,
            "sub_action_type": null,
            "business_classification_code": "ADD_SERVICE_USAGE",
            "number": "25508",
            "submitted_on": "2017-10-18T10:07:25",
            "id": "B9977262DC624794ACACC469D1ECF237",
            "job": null,
            "behavior_code": "ADD_SERVICE_USAGE",
            "performed_by_unit": null
        },
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }

...

Versions Compared

Old Version 8

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Anchor
services_add_usage referred objects parameters
services_add_usage referred objects parameters
Referred Parameter Objects Data

Page Comparison

Versions Compared

Old Version 8

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Anchorservices_add_usage referred objects parametersservices_add_usage referred objects parametersReferred Parameter Objects Data

Anchor
services_add_usage referred objects parameters
services_add_usage referred objects parameters
Referred Parameter Objects Data