Page Comparison

Tip
Available from CRM.COM R17.0.0

Excerpt
This method removes (deletes) the usage allowance limits from a Subscription, allowing thus unrestricted usage consumption. A single Subscription is updated by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(mandatory)

Subscription Identifier

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

Include Page

	V4:subscription_identifier
	V4:subscription_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 1

HTTP Method: POST

Request

Body

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
  "token": "{{token}}",
 "subscription_identifier" : {"number" : "S0000009993"}
}

Response

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "data": {
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "CommunityA",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "CommunityA",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2019-08-30T08:40:33",
            "updated_date": "2019-09-03T08:17:52",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "dev@crm.com",
                "username": "MPAdministrator"
            }
        },
        "subscription_address": {
            "country": {
                "alternative_code": "CYP",
                "three_character_code": "CYP",
                "name": "CYPRUS",
                "id": "181",
                "two_character_code": "CY"
            },
            "apartment_number": null,
            "care_of": null,
            "is_primary": true,
            "municipality": null,
            "type": "BUSINESS",
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "street_name": "Test",
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "udf_string_15": null,
            "po_box_postal_code": null,
            "udf_string_16": null,
            "udf_string_13": null,
            "udf_string_14": null,
            "udf_string_11": null,
            "udf_string_12": null,
            "id": "26FB447FD675451AA970EE4B5E5608E9",
            "udf_string_10": null,
            "udf_float_1": null,
            "floor": null,
            "udf_float_2": null,
            "udf_string_2": null,
            "area": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "udf_string_1": null,
            "po_box": null,
            "town_city": null,
            "district": null,
            "street_number": "5",
            "postal_code": null,
            "udf_string_6": null,
            "udf_string_7": null,
            "udf_string_8": null,
            "udf_string_9": null
        },
        "owned_by_group": {
            "alternative_code": "MG",
            "name": "Main Group",
            "description": "Main Group ",
            "id": "1",
            "unified_code": "MG"
        },
        "custom_field_set": [],
        "rating_state": "PENDING",
        "expiration_date": null,
        "udf_date_2": null,
        "type": {
            "udf_string_2": null,
            "udf_string_3": null,
            "udf_string_4": null,
            "udf_string_5": null,
            "alternative_code": "normalsub",
            "log_information": {
                "created_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "CommunityA",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "updated_by_unit": {
                    "alternative_code": "adminunit",
                    "group_name": "Main Group",
                    "community_name": "CommunityA",
                    "name": "Admin Unit",
                    "description": "admin unit",
                    "id": "1"
                },
                "created_date": "2016-01-28T19:07:27",
                "updated_date": "2019-05-16T09:05:25",
                "updated_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                },
                "created_by_user": {
                    "person_name": "CRM COM",
                    "id": "1",
                    "email": "dev@crm.com",
                    "username": "MPAdministrator"
                }
            },
            "udf_string_1": null,
            "description": null,
            "udf_date_2": null,
            "udf_date_1": null,
            "udf_date_4": null,
            "udf_date_3": null,
            "udf_float_3": null,
            "udf_float_4": null,
            "name": "Normal",
            "id": "D1BAE6454A2248189EBCD7ADD3B4B65F",
            "udf_string_6": null,
            "udf_float_1": null,
            "udf_string_7": null,
            "udf_float_2": null,
            "udf_string_8": null
        },
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "installed_items_set": [],
        "number": "S0000009993",
        "rated_up_to": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "installed_items_distribution_set": [],
        "first_activated_date": null,
        "termed_services_distribution_set": [
            {
                "subscription_service": {
                    "udf_float_13 ": null,
                    "udf_date_8 ": null,
                    "udf_date_4 ": null,
                    "udf_string_16 ": null,
                    "udf_float_2 ": null,
                    "udf_string_12 ": null,
                    "udf_float_6 ": null,
                    "udf_string_4 ": null,
                    "udf_string_8 ": null,
                    "first_activated_date": null,
                    "udf_date_12 ": null,
                    "id": "A8951180FDDF4D79A1D18BA788336C5A",
                    "udf_date_16 ": null,
                    "udf_float_14 ": null,
                    "udf_date_9 ": null,
                    "udf_string_15 ": null,
                    "udf_float_1 ": null,
                    "udf_float_10 ": null,
                    "udf_date_5 ": null,
                    "udf_string_11 ": null,
                    "udf_float_5 ": null,
                    "udf_date_1 ": null,
                    "rated_up_to_date": null,
                    "life_cycle_state": "DRAFT",
                    "udf_string_1 ": null,
                    "udf_float_9 ": null,
                    "udf_string_5 ": null,
                    "udf_string_9 ": null,
                    "udf_date_13 ": null,
                    "udf_float_15 ": null,
                    "udf_date_6 ": null,
                    "udf_string_14 ": null,
                    "udf_float_11 ": null,
                    "udf_date_2 ": null,
                    "rating_state": "PENDING",
                    "udf_string_10 ": null,
                    "udf_float_4 ": null,
                    "udf_string_2 ": null,
                    "mandatory": false,
                    "udf_float_8 ": null,
                    "udf_string_6 ": null,
                    "udf_date_10 ": null,
                    "service_bundle": null,
                    "udf_date_14 ": null,
                    "free": false,
                    "product": {
                        "code": "Bronze",
                        "product_type": {
                            "meter_reading_type": null,
                            "service_type": "TERMED",
                            "allowed_metadata_attribute_set": [],
                            "used_for_provisioning": true,
                            "alternative_code": "Main Packages",
                            "udr_type": null,
                            "composition_method": "FLAT",
                            "name": "Main Packages",
                            "description": null,
                            "id": "E186E293AAAB49EE86A729540A4287FE",
                            "classification": "SERVICES",
                            "physical_good_type": null
                        },
                        "alternative_code": "B",
                        "description": "Bronze",
                        "id": "F50CC52934BD4F119B6E18E215A4FC55",
                        "priority_level": null
                    },
                    "udf_float_16 ": null,
                    "udf_date_7 ": null,
                    "udf_float_3 ": null,
                    "udf_float_12 ": null,
                    "udf_date_3 ": null,
                    "udf_string_13 ": null,
                    "udf_float_7 ": null,
                    "udf_string_3 ": null,
                    "udf_string_7 ": null,
                    "udf_date_11 ": null,
                    "udf_date_15 ": null
                },
                "provisioning_distributor": {
                    "alternative_code": "I",
                    "name": "Irdeto",
                    "id": "EFD7B1E488C14614A12D1988F5211924"
                },
                "provisioning_distributor_labels": null,
                "id": "010EAF1F458A4814A6896436DF7305BE"
            }
        ],
        "id": "DEAEFCBC74B04DE9A0365F4E7784B9D7",
        "free": false,
        "udf_float_1": null,
        "billing_terms": {
            "payment_preference": null,
            "billing_term_scheme": {
                "billing_method": "PERIOD",
                "code": "Normal Billing Scheme",
                "name": "Normal Billing Scheme",
                "billing_type": "NORMAL",
                "id": "2CCA4F1A694E4BFFBBD2152AB33C3D35",
                "life_cycle_state": "EFFECTIVE",
                "classification": "SUBSCRIPTIONS"
            },
            "is_auto_renewed": true,
            "next_renewal_date": null,
            "expires_on": null,
            "expiration_date": null,
            "billing_frequency": {
                "code": "MONTHLY",
                "name": "Monthly"
            },
            "concurrent_usage_based_pricing": {
                "maximum_capacity": null,
                "concurrent_usage_billing_method": "BASED_ON_NUMBER_OF_INSTALLED_ITEMS"
            },
            "billing_cycle_day": 1,
            "agreement_date": "2019-08-01T00:00:00",
            "effective_date": "2019-08-30T00:00:00",
            "price_plan": null,
            "id": "F38CD070CE9F46ABAF0F55AC0EAA0354",
            "binding_information": {
                "end_date": "2020-08-30T00:00:00",
                "binding_period": {
                    "code": "ANNUAL",
                    "name": "Annual"
                },
                "state": "IN_BINDING",
                "start_date": "2019-08-30T00:00:00"
            }
        },
        "udf_float_2": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "privacy_level": null,
        "udf_string_1": null,
        "termed_services_set": [
            {
                "udf_float_13 ": null,
                "udf_date_8 ": null,
                "udf_date_4 ": null,
                "udf_string_16 ": null,
                "udf_float_2 ": null,
                "udf_string_12 ": null,
                "udf_float_6 ": null,
                "udf_string_4 ": null,
                "udf_string_8 ": null,
                "first_activated_date": null,
                "udf_date_12 ": null,
                "id": "A8951180FDDF4D79A1D18BA788336C5A",
                "udf_date_16 ": null,
                "udf_float_14 ": null,
                "udf_date_9 ": null,
                "udf_string_15 ": null,
                "udf_float_1 ": null,
                "udf_float_10 ": null,
                "udf_date_5 ": null,
                "udf_string_11 ": null,
                "udf_float_5 ": null,
                "udf_date_1 ": null,
                "rated_up_to_date": null,
                "life_cycle_state": "DRAFT",
                "udf_string_1 ": null,
                "udf_float_9 ": null,
                "udf_string_5 ": null,
                "udf_string_9 ": null,
                "udf_date_13 ": null,
                "udf_float_15 ": null,
                "udf_date_6 ": null,
                "udf_string_14 ": null,
                "udf_float_11 ": null,
                "udf_date_2 ": null,
                "rating_state": "PENDING",
                "udf_string_10 ": null,
                "udf_float_4 ": null,
                "udf_string_2 ": null,
                "mandatory": false,
                "udf_float_8 ": null,
                "udf_string_6 ": null,
                "udf_date_10 ": null,
                "service_bundle": null,
                "udf_date_14 ": null,
                "free": false,
                "product": {
                    "code": "Bronze",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": "TERMED",
                        "allowed_metadata_attribute_set": [],
                        "used_for_provisioning": true,
                        "alternative_code": "Main Packages",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Main Packages",
                        "description": null,
                        "id": "E186E293AAAB49EE86A729540A4287FE",
                        "classification": "SERVICES",
                        "physical_good_type": null
                    },
                    "alternative_code": "B",
                    "description": "Bronze",
                    "id": "F50CC52934BD4F119B6E18E215A4FC55",
                    "priority_level": null
                },
                "udf_float_16 ": null,
                "udf_date_7 ": null,
                "udf_float_3 ": null,
                "udf_float_12 ": null,
                "udf_date_3 ": null,
                "udf_string_13 ": null,
                "udf_float_7 ": null,
                "udf_string_3 ": null,
                "udf_string_7 ": null,
                "udf_date_11 ": null,
                "udf_date_15 ": null
            }
        ],
        "accounts_receivable": {
            "number": "ACR0000014201",
            "name": "ACR0000014201 Test  30082019_01",
            "id": "1B13777B4D4544F990615F4971F34A24",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Test  30082019_01",
                "last_name": "30082019_01",
                "id": "17DBA78EF932418F89FF9C241B5F0C28",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Test",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "30082019_01",
                    "passport_number_expiration_date": null,
                    "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
                    },
                    "id_number_expiration_date": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "life_cycle_state": "DRAFT",
        "expense_services_set": [],
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 2

New Version Current

Key