Page Comparison

...

This method is setting an Effective subscription in short-term deactivation period. The method can be applied on a single subscription only

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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

...

accounts_receivable_identifier

(semi-optional)

...

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

...

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)

...

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

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription action type

name

(semi-optional)

String

The name of the subscription action type

alternative_code

(semi-optional)

String

The alternative code of the subscription action type

...

sub_action_type_identifier

(optional)

...

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

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription sub action type

name

(semi-optional)

String

The name of the subscription sub action type

alternative_code

(semi-optional)

String

The alternative code of the subscription sub action type

...

end_short_term_deactivation_on

(semi-optional)

...

end_short_term_deactivation_after_specific_days

(semi-optional)

...

transaction_reference_number

(optional)

...

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)

...

Excerpt
This method is setting an Effective subscription in short-term deactivation period. The method can be applied on a single subscription only

Resource URL

Parameters

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:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

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:

user

accounts_receivable_identifier_post
	V4:

user

accounts_receivable_identifier

performed_by_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)

Unit Identifier

Subscription action type identifier

The

unit that performed the action

action type that should be used. The allowed

unit

performed_on

(optional)

DateThe date that the action was actually performed

billing_effective_date

(optional)

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

billable_period_start_date

(optional)

DateDetermines 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

subscription action type identifier fields are the following:

Include PageV4:unit_identifierV4:unit_identifier

Tip
Available from CRM.COM R14.0.0

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription action type

name

(semi-optional)

String

The name of the subscription action type

alternative_code

(semi-optional)

String

The alternative code of the subscription action type

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:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription sub action type

name

(semi-optional)

String

The name of the subscription sub action type

alternative_code

(semi-optional)

String

The alternative code of the subscription sub action type

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

end_short_term_deactivation_on

(semi-optional)

Date

The date that the short term deactivation period should end. End short term deactivation on date is mandatory unless end short term deactivation after specific days is specified. It is not allowed to specify both information

end_short_term_deactivation_after_specific_days

(semi-optional)

Number

It defines the date that the short term deactivation period should end, based on the date that the subscription will go into short term deactivation and the specified number of days. End short term deactivation after specific days is mandatory unless end short term deactivation on date is specified. It is not allowed to specify both information

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

R10

R14.0.0

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
  "token":"2D5C85BD2B0B4131B3F754757BFADA5A",
  "subscription_identifier":{"number":"S60113"},
  "end_short_term_deactivation_after_specific_days":3,
}

Response:

...

theme	Confluence
language	javascript
linenumbers	true

...

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:business_unit_identifier
	V4:business_unit_identifier

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 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

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 R15.0.0

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.

Response Data

Include Page

	V4:subscription_action_short
	V4:subscription_action_short

Examples

