Skip to end of banner

Go to start of banner

GET subscriptions/services/configuration/swap_services/list

Skip to end of metadata

Created by Former user on Jul 05, 2017

Go to start of metadata

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

Compare with Current View Page History

Available from CRM.COM R6.0.0

This method returns the the services that can be used to swap an existing subscription service. Multiple services are returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
subscription_service_id (mandatory)	String	The id of the subscription service that will be swapped
business_classification_code (optional)	String	If specified then only services that are under the tier path of the specified business classification code will be retrieved. The supported values are the following: UPGRADE_SERVICE, DOWNGRADE_SERVICE, SWITCH_SERVICE
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

Response Data

Name	Type	Description
id	String	The ID of the retrieved subscription type service
mandatory	String	Determines if the subscription service is mandatory or not. The supported values is MANDATORY or OPTIONAL
product	Product Object	The actual product provided by the subscription type service
trial_period	Trial Period Object	Includes the trial period that the service will get on its first activation on the subscription (if any is defined according to the subscription type) Available from CRM.COM R14.17.0

Referred Objects Response Data

product object response data

Name	Type	Description
Id	String	The ID of the product
code	String	The code of product
alternative_code	String	The alternative code of product
description	String	The description of product
priority_level	Integer	The priority level of the product Available from CRM.COM R12.3.0
global_rate	Global Rate Object	The global rate of the retrieved product Available from CRM.COM R15.0.0
product_type	Product type object	The type of the product

Referred Objects Response Data

product_type object data response

Name	Type	Description
Id	String	The ID of the retrieved product type
name	String	The Name of the retrieved product type
alternative_code	String	The Alternative Code of the retrieved product type
description	String	The Description of the retrieved product type
classification	String	The Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_type	String	The Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_type	String	The physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_method	String	The Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioning	Boolean	The flag shows if the retrieved product type is used for provisioning
udr_type	Usage Detail Record Type	The UDR type related with the product type. This is applicable only if the product type is classified as SERVICES and the service type is set to USAGE
meter_reading_type	Meter Reading Type	The Meter Reading type related with the product type. This is applicable only for traceable physical goods Available from CRM.COM R14.0.0

Referred Objects Response Data

usage_detail_record_type object data response

Name	Type	Description
Id	String	The ID of the retrieved usage detail record type
name	String	The Name of the retrieved usage detail record type
alternative_code	String	The Alternative Code of the retrieved usage detail record type
description	String	The Description of the retrieved usage detail record type
unit_of_measurement	String	The Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

meter_reading_type object data response

Name	Type	Description
Id	String	The ID of the retrieved meter reading type
name	String	The Name of the retrieved meter reading type
alternative_code	String	The Alternative Code of the retrieved meter reading type
classification	String	The Classification of the retrieved meter reading type
description	String	The Description of the retrieved meter reading type
unit_of_measurement	String	The Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

unit_of_measurement object response data

Name	Type	Description
id	String	The identifier of the Unit of measurement
name	String	The name of the Unit of measurement
description	String	The description of the Unit of measurement
alternative_code	String	The alternative code of the Unit of measurement

global rate object response data

Name	Type	Description
id	String	The ID of the retrieved rate
rate_model	String	The price plan rate model which can be one of the following: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED DURATIONBASED FLATFEEBASED USAGEBASED From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
global_base_amount	Number	The base price of the product in the Global Price Plan
base_rate_applied_per	String	The value for 'Base Rate Applied per' Available when the rate model is 'Quantity & Quantity Based' and it is a selection between Period Period_Item
uot	String	The 'UOT' applicable for the rate Seconds Minute Hour Day Week Month Year Available for one-time services
time_period	Time Period Object	The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.
uom	String	The 'UOM' applicable for the rate Available when the product type is of Usage Service Classification

Referred Objects Response Data

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

The time period unit of time. The supported values are the following:

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

trial period object response data

Name	Type	Description
duration	Number	The trial period's duration value
UOT	String	The trial period's duration UOT which can be DAYS or MONTHS

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "status": {
    "message": null,
    "description": null,
    "code": "OK"
  },
  "data": [
    {
      "mandatory": "Mandatory",
      "id": "33C920B0E435D9E6C81BB0CC43369642",
      "product": {
        "product_type": {
          "physical_good_type": null,
          "service_type": "TERMED",
          "used_for_provisioning": true,
          "composition_method": "FLAT",
          "classification": "SERVICES",
          "name": "Subscription Packages",
          "id": "BC954969D3172372D498D3BB2BA590A0",
          "description": "Subscription main packages",
          "alternative_code": "SP"
        },
        "id": "198E2349ABA438B6AD3677BF437BDD43",
        "description": "Standard + Package",
        "code": "Standard +",
        "alternative_code": "S+"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "B2844CF396511633A522B2A909A88FEE",
      "product": {
        "product_type": {
          "physical_good_type": null,
          "service_type": "TERMED",
          "used_for_provisioning": true,
          "composition_method": "FLAT",
          "classification": "SERVICES",
          "name": "Subscription Packages",
          "id": "BC954969D3172372D498D3BB2BA590A0",
          "description": "Subscription main packages",
          "alternative_code": "SP"
        },
        "id": "A15149563AC0E7D3613F3C1B6E2EE4F5",
        "description": "Standard Package",
        "code": "Standard",
        "alternative_code": "S"
      }
    }
  ]
}

No labels