Versions Compared

Key

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

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

...

Available from CRM.COM R5.0.0

Excerpt

This method is changing the location of an existing subscription. 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)

...


Excerpt

This method is changing the location of an existing subscription. 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:

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
For releases prior to

Deprecated from CRM.COM

R13

R15.0.0

the subscription_identifier is mandatoryaccounts_receivable_


classification_identifier

(

semi-

optional)

Accounts Receivable
Subscription Action Classification Identifier

The

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

subscription action's classification. The allowed

accounts receivable

subscription action classification identifier fields are the following:

Include Page
V4:

accounts

subscription_action_

receivable

classification_identifier

_post

V4:

accounts

subscription_

receivable_identifier_post NoteThe ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription

action_classification_identifier

Tip

Available from CRM.COM

R13

R18.0.0

action


transaction_

type

reference_

identifier

number

(optional)

Subscription action type identifier
String

The

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

transaction reference number of the formed 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)

Subscription sub action type
User identifier
The sub action type that should be used

 The user that actually performed the action. The allowed

subscription sub action type

user identifier fields are the following:

Include Page
V4:

subscription_sub_action_type_

user_identifier
V4:

subscription

user_

sub

identifier

performed_

action

by_

type

unit_identifier

transaction_reference_number

(optional)

String
Unit Identifier

The

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

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

R13

R14.0.0

Deprecated from CRM.COM R18.0.0


performed_by_

user

business_unit_identifier

(optional)

User identifier The user that actually
Business Unit Identifier

The business unit that performed the action. The allowed

user

business unit identifier fields are the following:

Include Page
V4:

user

business_unit_identifier
V4:

user

business_unit_identifier

Tip

Available from CRM.COM R18.0.0


performed_on

(optional)

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

Tip
Available

Deprecated from CRM.COM R12.1.0. Such actions should never be scheduled even from CRM.COM R5.

0.0

0.0


require_verification

(optional)

Boolean

Determines whether the Subscription Action will be fulfilled through a Job

Tip
Deprecated

Available from CRM.COM

R12

R15.1

.0. Such actions should never be scheduled even from CRM

.

COM R5.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

subscription_address

(mandatory)

Address object  

The address of the subscription to be created

Tip

From CRM.COM R14.3.0, Subscription Address is mandatory based on the Accounts Receivable Definitions' Billing Address Rules


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
subscription_objects parameters
subscription_objects parameters
Referred Parameter Objects Data

...

Expand
titleExample 1

HTTP Method: POST

 


Request:

Body:

Code Block
languagejavascript
themeConfluence
languagejavascript
linenumberstrue
 {
  "token":"5844FE4F26EAEC8661CAC84D3D42904B",
  "subscription_identifier":{"number":"S60066"},
  "subscription_address":{
                           "action":"EXISTING",
                           "type":"SAMEASBILLINGADDRESS"
                         }
 }


Response:

Code Block
languagejavascript
themeConfluencelanguagejavascript
linenumberstrue
 
  {
    "status":
    {
        "message": null,
        "description": null,
        "code": "OK"
    },
    "data":
    {
        "action_type": null,
        "submitted_on": "2014-12-30T10:41:18",
        "sub_action_type": null,
        "business_classification_code": "CHANGE_SUBSCRIPTION_LOCATION",
        "number": "109",
        "executed_on": "2014-12-30T10:41:18",
        "life_cycle_state": "EXECUTED",
        "performed_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "behavior_code": "CHANGE_SUBSCRIPTION_LOCATION",
        "submitted_by":
        {
            "person_name": "Marios Lannister",
            "username": "MPAdministrator",
            "id": "1",
            "email": null
        },
        "id": "CBA4875AAED9C2FBB05F7D8D35046D99",
        "subscription":
        {
            "accounts_receivable":
            {
                "account_owner":
                {
                    "last_name": "Petrou",
                    "life_cycle_state": "FINANCIAL",
                    "middle_name": null,
                    "company_profile": null,
                    "title": "Mr",
                    "type": "PERSON",
                    "first_name": "Damianos",
                    "name": "Damianos Petrou",
                    "id": "7C87374C8FFCB160CA88EFA94E62CA11",
                    "company_name": null,
                    "demographics":
                    {
                        "gender": null,
                        "passport_issued_by_country": null,
                        "passport_number": null,
                        "social_security_number": "9654875",
                        "country_of_residence": null,
                        "industry_sector": null,
                        "date_of_birth":
                        {
                            "month": null,
                            "day": null,
                            "year": null
                        },
                        "name_day":
                        {
                            "month": null,
                            "day": null
                        },
                        "id_number": "885544",
                        "id_issued_by_country": null,
                        "industry": null
                    }
                },
                "life_cycle_state": "ACTIVE",
                "number": "91",
                "name": "DP001",
                "id": "2A3E9DF6299B372DE784DBD63E6CB5F9"
            },
            "life_cycle_state": "NOT_EFFECTIVE",
            "number": "S60066",
            "type":
            {
                "name": "Normal Subscription",
                "id": "6BB2B984CC9309775D06650C7493A836",
                "description": null,
                "alternative_code": "ST"
            },
            "id": "21E2D758A47854FFB2C929C1341962C0"
        },
        "performed_on": "2014-12-30T10:41:18"
    }
}


...