Page Comparison

Versions Compared

Key

This line was added.
This line was removed.
Formatting was changed.

Excerpt
This method is deactivating an effective subscription. The method can be applied on a single subscription only

...

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

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

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

performed_on

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 answers to the question “from which date should I start billing this service) that is affected by the subscription action.

scheduled_date

(optional)

Date

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately

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

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

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 2

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token":"FF129D2E08124E2AA268C946DFDAE23E",
    "subscription_identifier" :    {"number"  : "S60948"},
    "fields_set":"number,action_type,performed_by,sub_action_type,subscription,job",
    "scheduled_date": "2016-09-15T15:49:59"
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": null,
    "sub_action_type": null,
    "performed_by": null,
    "number": "4331",
    "job": null,
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Tz",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": null,
          "first_name": "Ek",
          "type": "PERSON",
          "id": "15D4F07E221E44088CDE00A96DB1A250",
          "name": "Tz Ek",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": "18181818",
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "CYP",
              "two_character_code": "CY",
              "id": "181",
              "name": "CYPRUS",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": null,
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000929",
        "id": "0DA7BAB9909E49828BB84079AA588AF8",
        "name": "ACR000929"
      },
      "number": "S60948",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "F6E57574F61B406B974FFFE2E091B0C5",
      "first_activated_date": "2016-06-09T15:01:03",
      "rating_state": "PENDING"
    }
  }
}

Expand

title	Example 3

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "token": {{token}},
    "subscription_identifier": {
    	"number"  : "S0000000008"
    },
    "action_type_identifier": {
    	"name": "Deactivate Normal Subscriptions"
    },
    "sub_action_type_identifier": {
    	"name": "Deactivate Normal Subscription"
    },
    "performed_by_unit_identifier": {
    	"alternative_code": "UC"
    }
}

Response:

Code Block

theme	Confluence
language	javascript
linenumbers	true

{
    "data": {
        "performed_by": null,
        "action_type": {
            "alternative_code": "DNS",
            "name": "Deactivate Normal Subscriptions",
            "id": "FD2D0EE314F9492788A13FFDBA482793"
        },
        "transaction_reference_number": null,
        "submitted_by": {
            "person_name": "CRM COM",
            "id": "1",
            "username": "MPAdministrator"
        },
        "executed_on": "2017-09-21T11:20:19",
        "life_cycle_state": "EXECUTED",
        "subscription": {
            "number": "S0000000008",
            "first_activated_date": "2016-02-09T13:15:55",
            "rating_state": "PENDING",
            "accounts_receivable": {
                "number": "ACR0000000009",
                "name": "NOVO CASA FOR PREPAID",
                "id": "67432618BF6B4D8099452E750A239750",
                "life_cycle_state": "ACTIVE",
                "account_owner": {
                    "company_profile": {
                        "tax_reference_number": "av123443556",
                        "registered_in_country": null,
                        "number_of_employees": null,
                        "annual_turnover": null,
                        "profile_year": 2000,
                        "registration_number": "sda21w123123",
                        "vat_registration_number": "2312321321",
                        "industry_sector": null,
                        "industry": null,
                        "established_date": null,
                        "vat_registered_by": null,
                        "vat_registration_date": null
                    },
                    "company_name": "NOVO CASA",
                    "name": "NOVO CASA",
                    "last_name": null,
                    "id": "76F9993673024885966C7B0B4DA20E29",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "title": null,
                    "type": "COMPANY",
                    "first_name": null,
                    "demographics": null
                }
            },
            "id": "57C9FA9E11DF47EAA6D9B0BD8FDD6280",
            "life_cycle_state": "NOT_EFFECTIVE",
            "type": {
                "alternative_code": "normalsub",
                "name": "Normal",
                "description": null,
                "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
            }
        },
        "scheduled_date": "2017-09-21T11:20:19",
        "performed_on": null,
        "sub_action_type": {
            "alternative_code": "DNS",
            "name": "Deactivate Normal Subscription",
            "id": "F0EF31A63E934F32A3C181C0395C9536"
        },
        "business_classification_code": "DEACTIVATE_SUBSCRIPTION",
        "number": "24259",
        "submitted_on": "2017-09-21T11:20:19",
        "id": "38A341A830EC4B9B80FC8B5A93E941A8",
        "job": null,
        "behavior_code": "DEACTIVATE_SUBSCRIPTION",
        "performed_by_unit": {
            "alternative_code": "UC",
            "group_name": "Group C",
            "community_name": "Community C",
            "name": "Unit C",
            "description": null,
            "id": "79D99D242650451DBFB5AD5858D405FB"
        }
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}