Skip to end of banner
Go to start of banner

subscription_service_swap_parameter

Skip to end of metadata
Go to start of metadata

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

Compare with Current View Page History

« Previous Version 3 Current »

 subscription_service_swap 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

 

Referred Parameter Objects Data

 existing subscription service object parameter data
Name
Type
Description

subscription_service_id

(semi-optional)

StringThe 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

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.

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

components_set

(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_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