Page Comparison

...

Tip
Available from CRM.COM R13.0.0

Excerpt
This method creates a usage authorisation. A single usage authorisation can be created by each call.

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
accounts_receivable_identifier (

mandatory

semi-optional)

Subscription

Accounts Receivable Identifier

The identifier of the accounts receivable related with the usage authorisation to be created. The allowed accounts receivable identifier fields are the following:

Include Page

	V4:accounts_receivable_identifier_post
	V4:accounts_receivable_identifier_post

Tip
Mandatory prior CRM.COM R17.0.0, semi-optional from CRM.COM R17.0.0

subscription_identifier

(semi-optional)

Subscription Identifier

The identifier of the subscription through which the usage authorisation amount will be consumed. The allowed subscription identifier fields are the following:

Include Page

	V4:subscription_identifier
	V4:subscription_identifier

Tip
Available from CRM.COM R17.0.0

authorisation_amount

(mandatory)

Float

The amount of money the subscriber requests to be authorised

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 of those parameters is allowed to be specified.

...

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

{
  "token":"{{token}}",
  "accounts_receivable_identifier":{"number":"ACR0000011921"},
  "authorisation_amount":50
}

Response:

Code Block

language	javascript
theme	Confluence	language	javascript
linenumbers	true

 {
  "data": {
    "authorisation_date": "2017-04-04T00:00:00",
    "usage_authorisation_services": [
      {
        "service_family": null,
        "maximum_usage": 64,
        "service_type": null,
        "service": {
          "code": "Usage Service 3",
          "product_type": {
            "service_type": "USAGE",
            "used_for_provisioning": false,
            "alternative_code": "USTB",
            "udr_type": {
              "alternative_code": "L",
              "name": "Litres",
              "description": null,
              "id": "B1238270684F4457B6D8EBD4CA00963B"
            },
            "composition_method": "FLAT",
            "name": "Usage Service Type B",
            "description": null,
            "id": "8FEC7EEE39254E55ABA2C3382C432D2D",
            "classification": "SERVICES",
            "physical_good_type": null
          },
          "alternative_code": "US3",
          "description": "Usage Service 3",
          "id": "6444E6324BCE4A34A99DD795E55C016D"
        },
        "maximum_amount": "0",
        "id": "0CFA05C5E5924EEE9D5B19AC3FEE0068"
      },
      {
        "service_family": null,
        "maximum_usage": 1,
        "service_type": null,
        "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"
        },
        "maximum_amount": "0",
        "id": "0C02283A665444C3A6C74FD262364057"
      },
      {
        "service_family": null,
        "maximum_usage": 10,
        "service_type": {
          "service_type": "USAGE",
          "used_for_provisioning": false,
          "alternative_code": "USTA",
          "udr_type": {
            "alternative_code": "L",
            "name": "Litres",
            "description": null,
            "id": "B1238270684F4457B6D8EBD4CA00963B"
          },
          "composition_method": "FLAT",
          "name": "Usage Service Type A",
          "description": null,
          "id": "819661A2C34A4BBF9005E74387CD7A40",
          "classification": "SERVICES",
          "physical_good_type": null
        },
        "service": null,
        "maximum_amount": "0",
        "id": "EFD35C8D331C46E3A2F7BF6F09D69ABC"
      }
    ],
    "authorisation_amount": "50.00",
    "accounts_receivable": {
      "number": "ACR0000011921",
      "name": "ACR0000011921",
      "id": "20956A4C18C94A19BE75249D567DBA00",
      "life_cycle_state": "ACTIVE",
      "account_owner": {
        "company_profile": null,
        "company_name": null,
        "name": null,
        "last_name": "Allowance_2",
        "id": "198E7882488E4B5B936441EE0CE811C0",
        "life_cycle_state": "FINANCIAL",
        "middle_name": null,
        "title": null,
        "type": "PERSON",
        "first_name": "AC",
        "demographics": {
          "name_day": {
            "month": null,
            "day": null
          },
          "id_number": null,
          "gender": null,
          "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": "DEDC131D808742A2A380C0C8D64F5B84",
    "life_cycle_state": "BLOCKED",
    "expiration_date": "2017-05-04T19:09:00"
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

...

Versions Compared

Old Version 3

New Version Current

Key

Resource URL

Parameters

Restrictions