Versions Compared

Old Version 10

changes.mady.by.user Georgia Kountouri

Saved on

compared with

New Version Current

changes.mady.by.user Joseph Ioannou

Saved on

Key

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

...


...


Excerpt

This method is used to update information related with an existing subscription. Note that services, installed items or billing terms cannot be updated through this method; there are specific methods that should be used in order to perform those actions. 

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifierSubscription Identifier

The subscription to be modified. The allowed subscription identifier fields are the following:

 

Include Page
V4:subscription_identifier
V4:subscription_identifier

notes

(optional)

 StringNotes for the subscription to be updated

owned_by_group_identifier

(optional)

Group identifier

The group that will be owning the subscription. The allowed group identifier fields are the following:

Include Page
V4:group_identifier
V4:group_identifier

privacy_level_identifier

(optional)

Privacy level identifier

The subscription's privacy level. The allowed privacy level identifier fields are the following:

Include Page
V4:privacy_level_identifier
V4:privacy_level_identifier

udf_
Tip

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

custom_field_set

(optional)

Set of Custom Fields

The custom fields that are associated with the subscription

If no records are specified in the set then nothing will be updated. To add or update a value on a custom field use the custom field name as configured in CRM.COM along with the respective value. To remove a value from a custom field use the custom field name as configured in CRM.COM along with an empty value

Code Block
languagejavascript
themeConfluence
linenumberstrue
"custom_field_set": [
	{"field_name" : "value"},
	{"field_name" : "value"}
]


Tip

Available from CRM.COM R16.2.0


services_set

(optional)

Set of subscription service objects

The services that will be updated by modifying one or more of their UDFs

Tip

Available from CRM.COM-R14.3.0


installed_items_set

(optional)

Set of subscription installed item objects

The installed items that will be updated by modifying one or more of their UDFs

Tip

Available from CRM.COM-R14.3.0


provisioning_distributor_labels_set

(optional)

Set of subscription provisioning distributor label objects

The labels that will be applied on the specified provisioning distributor for the specific subscription. Each provisioning distributor can be labeled only once per subscription.

Tip

Available from CRM.COM R14.5.0


Tip

Deprecated from CRM.COM R18.00


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.

...