Page Comparison

...

This method is ending the short term activation period of a specific subscription. This method can be applied only on subscription in Short Term Effective life cycle state. 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

...

transaction_reference_number

(optional)

...

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

...

Excerpt
This method is ending the short term activation period of a specific subscription. This method can be applied only on subscription in Short Term Effective life cycle state. 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

performed_by_user_

the subscription_identifier is mandatory

accounts_receivable_identifier

(semi-optional)

User identifier

Accounts Receivable Identifier

The

user that actually performed the action

accounts receivable identifier that can be used to perform the subscription modification. The allowed

user

accounts receivable identifier fields are the following:

Include Page

	V4:

user

accounts_receivable_identifier_post
	V4:

user

accounts_receivable_identifier

performed_by_unit_identifier

(optional)

Unit Identifier

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

Include PageV4:unit_identifierV4: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

R14

R13.0.0

performed

action_type_

on

identifier

(optional)

Date

Subscription action type identifier

The

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

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

Tip
Deprecated from CRM.COM

R12

R15.

1

0.0

.

udf

sub_action_

string

type_

1

udf_string_2

(

identifier

(optional)

String

User Defined Field of type String

udf_string_3

(

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

User Defined Field of type String

udf_string_4

(

The ID of the subscription sub action type

name

(semi-optional)

String

User Defined Field of type String

udf_string_5

The name of the subscription sub action type

alternative_code

(semi-optional)

String

User Defined Field of type String

The alternative code of the subscription sub action type

Tip
Deprecated from CRM.COM R15.0.0

classification_identifier

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7udf_string_8

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

transaction_reference_number

(optional)

String

User Defined Field of type 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)

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

...

Examples

...

title	Example 1

HTTP Method: POST

Request:

Body:

Code Block

theme	Confluence
language	javascript
linenumbers	true

 {
 "token": "D10FEF73C8094F4E87B592C142DAC91F",
 "subscription_identifier":{"id":"41C6A0AC2C9538DDED4B3CB25E72C6A7"}
}

Response:

...

theme	Confluence
language	javascript
linenumbers	true

...

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

Tip
Deprecated from CRM.COM R12.1.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": "D10FEF73C8094F4E87B592C142DAC91F",
 "subscription_identifier":{"id":"41C6A0AC2C9538DDED4B3CB25E72C6A7"}
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

     {
       "status":
       {
           "message": null,
           "description": null,
           "code": "OK"
       },
       "data":
       {
           "scheduled_date": "2015-04-29T13:13:22",
           "action_type": null,
           "submitted_on": "2015-04-29T13:13:22",
           "sub_action_type": null,
           "business_classification_code": "END_SHORT_TERM_SUB_ACTIVATION",
           "number": "978",
           "executed_on": "2015-04-29T13:13:22",
           "life_cycle_state": "EXECUTED",
           "performed_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "behavior_code": "END_SHORT_TERM_SUB_ACTIVATION",
           "submitted_by":
           {
               "person_name": "Marios Lannister",
               "username": "MPAdministrator",
               "id": "1"
           },
           "id": "0CBFEDF373E742608266CF04AA0D2D63",
           "subscription":
           {
               "accounts_receivable":
               {
                   "account_owner":
                   {
                       "last_name": "McMillan",
                       "life_cycle_state": "FINANCIAL",
                       "middle_name": null,
                       "company_profile": null,
                       "title": null,
                       "type": "PERSON",
                       "first_name": "Adrew",
                       "name": "Adrew McMillan",
                       "id": "403B55EA7311D3C9543C7D3B4D4682ED",
                       "company_name": null,
                       "demographics":
                       {
                           "gender": "MALE",
                           "passport_issued_by_country":
                           {
                               "name": "UNITED KINGDOM",
                               "id": "126"
                           },
                           "passport_number": "943030",
                           "social_security_number": "940321",
                           "country_of_residence":
                           {
                               "name": "UNITED KINGDOM",
                               "id": "126"
                           },
                           "industry_sector":
                           {
                               "name": "EDUCATION",
                               "id": "AF6E0855324153EAB8B582A277147BCE",
                               "alternative_code": "1"
                           },
                           "date_of_birth":
                           {
                               "month": 5,
                               "day": 8,
                               "year": 1982
                           },
                           "name_day":
                           "message": null,{
              "description": null,            "code": "OK"   "month": null,
   },        "data":        {            "scheduled_dateday": "2015-04-29T13:13:22", null
             "action_type": null,            "submitted_on": "2015-04-29T13:13:22", },
              "sub_action_type": null,            "businessid_classification_codenumber": "END_SHORT_TERM_SUB_ACTIVATION987908",
              "number": "978",            "executed_on": "2015-04-29T13:13:22",id_issued_by_country":
                  "life_cycle_state": "EXECUTED",        {
   "performed_by":            {                "person_name": "MariosUNITED LannisterKINGDOM",
               "username": "MPAdministrator",                "id": "1"126"
                           },
              "behavior_code": "END_SHORT_TERM_SUB_ACTIVATION",            "submitted_byindustry":
           {                "person_name": "Marios Lannister",{
                 "username": "MPAdministrator",                "idname": "1Marketing",
              },                 "id": "0CBFEDF373E742608266CF04AA0D2D6331BC2070C79EAE5455BFAD41599C5190",
           "subscription":               {     "code": "MK"
         "accounts_receivable":                {  }
                 "account_owner":      }
               {    },
                   "lastlife_cycle_namestate": "McMillanACTIVE",
  
                    "life_cycle_statenumber": "FINANCIAL177",
  
                    "middle_name": null,"Adrew McMillan Premium Account",
                    "company_profileid": null,"4607A5CE055BA55E2E0DDD6527EDA99B"
               },
       "title": null,       "life_cycle_state": "NOT_EFFECTIVE",
               "typenumber": "PERSONS60143",
               "type":
       "first_name": "Adrew",         {
              "name": "Adrew McMillan",   "udf_float_1": null,
                   "idudf_float_2": "403B55EA7311D3C9543C7D3B4D4682ED"null,
 
                     "companyudf_date_name1": null,
                   "udf_float_3": null,
  "demographics":                 "udf_date_2": null,
     {              "udf_float_4": null,
              "gender": "MALE",        "udf_date_3": null,
                   "passportudf_issueddate_by_country4": null,
                   "udf_string_1": null,
     {              "name": "United Kingdom",
                   "nameudf_string_2": "UNITED KINGDOM"null,
                   "udf_string_3": null,
          "id": "126"            "udf_string_4": null,
              },       "udf_string_5": null,
                    "passportudf_string_number6": "943030",
      null,
                    "sociallog_security_numberinformation":
"940321",                   {
        "country_of_residence":               "updated_date": "2015-02-20T16:40:42",
           {              "created_by_unit":
                 "name": "UNITED KINGDOM",    {
                           "idgroup_name": "126"Main Group",
                           "name": "Admin }Unit",
                           "industry_sectorid": "48305F8849E3C18B227C5BE3A27BA6DF",
                          {   "description": "r1",
                            "namealternative_code": "EDUCATIONMG",
                       },
          "id": "AF6E0855324153EAB8B582A277147BCE",            "created_date": "2014-06-25T15:44:04",
                  "alternative_code": "1"    "updated_by_unit":
                       },{
                           "dategroup_of_birthname": "Main Group",
                         {  "name": "Admin Unit",
                           "monthid": 5"48305F8849E3C18B227C5BE3A27BA6DF",

                              "daydescription": 8,
  "r1",
                            "yearalternative_code": 1982"MG"
                       }
   },                },
           "name_day":        "udf_string_7": null,
                  {
  "udf_string_8": null,
                   "id": "1C81FBB1E5D90040F440ECE98D6A368D",
        "month": null,          "description": "United Kingdom",
                   "dayalternative_code": null"UK"
               },
           },    "id": "41C6A0AC2C9538DDED4B3CB25E72C6A7"
           },
           "idperformed_numberon": "987908",2015-04-29T13:13:18"
       }
                   "id_issued_by_country":
}

Expand

title	Example 2

HTTP Method: POST

Request:

Body:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
	"token": {{token}},
	"subscription_identifier": {
    	"number"  : "S0000000008"
    },
             "action_type_identifier": {
    	"name": "END SHORT TERM ACTIVATION"
    },
    "sub_action_type_identifier": {
           	"name": "UNITED KINGDOM",
              "END SHORT TERM ACTIVATION"	
    },
    "performed_by_unit_identifier": {
      "id	"alternative_code": "126UC"
    }
}

Response:

Code Block

language	javascript
theme	Confluence
linenumbers	true

{
    "data": {
        "performed_by": null,
        "action_type": {
},               "alternative_code": "end_short_term_activation_action",
            "industryname": "END SHORT TERM ACTIVATION",
            "id": "E3BEA06A9D074764A8A8971E9AFC14EC"
        },
{        "transaction_reference_number": null,
        "submitted_by": {
            "person_name": "MarketingCRM COM",
                               "id": "31BC2070C79EAE5455BFAD41599C51901",
            "username": "MPAdministrator"
        },
        "codeexecuted_on": "MK"
      2017-09-25T10:58:25",
        "life_cycle_state": "EXECUTED",
        "subscription": {
}            "number": "S0000000008",
          }  "first_activated_date": "2016-02-09T13:15:55",
                },
      "rating_state": "PENDING",
            "lifeaccounts_cycle_statereceivable": "ACTIVE",
{
                  "number": "177ACR0000000009",
 ,
                 "name": "AdrewNOVO McMillanCASA PremiumFOR AccountPREPAID",
  
                "id": "4607A5CE055BA55E2E0DDD6527EDA99B"
    67432618BF6B4D8099452E750A239750",
          },                "life_cycle_state": "NOT_EFFECTIVEACTIVE",
                "numberaccount_owner": "S60143",{
               "type":     "company_profile": {
         {                    "udftax_floatreference_1number": null,"av123443556",
                        "udfregistered_floatin_2country": null,
                        "udfnumber_dateof_1employees": null,
                        "udfannual_float_3turnover": null,
                        "udfprofile_date_2year": null2000,
                        "udfregistration_float_4number": null"sda21w123123",
                        "udfvat_dateregistration_3number": null"2312321321",
                        "udfindustry_date_4sector": null,
                        "udf_string_1industry": null,
                    "name": "United Kingdom",    "established_date": null,
                        "udfvat_stringregistered_2by": null,
                        "udfvat_stringregistration_3date": null,
                   "udf_string_4": null },
                    "udfcompany_string_5name": null"NOVO CASA",
                    "udf_string_6name": null"NOVO CASA",
                    "loglast_informationname": null,
                  {  "id": "76F9993673024885966C7B0B4DA20E29",
                    "updated_date": "2015-02-20T16:40:42",
 life_cycle_state": "FINANCIAL",
                     "createdmiddle_by_unitname": null,
                    "title": null,
{                            "group_name"type": "Main GroupCOMPANY",

                          ""first_name": "Admin Unit",
  null,
                        "iddemographics": "48305F8849E3C18B227C5BE3A27BA6DF",null
                }
           "description": "r1" },
            "id": "57C9FA9E11DF47EAA6D9B0BD8FDD6280",
             "alternativelife_cycle_codestate": "MGNOT_EFFECTIVE",
            "type": {
          },      "alternative_code": "normalsub",
                "created_datename": "2014-06-25T15:44:04Normal",
  
                    "updated_by_unit"description": null,
                "id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
    {        }
        },
          "groupscheduled_namedate": "Main Group",
                 2017-09-25T10:58:24",
         "nameperformed_on": "Admin Unit"null,
             "sub_action_type": {
             "idalternative_code": "48305F8849E3C18B227C5BE3A27BA6DFend_short_term_act_subaction",
            "name": "END SHORT TERM ACTIVATION",
            "descriptionid": "r159CEF2CF24154A12A060E32595CD74F1",
        },
        "business_classification_code": "END_SHORT_TERM_ACTIVATION",
        "alternative_codenumber": "MG24307",
        "submitted_on": "2017-09-25T10:58:24",
        "id": "ED3519C6A32741DDABAD29AFB1B9418E",
   }     "job": null,
        "behavior_code": "END_SHORT_TERM_ACTIVATION",
   },       "performed_by_unit": {
            "udfalternative_string_7code": null,
      "UC",
            "udf_string_8": null,
      group_name": "Group C",
            "idcommunity_name": "1C81FBB1E5D90040F440ECE98D6A368DCommunity C",
            "name": "Unit C",
    "description": "United Kingdom",      "description": null,
            "alternative_codeid": "UK79D99D242650451DBFB5AD5858D405FB"
          }
    },
    "status":  {
        "idcode": "41C6A0AC2C9538DDED4B3CB25E72C6A7OK",
           },
  "description": "",
        "performed_onmessage": "2015-04-29T13:13:18"
       }
   
}

Versions Compared

Old Version 9

New Version Current

Key

Resource URL

Parameters

Resource URL

Parameters

Restrictions

Response Data

Examples

Restrictions

Response Data

Examples