Expand

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 {
  "token":"2D5C85BD2B0B4131B3F754757BFADA5A",
  "subscription_identifier":{"number":"S60113"},
  "end_short_term_deactivation_after_specific_days":3,
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

 
      {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-04-24T14:37:06",
        "action_type": null,
        "submitted_on": "2015-04-24T14:37:06",
        "sub_action_type": null,
        "business_classification_code": "SHORT_TERM_DEACTIVATION",
        "number": "955",
        "executed_on": "2015-04-24T14:37:08",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "behavior_code": "SHORT_TERM_DEACTIVATION",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1"
        },
        "id": "8C7BDEB3BBB5462887FEDEB626225DD4",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Pickman",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Li",
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Jessie",
                    "name": "Jessie Pickman",
                    "id": "F9A629E466B1EF473CECD46F2A4D63F3",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "MALE",
                        "passport_issued_by_country":
                        {
                            "name": "UNITED STATES",
                            "id": "127"
                        },
                        "passport_number": "54567432",
                        "social_security_number": "434567",
                        "country_of_residence":
                        {
                            "name": "UNITED STATES",
                            "id": "127"
                        },
                        "industry_sector":
                        {
                            "name": "FINANCIALS",
                            "id": "03EA93890F51506ABD9E994CD826EC78",
                            "alternative_code": "FIN"
                        },
                        "date_of_birth":
                        {
                            "month": 11,
                            "day": 1,
                            "messageyear": null,1988
        "description": null,         "code": "OK"     },
        "data":       {         "scheduledname_dateday": "2015-04-24T14:37:06",
                       "action_type": null, {
        "submitted_on": "2015-04-24T14:37:06",         "sub_action_type": null,         "business_classification_codemonth": "SHORT_TERM_DEACTIVATION"4,
        "number": "955",         "executed_on": "2015-04-24T14:37:08",         "life_cycle_stateday": "EXECUTED", 2
            "performed_by":         {   },
         "person_name": "Marios Lannister",             "usernameid_number": "MPAdministrator983452",
            "id": "1"         },  "id_issued_by_country":
      "behavior_code": "SHORT_TERM_DEACTIVATION",         "submitted_by":        {
{             "person_name": "Marios Lannister",             "usernamename": "MPAdministratorUNITED STATES",
            "id": "1"         },         "id": "8C7BDEB3BBB5462887FEDEB626225DD4",127"
             "subscription":         {  },
          "accounts_receivable":             { "industry":
               "account_owner":         {
       {                     "last_name": "PickmanMarketing",
                            "life_cycle_stateid": "FINANCIAL31BC2070C79EAE5455BFAD41599C5190",
                       "middle_name     "code": "Li",MK"
                        }
      "company_profile": null,              }
           "title": "Mr",    },
                "typelife_cycle_state": "PERSONACTIVE",
   
                "first_namenumber": "Jessie170",
                    "name": "Jessie PickmanJessie01",
   
                "id": "F9A629E466B1EF473CECD46F2A4D63F3",903B55B02EAC74FE25E12F8786D44011"
            },
            "companylife_cycle_namestate": null"SHORT_TERM_NOT_EFFECTIVE",
            "number": "S60113",
      "demographics":      "type":
            {
         {       "udf_float_1": null,
                "genderudf_float_2": "MALE"null,
                "udf_date_1": null,
        "passport_issued_by_country        "udf_float_3": null,
                "udf_date_2": null,
     {           "udf_float_4": null,
                "nameudf_date_3": "UNITED STATES",null,
                "udf_date_4": null,
                "idudf_string_1": "127"null,
                "name": "United Kingdom",
         },       "udf_string_2": null,
                "passportudf_string_number3": "54567432"null,
                "udf_string_4": null,
      "social_security_number": "434567",          "udf_string_5": null,
                "countryudf_ofstring_residence6": null,
                "log_information":
      {          {
                    "nameupdated_date": "UNITED STATES2015-02-20T16:40:42",

                           "id": "127""created_by_unit":
                        },{
                        "industry_sectorname": "Admin Unit",
                      {    "id": "48305F8849E3C18B227C5BE3A27BA6DF",
                        "namedescription": "FINANCIALSr1",
                            "id"alternative_code": "03EA93890F51506ABD9E994CD826EC78MG",
                    },
          "alternative_code": "FIN"         "created_date": "2014-06-25T15:44:04",
              },      "updated_by_unit":
                  "date_of_birth":  {
                      {  "name": "Admin Unit",
                        "monthid": 11,
   "48305F8849E3C18B227C5BE3A27BA6DF",
                        "daydescription": 1,
  "r1",
                         "yearalternative_code": 1988
   "MG"
                    },
   
                    "nameupdated_by_dayuser":
                        {
 
                          "monthperson_name": 4"g_kountouri",
                        "username": "g_kountouri",
   "day": 2                    "id": "B0CF852BA7364BC6887E00F570903FFD"
   },                 }
       "id_number": "983452",        },
                "idudf_issuedstring_by_country7": null,
                "udf_string_8": null,
     {           "id": "1C81FBB1E5D90040F440ECE98D6A368D",
                 "namedescription": "UNITEDUnited STATESKingdom",
                "alternative_code": "UK"
          "id": "127"  },
            "id": "DD63DE1F000DD453F3780731904D8307"
        },
        "performed_on": "2015-04-24T14:37:06"
              "industry":
       }
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
	"token": {{token}},
	"subscription_identifier": {
    	"number"  : "S0000000008"
    },
    "end_short_term_deactivation_after_specific_days": 1,
    "performed_by_unit_identifier": {
    	"alternative_code": "UA"
      }
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "data":  {
        "nameperformed_by": "Marketing"null,
              "action_type": {
             "idalternative_code": "31BC2070C79EAE5455BFAD41599C5190STD",
            "name": "SHORT TERM DEACTIVATION",
            "codeid": "MKD715F8BCBEC44F8191DEFE6B27BF9521"
        },
        "transaction_reference_number": null,
     }   "submitted_by": {
            "person_name": "CRM COM",
 }                 },
  "id": "1",
             "life_cycle_stateusername": "ACTIVEMPAdministrator",
        },
        "numberexecuted_on": "1702017-09-25T10:19:46",
        "life_cycle_state": "EXECUTED",
        "namesubscription": "Jessie01",
   {
            "idnumber": "903B55B02EAC74FE25E12F8786D44011S0000000008",
             }"first_activated_date": "2016-02-09T13:15:55",
            "life_cyclerating_state": "SHORT_TERM_NOT_EFFECTIVEPENDING",
            "numberaccounts_receivable": "S60113", {
                "typenumber": "ACR0000000009",
                "name":  {"NOVO CASA FOR PREPAID",
                "udf_float_1id": null"67432618BF6B4D8099452E750A239750",
                "udflife_floatcycle_2state": null"ACTIVE",
                "udfaccount_date_1owner": {
   null,                 "udfcompany_float_3profile": null,{
                        "udftax_datereference_2number": null"av123443556",
                "udf_float_4        "registered_in_country": null,
                        "udfnumber_dateof_3employees": null,
                        "udfannual_date_4turnover": null,
                        "udfprofile_string_1year": null,2000,
                        "nameregistration_number": "United Kingdom",sda21w123123",
                        "udfvat_stringregistration_2number": null"2312321321",
                "udf_string_3        "industry_sector": null,
                        "udf_string_4industry": null,
                        "udfestablished_string_5date": null,
                  "udf_string_6      "vat_registered_by": null,
                        "logvat_registration_informationdate": null
                 {   },
                    "updatedcompany_datename": "2015-02-20T16:40:42NOVO CASA",
                    "created_by_unitname": "NOVO CASA",
                  {  "last_name": null,
                     "nameid": "Admin Unit76F9993673024885966C7B0B4DA20E29",
   
                    "idlife_cycle_state": "48305F8849E3C18B227C5BE3A27BA6DFFINANCIAL",
 
                      "descriptionmiddle_name": "r1",
   null,
                    "alternative_codetitle": "MG"null,
                    }"type": "COMPANY",
                    "createdfirst_datename": "2014-06-25T15:44:04"null,
                    "updated_by_unitdemographics": null
                }
  {           },
             "nameid": "Admin Unit57C9FA9E11DF47EAA6D9B0BD8FDD6280",
            "life_cycle_state": "SHORT_TERM_NOT_EFFECTIVE",
            "idtype": "48305F8849E3C18B227C5BE3A27BA6DF", {
                "alternative_code": "normalsub",
                "descriptionname": "r1Normal",
                "description": null,
                "alternative_codeid": "MGD1BAE6454A2248189EBCD7ADD3B4B65F"
            }
        },
          "scheduled_date": "2017-09-25T10:19:46",
         "updatedperformed_by_useron": null,
        "sub_action_type": {
          {  "alternative_code": "STD",
            "name": "SHORT TERM DEACTIVATION",
     "person_name": "g_kountouri",      "id": "41B317CB207D4D4BBE97D1B454852EED"
        },
        "usernamebusiness_classification_code": "gSHORT_TERM_kountouriDEACTIVATION",
        "number": "24295",
        "submitted_on": "2017-09-25T10:19:46",
        "id": "B0CF852BA7364BC6887E00F570903FFDC6C78EFA54B24EE48B378949A4556116",
        "job": null,
        "behavior_code": "SHORT_TERM_DEACTIVATION",
    }    "performed_by_unit": {
           },
    "alternative_code": "UA",
            "udfgroup_string_7name": null,
  "GroupA",
             "udfcommunity_string_8name": null,
  "CommunityA",
             "idname": "1C81FBB1E5D90040F440ECE98D6A368DUnit A",
 
              "description": "United Kingdom",
  null,
             "alternative_codeid": "UK72CD6EBE88E541CA879BBA9ECBA11E68"
        }
    },
    "status": {
        "idcode": "DD63DE1F000DD453F3780731904D8307OK",
         }"description": "",
        "performed_onmessage": "2015-04-24T14:37:06"
    }
}

Versions Compared

Old Version 10

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples