Skip to end of banner

Go to start of banner

amend_subscription_service_swap_parameter

Skip to end of metadata

Created by Georgia Kountouri, last modified on Sept 03, 2018

Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

subscription service to be swapped object parameter data

Name	Type	Description
from_service (mandatory)	Existing Subscription Service Object	The subscription service that should be removed from the subscription
to_service (mandatory)	New Subscription Service Object	The service that should be added on the subscription due to the swap

Referred Parameter Objects Data

existing subscription service object parameter data

Name

Type

Description

subscription_service_id

(semi-optional)

String

The ID of the subscription service

service_identifier

(semi-optional)

Service identifier

The identifier of the service related with the subscription service that belongs to the subscription specified in the parameters. Only products classified as services are retrieved. The allowed service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

new subscription service object parameter data

Name

Type

Description

service_identifier

(mandatory)

Service identifier

The identifier of the service. Only products classified as services are retrieved. The allowed service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

From CRM.COM R14.0.0 onwards, if the Subscription's Type is of classification Package then any Services added on the Subscription are considered as Additional Services.

period_billed_in_advance

(mandatory on conditions)

Integer

The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. If nothing is specified then the default value will be provided

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R15.0.0

period_billed_in_advance_uot

(mandatory on conditions)

String

The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated services. The supported values are DAYS, WEEKS or MONTHS.

Available from CRM.COM R14.0.0

Deprecated from CRM.COM R15.0.0

udf_string_1

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_2

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_3

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_4

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_5

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_6

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_7

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_string_8

(optional)

String

User Defined Field of type String

Available from CRM.COM R14.3.0

udf_float_1

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_2

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_3

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_float_4

(optional)

Float

User Defined Field of type Float

Available from CRM.COM R14.3.0

udf_date_1

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_2

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_3

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

udf_date_4

(optional)

Date

User Defined Field of type Date

Available from CRM.COM R14.3.0

services_distribution_set

(optional)

Set of subscription service distribution objects

The distribution of the services that will be added on the subscription

Deprecated from CRM.COM R15.0.0

(mandatory on conditions)

Set of subscription service components objects

The service components that should be composing the specified service. This information is available and mandatory if the specified service is a flexible product bundle

Referred Parameter Objects Data

subscription_service_distribution object parameter data

Name

Type

Description

provisioning_distributor_identifier

(mandatory)

Provisioning distributor identifier

The identifier of the provisioning distributor. The allowed provisioning distributor identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning distributor

name

(semi-optional)

String

The name of the provisioning distributor

alternative_code

(semi-optional)

String

The alternative code of the provisioning distributor

subscription_service_component object parameter data

Name

Type

Description

service_identifier

(mandatory)

Service identifier

The identifier of the service. Only products classified as services, which are also included in the product components of the related flexible product bundle are retrieved. The allowed service identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

No labels