Page Comparison

Available from CRM.COM R13.0.0

.

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

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_userunit_identifier

(optional)

User identifierUnit Identifier user actually user useruser

performed_by_business_unit_identifier

(optional)

Business Unit Identifier from R14

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

Tip
Deprecated from CRM.COM R12.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

accounts_receivable

(mandatory)

Accounts Receivable ObjectThe accounts receivable that should own the subscription.

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