Page Comparison

Versions Compared

Key

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

...

...

...

...

Expand

title	subscription action object response data

Name

Type

Description

id

String

The ID of the retrieved subscription action

number

String

The number of the retrieved subscription action

transaction_reference_number

String

The unique transaction reference number of the retrieved subscription action

Tip
Available from CRM.COM R13.1.0

life_cycle_state

String

The life cycle state of the subscription action. One of the following values is returned:

EXECUTED, EXECUTEDWITHERRORS, REJECTEDSYSTEMFAILURE, REJECTEDSYSTEMVALIDATION, SCHEDULED, CANCELLED

Tip

From CRM.COM R15.0.0 the available life cycle states are:

PENDING_VERIFICATION
EXECUTED
SCHEDULED
CANCELLED
REJECTED

classification

String

The classification that was provided when the subscription action was submitted.

Tip
Available from CRM.COM R17.0.0

behavior_code

String

The behavior code of the subscription action

business_classification_code

String

The business classification code of the subscription action

scheduled_date

Date

The date that the subscription was scheduled to be executed

executed_on

Date

The date that the subscription action is executed

submitted_on

Date

The date that the business action was submitted into the system

performed_on

Date

The date that the business action was actually performed, which might be different than the date that was submitted into the system

udf_string_1

User objectString

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_2

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_3

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_4

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_5

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_6

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_7

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_8

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_9

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_10

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_11

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_12

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_13

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_14

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_15

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_string_16

String

User Defined Field of type String

Tip
Available from CRM.COM R14.2.0

udf_float_1

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_2

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_3

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_4

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_5

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_6

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_7

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_float_8

Float

User Defined Field of type Float

Tip
Available from CRM.COM R14.2.0

udf_date_1

Date

User Defined Field of type Date

Tip
Available from CRM.COM R14.2.0

udf_date_2

Date

User Defined Field of type Date

Tip
Available from CRM.COM R14.2.0

udf_date_3

Date

User Defined Field of type Date

Tip
Available from CRM.COM R14.2.0

udf_date_4

Date

User Defined Field of type Date

Tip
Available from CRM.COM R14.2.0

User Object

The user that submitted the action into the system

User objectUser Object

The user that actually performed the subscription action, which might be different than the user that submitted the action into the system

performed_by_unit

Unit Object

The unit that performed the subscription action

Tip

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R18.0.0

performed_by_business_unit

Business Unit Object

The business unit that performed the subscription action

Tip
Available from CRM.COM R18.0.0

Subscription action type object The Action Type Object

The action type of the subscription action

Tip
Deprecated from CRM.COM R15.0.0

sub_action_type

Subscription sub action type objectSub Action Type Object

The sub action type of the subscription action

Tip
Deprecated from CRM.COM R15.0.0

Subscription objectObject

The subscription that was or will be modified by the execution of the subscription action

Job Object

The Job for which the subscription action was performed

Tip
Available from CRM.COM R9.0.0

Subscription Action Object

The subscription action that was generated when the retrieved subscription was re-submitted. Applicable only if the retrieved subscription action is in Rejected life cycle state

Tip
Available from CRM.COM R17.0.0

subscription_action_affected_services_set

Set of subscription action affected services

A list of subscription services which are affected by the specified subscription action. Each subscription service might be affected if it is being added or removed by the subscription action, or if its life cycle changes because of the action.

Tip
Available from CRM.COM R15.0.0

subscription_action_affected_installed_items_set

Set of subscription action affected installed items

A list of subscription installed items which are affected by the specified subscription action. Each subscription installed item might be affected if it is being added or removed by the subscription action

Tip
Available from CRM.COM R15.0.0

Anchor

	subscription_action referred objects
	subscription_action referred objects

Referred Objects Response Data

Include Page

	user_short
	user_short

Include Page

	unit_short
	unit_short

Include Page

	business_unit_short
	business_unit_short

Include Page

	subscription_action_type_short
	subscription_action_type_short

Include Page

	subscription_sub_action_type_short
	subscription_sub_action_type_short

Include Page

	subscription_short
	subscription_short

Include Page

	job_short
	job_short

Include Page

	subscription_action_short
	subscription_action_short

Include Page

	subscription_action_affected_service_short
	subscription_action_affected_service_short

Include Page

	subscription_action_affected_installed_item_short
	subscription_action_affected_installed_item_short