GET subscriptions/services/configuration/become_subscriber/list

Owned by Former user (Deleted)
Last updated: Aug 08, 2018 by Georgia Kountouri
6 min read

This method returns the services that can be used to create a new subscription of a specific type and billing term scheme. Multiple services are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_type_identifier

(mandatory)

Subscription Type Identifier

The identifier of the subscription type that will be used in the subscription. The allowed subscription type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the subscription type

name

(semi-optional)

String

The name of the subscription type

alternative_code

(semi-optional)

String

The alternative code of  the subscription type

billing_term_scheme_identifier

(mandatory)

Billing Term Scheme Identifier

The identifier of the billing term scheme that will be used in the subscription. The allowed billing term scheme identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

provisioning_distributor_identifier

(optional)

Provisioning Distributor Identifier

The identifier of the provisioning distributor that will be used to distribute the services. If specified then the services will be filtered based on the specified 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

Deprecated from CRM.COM R15.0.0

provisioning_provider_identifier

(optional)

Provisioning Provider Identifier The identifier of the the provisioning provider that will be used to provision the service. If specified then the services will be filtered based on the specified provisioning provider. The allowed provisioning provider identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the provisioning provider

name

(semi-optional)

String

The name of the provisioning provider

alternative_code

(semi-optional)

String

The alternative code of the provisioning provider

Available from CRM.COM R15.0.0

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be owning the subscriptions related with the specified type. If specified then the subscription services are filtered against the subscription services restrictions specified in the billing definition, considering the subscriptions that are already owned by the specified accounts receivable. The allowed accounts receivable identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the accounts receivable

number

(semi-optional)

String

The number of the accounts receivable

name

(semi-optional)

String

The name of the accounts receivable

mandatory

(optional)

BooleanIf set to true then only mandatory services will be retrieved. If set to false then only optional services will be retrieved. If not specified at all then all services will be retrieved

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

NameType Description

id

String

The ID of the retrieved subscription type service

mandatoryStringDetermines 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_periodTrial 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
IdStringThe ID of the product
codeStringThe code of product

alternative_code

String

The alternative code of product

description

String

The description of product

priority_levelInteger

The priority level of the product

Available from CRM.COM R12.3.0

global_rateGlobal Rate Object

The global rate of the retrieved product

Available from CRM.COM R15.0.0

product_typeProduct type objectThe type of the product

Referred Objects Response Data

 product_type object data response
NameType Description
IdStringThe ID of the retrieved product type
nameStringThe Name of the retrieved product type
alternative_codeStringThe Alternative Code of the retrieved product type
descriptionStringThe Description of the retrieved product type
classificationStringThe Classification of the retrieved product type which can be SERVICES or PHYSICALGOODS
service_typeStringThe Service Type of the retrieved product type which can be TERMED, USAGE, ONETIME or EXPENSE
physical_good_typeStringThe physical Good Type of the retrieved product type which can be TRACEABLE or NONTRACEABLE
composition_methodStringThe Composition Method of the retrieved product type which can be FLAT, FLEXIBLEBUNDLE or FIXEDBUNDLE
used_for_provisioningBooleanThe flag shows if the retrieved product type is used for provisioning
udr_typeUsage Detail Record TypeThe 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_typeMeter 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
NameType Description
IdStringThe ID of the retrieved usage detail record type
nameStringThe Name of the retrieved usage detail record type
alternative_codeStringThe Alternative Code of the retrieved usage detail record type
descriptionStringThe Description of the retrieved usage detail record type
unit_of_measurementStringThe Unit of measurement of the retrieved usage detail record type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe alternative code of the Unit of measurement

 

 meter_reading_type object data response
NameType Description
IdStringThe ID of the retrieved meter reading type
nameStringThe Name of the retrieved meter reading type
alternative_codeStringThe Alternative Code of the retrieved meter reading type
classificationStringThe Classification of the retrieved meter reading type
descriptionStringThe Description of the retrieved meter reading type
unit_of_measurementStringThe Unit of measurement of the retrieved meter reading type

Referred Objects Response Data

 unit_of_measurement object response data

Name

Type

Description

idStringThe 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_codeStringThe 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_amountNumber

The base price of the product in the Global Price Plan

base_rate_applied_perString

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
uotString

The 'UOT' applicable for the rate

  • Seconds
  • Minute
  • Hour
  • Day
  • Week
  • Month
  • Year

Available for one-time services

time_periodTime Period Object

 The period and unit of time for which the base amount is applicable for. This is available only on termed services rates.

uomString

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_valueNumber

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": "DF66A3BBEF58B52A446689574303E237",
      "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": "B1E02AFD27BD8D28762873E9EF4880DE",
        "description": null,
        "code": "P2",
        "alternative_code": "P2"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "1DC44FAF2BC5E80DB8E3D22DA73C0509",
      "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": "ABE5D9A65338174B49463F79A636372A",
        "description": null,
        "code": "P3",
        "alternative_code": "P3"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "9E174A86D6BDD6113806DDED598E94BD",
      "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": "2A614B4A8F490B9D4D3DF07F786E6E30",
        "description": null,
        "code": "P4",
        "alternative_code": "P4"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "99B91098E952335301B5CD3D88F0A6B7",
      "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": "D06B37379E0CB614224B3D10BF5450F6",
        "description": null,
        "code": "P5",
        "alternative_code": "P5"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "7C8FDC83A91BD6E616D462E477410E5E",
      "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": "5C2DCFDD743632AC57AE8147B6EE665E",
        "description": null,
        "code": "P1",
        "alternative_code": "P1"
      }
    },
    {
      "mandatory": "Mandatory",
      "id": "E6EE7B0B67B64265BF126BC8274B420B",
      "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": "2C0E72A735F71582FFC765F3421CE6A5",
        "description": "Platinum Packages",
        "code": "Platinum",
        "alternative_code": "PS"
      }
    }
  ]
}