Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

It stops one or multiple effective subscription services from a specific subscription

Resource URL

Parameters


Excerpt

It stops one or multiple effective subscription services from a specific subscription

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:

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

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:

Include Page
V4:subscription_sub_action_type_identifier
V4:subscription_sub_action_type_identifier

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

_sub

_action_

type

classification_identifier

Tip

Available from CRM.COM R18.0.0


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

_identifierV4:user_identifier

_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

R14

R18.0.0


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

 

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

services_set

(mandatory)

Set of subscription service objectsThe services that will be stopped

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



Anchor
services_stop referred objects parameters
services_stop referred objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
language
languagejavascript
themeConfluence
javascriptlinenumberstrue
{
    "token":"16AFA54B31AF441C8379D4AD45BF7447",
   "subscription_identifier":{"number":"S60315"},
     "action_type_identifier":{"alternative_code":"SS"},
    "performed_by_user_identifier":{"username":"jackH"},
    "performed_on":"2014-07-18T05:07:41",
    "billing_effective_date" : "2014-07-18T05:07:41",
    "billable_period_start_date":"2014-07-18T05:07:44",
    "services_set" :[
        {  
            "service_identifier" : { "code" : "Sports 2" }
        }
    ]
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "scheduled_date": "2015-03-19T15:01:47",
        "action_type":
        {
            "name": "Stop Service",
            "id": "EBF0C5E6A68A404AA9ED381CCA042F42",
            "alternative_code": "SS"
        },
        "submitted_on": "2015-03-19T15:01:47",
        "sub_action_type": null,
        "business_classification_code": "STOP_SERVICE",
        "number": "763",
        "executed_on": "2015-03-19T15:01:48",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Jack Hadjicosti",
            "username": "JackH",
            "id": "B8650C555C4EA8C741103961276E7773",
            "email": "j_hadjicosti@crm.com"
        },
        "behavior_code": "STOP_SERVICE",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "mpadministrator",
            "id": "1"
        },
        "id": "A5B7275E13A144E5AD6EEC830C401EB3",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Papapavlou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": "Andreas",
                    "company_profile": null,
                    "title": "Ms",
                    "type": "PERSON",
                    "first_name": "Lucia",
                    "name": "Lucia Papapavlou",
                    "id": "1D92B269658D80DEDF2499E25201739E",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": "FEMALE",
                        "passport_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "passport_number": "113115",
                        "social_security_number": "113116",
                        "country_of_residence":
                        {
                            "name": "UNITED KINGDOM",
                            "id": "126"
                        },
                        "industry_sector":
                        {
                            "name": "GOVERNMENTAL",
                            "id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
                            "alternative_code": "GOV"
                        },
                        "date_of_birth":
                        {
                            "month": 1,
                            "day": 1,
                            "year": 1990
                        },
                        "name_day":
                        {
                            "month": 5,
                            "day": 5
                        },
                        "id_number": "113114",
                        "id_issued_by_country":
                        {
                            "name": "GREECE",
                            "id": "209"
                        },
                        "industry":
                        {
                            "name": "Interior Design",
                            "id": "06B638258885DA26FA2BD40D9128D04E",
                            "code": "INTDS"
                        }
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "437",
                "name": "Change API Acount",
                "id": "AD428A613F5CF0571EA8D1345CE9E450"
            },
            "life_cycle_state": "EFFECTIVE",
            "number": "S60315",
            "type":
            {
                "name": "London",
                "id": "3100B0D56E7C7EADF073C34BCE1E42AF",
                "description": "For Subscribers residing in London
",
                "alternative_code": "LND"
            },
            "id": "59D30407589847498957D7E570FAC0BB"
        },
        "performed_on": "2014-07-18T05:07:41"
    }
}


...

Expand
titleExample 2

HTTP Method: POST

 


Request:

Body:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
    "token":"16AFA54B31AF441C8379D4AD45BF7447",
  "fields_set":"submitted_by,subscription,sub_action_type,job,action_type",
    "subscription_identifier":{
        "number":"S60708"
    },
     "action_type_identifier":{"alternative_code":"SERVSTOP"},
       "sub_action_type_identifier":{"alternative_code":"SERVSTOPS"},
    "performed_by_user_identifier":{"username":"jackH"},
    "performed_on":"2014-07-18T05:07:41",
    "billing_effective_date" : "2014-07-18T05:07:41",
    "billable_period_start_date":"2014-07-18T05:07:44",
    "services_set" :[
        { 
            "service_identifier" : { "code" : "Gold" }
        }
    ]
}


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
{
  "status": {
    "message": "",
    "description": "",
    "code": "OK"
  },
  "data": {
    "action_type": {
      "id": "BB15C0B53F5675133240F6FED1047345",
      "name": "Stop Service",
      "alternative_code": "SERVSTOP"
    },
    "sub_action_type": {
      "id": "56B60268B8D74D2C5AD91A70908CAEBB",
      "name": "Stop Service",
      "alternative_code": "SERVSTOPS"
    },
    "submitted_by": {
      "person_name": "Marios Lannister",
      "username": "MPAdministrator",
      "id": "1",
      "email": "sakkascy1986@hotmail.com"
    },
    "job": null,
    "subscription": {
      "life_cycle_state": "EFFECTIVE",
      "accounts_receivable": {
        "account_owner": {
          "last_name": "Mika",
          "middle_name": null,
          "life_cycle_state": "FINANCIAL",
          "company_profile": null,
          "title": "Ms",
          "first_name": "Dina",
          "type": "PERSON",
          "id": "9ED00E7228634EF986807DF4D86A3F84",
          "name": "Mika Dina",
          "company_name": null,
          "demographics": {
            "gender": null,
            "passport_issued_by_country": null,
            "social_security_number": null,
            "passport_number": null,
            "industry_sector": null,
            "country_of_residence": {
              "three_character_code": "USA",
              "two_character_code": "US",
              "id": "127",
              "name": "UNITED STATES",
              "alternative_code": null
            },
            "name_day": {
              "month": null,
              "day": null
            },
            "date_of_birth": {
              "month": null,
              "day": null,
              "year": null
            },
            "id_number": "14587522",
            "industry": null,
            "id_issued_by_country": null
          }
        },
        "life_cycle_state": "ACTIVE",
        "number": "ACR000525",
        "id": "C8A54A6BB4B9423AA560D6B955CD1271",
        "name": "Dina Mika"
      },
      "number": "S60708",
      "type": {
        "id": "D433A85FB6CD4880A1BCEEB1E164EFA4",
        "name": "London",
        "description": "Subscription for London customers",
        "alternative_code": "LND"
      },
      "id": "C9EE8F9CC81143538BE2462684D04733",
      "first_activated_date": "2016-02-18T14:42:41",
      "rating_state": "PENDING"
    }
  }
}


...