Available from CRM.COM R6.0.0

GET subscriptions/configuration/types/list

This method returns the subscription types that are allowed to be used in the system. Multiple subscription types are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be owning the subscriptions related with the retrieved types. If specified then the subscription types are filtered against the subscription restrictions specified in the active subscription 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

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the subscription type. The group is filtered against the subscription types' allowed organisational units. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the subscription type. The unit is filtered against the subscription types' allowed organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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
name	String	The name of the retrieved subscription type
alternative_code	String	The alternative code of the retrieved subscription type
description	String	A description of the retrieved subscription type
classification	String	The classification of the retrieved subscription type, Flexible or Package Available from CRM.COM R14.0.0 Deprecated from CRM.COM R18.0.0
subscriptions_model	String	The model of subscriptions having the specified subscription type. Available values are COMMERCIAL and RESIDENTIAL. Available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
log_information	Log Information Object	The log information of the retrieved subscription type

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/billing_term_schemes/list

This method returns the billing term schemes that are allowed to be used by a specific type of subscription. Multiple billing term schemes 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 type of the subscription that will be using the billing term schemes. 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

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 billing term scheme
code	String	The code of the retrieved billing term scheme
name	String	The name of the retrieved billing term scheme
life_cycle_state	String	The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following DRAFT, EFFECTIVE, TERMINATED
classification	String	The classification of the retrieved billing term scheme which can be either SUBSCRIPTIONS or JOBS Deprecated from CRM.COM R15.0.0
billing_type	String	The billing type of the billing term scheme that will be assigned to subscription billing terms. Available options are NORMAL or PREPAID Billing type options PRE/POST_BILL and PRE/POST_RATED are available starting from CRM.COM R15.0.0 Prior CRM.COM R15.0.0. the supported billing type options are NORMAL or PREPAID
billing_type_classification	String	The billing type classification that defines how Normal and Prepaid subscriptions will be billed. Available options are PRE_BILL or POST_BILL for Normal billing term schemes and PRE_RATED or POST_RATED for Prepaid billing term schemes Available from CRM.COM R15.0.0.
discount_option	String	The discount option of the retrieved billing term scheme that can be FIXED_PRICE or FLEXIBLE_PRICE Deprecated from CRM.COM R15.0.0
description	String	The description of the retrieved billing term scheme
billing_method	String	The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD
billing_terms_auto_renewed	Boolean	Indicates whether the billing terms of subscriptions following the specified billing term scheme will be auto-renewed or not Available from CRM.COM R15.0.0
concurrent_usage_allowed	Boolean	Determines if concurrent usage is allowed for subscriptions using this billing term scheme
allowed_cycle_day	Number	The allowed cycle day. This information is available only if the billing method is PERIOD
allowed_cycle_day_from	Number	The allowed cycle day range from day. This information is available only if the billing method is ANNIVERSARY
allowed_cycle_day_to	Number	The allowed cycle day range to day. This information is available only if the billing method is ANNIVERSARY
anniversary_day_equal_to_subscription_creation_day	Boolean	Defines that the anniversary day is set according to the day of month in which the subscription is initiated. Applicable only when the billing method is set to ANNIVERSARY. If set to Yes, then allowed_cycle_day_from and allowed_cycle_day_ to are not applicable Available from CRM.COM R12.0.0
reset_anniversary_day_on_subscription_reactivation	Boolean	Defines whether the anniversary day will be reset whenever the subscription goes back to the Effective life cycle state and according to the reactivation action's scheduled day of month. Applicable only when the billing method is set to ANNIVERSARY. If set to Yes, then allowed_cycle_day_from and allowed_cycle_day_ to are not applicable Available from CRM.COM R12.0.0
requires_prepayment	Boolean	Indicates whether a prepayment is required in order to perform actions on Subscriptions using this Billing Term Scheme. Applicable only for Normal Billing Term Schemes Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.0.0
payment_model	String	Defines when the account owner is expected to submit a payment. Available only for Normal Billing Term Schemes. The available values are: PAY_BEFORE_BILL available only for schemes of Anniversary billing method PAY_AFTER_BILL available in all Normal billing term schemes and it is also the default option. Available from CRM.COM R14.0.0 From CRM.COM R14.2.0, payment model is available for both Anniversary and Period billing schemes.
services_billing_period_adjustable	Boolean	Indicates whether the period to be billed in advance is adjustable for the supported services depending on the amount paid by the subscriber. Applicable only for billing term schemes of type PREPAID and the setting applies only for pre-rated services. Available from CRM.COM R14.0.0
default_billing_frequency	String	The name of the default billing frequency that will be set on the billing terms of subscriptions following the related billing term scheme. Applicable only for Normal Billing Term Schemes Available from CRM.COM R15.0.0
default_binding_period	String	The name of the default binding period that will be set on the billing terms of subscriptions following the related billing term scheme. Applicable only for Normal Billing Term Schemes and only if a binding period is required. Available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String
udf_string_2	String	User Defined Field of type String
udf_string_3	String	User Defined Field of type String
udf_string_4	String	User Defined Field of type String
udf_string_5	String	User Defined Field of type String
udf_string_6	String	User Defined Field of type String
udf_string_7	String	User Defined Field of type String
udf_string_8	String	User Defined Field of type String
udf_float_1	Float	User Defined Field of type Float
udf_float_2	Float	User Defined Field of type Float
udf_float_3	Float	User Defined Field of type Float
udf_float_4	Float	User Defined Field of type Float
udf_date_1	Date	User Defined Field of type Date
udf_date_2	Date	User Defined Field of type Date
udf_date_3	Date	User Defined Field of type Date
udf_date_4	Date	User Defined Field of type Date
log_information	Log Information Object	The log information of the retrieved billing term scheme
billing_frequencies_set	Set of Billing Frequencies Objects	The billing frequencies that are supported by the retrieved billing term scheme. Applicable only for
binding_periods_set	Set of Binding Period Objects	The binding periods that are supported by the retrieved billing term scheme
supported_services_set	Set of Billing Term Scheme Services Objects	The services that are supported by the retrieved billing term scheme Deprecated from CRM.COM R15.0.0

Referred Objects Response Data

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

billing_frequency object response data

Name	Type	Description
code	String	The code of the retrieved billing frequency
name	String	The label of the retrieved billing frequency
default	Boolean	It determines if the retrieved billing frequency is the default, as specified in the related billing term scheme
time_period	Time Period Object	The time period that is represented by the retrieved billing frequency

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

binding_period object response data

Name	Type	Description
code	String	The code of the retrieved binding period
name	String	The label of the retrieved binding period
default	Boolean	It determines if the retrieved binding period is the default, as specified in the related billing term scheme
time_period	Time Period Object	The time period that is represented by the retrieved binding period

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

billing_term_scheme_product object response data

Name	Type	Description
id	String	The ID of the retrieved billing term scheme product
billing_type	String	The billing type of the retrieved billing term scheme product, which can be PREBILL or POSTBILL for Normal Billing Term Schemes or POSTRATE or PRERATE for Prepaid Billing Term Schemes. PRERATE and POSTRATE billing types available from CRM.COM R9.0.0
period_billed_in_advance	Integer	Defines the period for which the billing tern scheme product will be pre-rated. Applicable only for billing term schemes with billing tye Prepaid and only for products whose billing type is set to PRERATE. Available from CRM.COM R9.0.0 Deprecated from CRM.COM R14.0.0
period_billed_in_advance_uot	String	The unit of time that measures the specified period billed in advance. The supported values are DAYS, WEEKS or MONTHS. Applicable only if period billed in advance is specified for a Prepaid billing term scheme product which is also classified as to be Pre-Rated. Available from CRM.COM R9.0.0 Deprecated from CRM.COM R14.0.0
free	Boolean	Indicates whether the retrieved service is classified as Free or a Paid one. If true then the service is a free service Available from CRM.COM R14.2.0
product	Product object	The actual billing term scheme product
periods_billed_in_advance	Periods Billed in Advance Set	Defines the allowed periods for which the specified service can be billed in advance. Applicable only for prepaid pre-rated services. Available from CRM.COM R14.0.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

period billed in advance object response data

Name	Type	Description
period_billed_in_advance	Integer	Defines the period for which the billing tern scheme product will be pre-rated. Applicable only for billing term schemes with billing tye Prepaid and only for products whose billing type is set to PRERATE.
period_billed_in_advance_uot	String	The unit of time that measures the specified period billed in advance. The supported values are DAYS, WEEKS or MONTHS. Applicable only if period billed in advance is specified for a Prepaid billing term scheme product which is also classified as to be Pre-Rated.
default	Boolean	Defines which period to bill in advance is the default one for the specified service

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/billing_term_schemes/price_plans/list

This method returns the price plans that can be applied on a subscription, considering the billing term scheme that will be used. Multiple price plans are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

billing_term_scheme_identifier

(mandatory)

Billing Term Scheme Identifier

The identifier of the billing term scheme that will provide the price plan. 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

accounts_receivable_identifier

(optional)

Accounts Receivable Identifier

The identifier of the accounts receivable that will be owning the subscription that will get the price plan. If specified then the price plans are filtered against the conditions to select the price plan, considering 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

subscription_identifier

(optional)

Subscription Identifier

The identifier of the subscription that will get the price plan. If specified then the price plans are filtered against the conditions to select the price plan, considering the specified subscription. The allowed subscription identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

group_identifier

(optional)

Group Identifier

The identifier of the group that will be providing the price plan. The group is filtered against the price plans' allowed organisational units. The allowed group identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the group

name

(semi-optional)

String

The code of the group

alternative_code

(semi-optional)

String

The alternative code of the group

unit_identifier

(optional)

Unit Identifier

The identifier of the unit that will be providing the price plan. The unit is filtered against the price plans' allowed organisational units. The allowed unit identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Unit

name

(semi-optional)

String

The name of the Unit

alternative_code

(semi-optional)

String

The alternative code of the Unit

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 price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
base_price_plan	Price Plan Object	The base price plan related with the retrieved price plan. This information is available only if the retrieved price plan is a conditional price plan
log_information	Log Information Object	The log information of the retrieved subscription type

Referred Objects Response Data

price_plan object data response

Name	Type	Description
Id	String	The ID of the retrieved price plan
name	String	The Name of the retrieved price plan
code	String	The Code of the retrieved price plan
description	String	The Description of the retrieved price plan
type	String	The Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date	Date	The Effective Date of the retrieved price plan
expiration_date	Date	The Expiration Date of the retrieved price plan
currency	Currency Object	The Currency of the retrieved price plan Available from CRM.COM R14.2.0

Referred Objects Response Data

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

log_information object response data

Name	Type	Description
created_date	Date	The date that the retrieved record was created
updated_date	Date	The last date that the retrieved record was updated
created_by_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
created_by_business_unit	Unit Object	The unit that created the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Available from CRM.COM R18.0.0
created_by_user	User Object	The user that created the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled
updated_by_unit	Unit Object	The last unit that updated the retrieved record From CRM.COM R14.1.0 and onward, group_name and community_name attributes will be returned as empty, if the related legacy compatibility setting is disabled Deprecated from CRM.COM R18.0.0
updated_by_business_unit	Unit Object	The last unit that updated the retrieved record Available from CRM.COM R18.0.0
updated_by_user	User Object	The last user that updated the retrieved record From CRM.COM R14.1.0 and onward, person_name and email attributes will be returned as empty, if the related legacy compatibility setting is disabled

Referred Objects Response Data

unit object response data

Name	Type	Description
id	String	The ID of the retrieved unit
name	String	The name of the retrieved unit
group_name	String	The name of the group that the retrieved unit belongs to
community_name	String	The name of the community that the retrieved unit belongs to
alternative_code	String	The alternative code of the retrieved unit
description	String	The description of the retrieved unit

business unit object response data

Name	Type	Description
id	String	The ID of the retrieved business unit
name	String	The name of the retrieved business unit
code	String	The code of the retrieved business unit
unified_code	String	The unified code of the retrieved business unit
description	String	The description of the retrieved business unit
parent_business_unit_name	String	The name of the parent business unit that the retrieved business unit belongs to

user object response data

Name	Type	Description
id	String	The ID of the retrieved user
username	String	The user name of the retrieved user
person_name	String	The full name of the retrieved user
email	String	The email of the retrieved user

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/provisioning_distributors/list

This method returns the provisioning distributors that are allowed to be used by a specific type of subscription. Multiple provisioning distributors 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 type of the subscription that will be using the provisioning distributor. 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

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 provisioning distributor
name	String	The name of the retrieved provisioning distributor
alternative_code	String	The alternative code of the retrieved provisioning distributor
description	String	The description of the provisioning distributor
provider	String	The provisioning protocol related with the provisioning distributor

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/action_types/list

This method returns the subscription action types and the related sub action types that are allowed to be used in the system. Multiple subscription action types are returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
behavior_code (optional)	String	The behavior code of the subscription action types that will be retrieved. If specified then only action types having the specified behavior code will be retrieved. The supported behavior codes are the following: ACTIVATESUBSCRIPTION ADDINSTALLEDITEM ADDSERVICEUSAGE ADDSERVICE AMENDBILLINGTERMS BECOMESUBSCRIBER BILLASOFDATE CHANGESUBRIBERACCOUNT CHANGESUBSCRIPTIONLOCATION DEACTIVATESUBSCRIPTION ENDSUBSCRIPTIONRESTING EXTENDGRACEPERIOD REMOVEINSTALLEDITEM REMOVESERVICE RESTSUBSCRIPTION STARTSERVICE STOPSERVICE SWAPINSTALLEDITEM SWAPSERVICE TERMINATESUBSCRIPTION
business_classification_code (optional)	String	The business classification code of the subscription sub action types that will be retrieved along with the action type. If specified then only sub action types having the specified business classification code will be retrieved. The supported business classification codes, per behavior code are the following: ACTIVATESUBSCRIPTION ADDINSTALLEDITEM ADDSERVICEUSAGE ADDSERVICE / ADDSERVICEASDRAFT NEWBINDINGPERIODTERMS / RENEWEDBINDINGPERIODTERMS / EXTENDEDBINDINGPERIODTERMS / ADJUSTEDBINDINGPERIODTERMS / CANCELEDBINDINGPERIODTERMS / NOBINDINGPERIODTERMCHANGES CREATEACTIVATESUBSCRIPTION / CREATEDRAFTSUBSCRIPTION NORMAL CHANGESUBSCRIBER / CHANGEACCOUNTSRECEIVABLE CHANGESUBSCRIPTIONLOCATION DEACTIVATESUBSCRIPTION ENDSUBSCRIPTIONRESTING EXTENDGRACEPERIOD REMOVEINSTALLEDITEM / UNDOADDINSTITEM REGRETSERVICE / UNDOADDSERVICE / REGRETSERVICE / CANCELSERVICE RESTSUBSCRIPTION STARTSERVICE STOPSERVICE SWAPINSTALLEDITEM UPGRADESERVICE / DOWNGRADESERVICE / SWITCHSERVICE REGRETSUBSCRIPTION / CANCELSUBSCRIPTION
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 action type
name	String	The name of the retrieved subscription action type
alternative_code	String	The alternative code of the retrieved subscription action type
description	String	The description of the retrieved subscription action type
behavior_code	String	The behavior code of the retrieved subscription action type
sub_action_types_set	Set of Subscription Sub Action Type Objects	The sub action types related with the retrieved subscription type

Referred Objects Response Data

Sub action type referred response objet

Name	Type	Description
id	String	The id of the retrieved subscription sub action type
name	String	The name of the retrieved subscription sub action type
alternative_code	String	The alternative code of the retrieved subscription sub action type
description	String	The description of the retrieved subscription sub action type
business_classification_code	String	The business classification code of the retrieved subscription sub action type

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/allowed_actions/list

This method returns the subscription action types and the related sub action types that are allowed to be used in the system. Multiple subscription action types are returned by each call

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
behavior_code (optional)	String	The behavior code of the subscription action types that will be retrieved. If specified then only action types having the specified behavior code will be retrieved. The supported behavior codes are the following: ACTIVATESUBSCRIPTION ADDINSTALLEDITEM ADDSERVICEUSAGE ADDSERVICE AMENDBILLINGTERMS BECOMESUBSCRIBER BILLASOFDATE CHANGESUBRIBERACCOUNT CHANGESUBSCRIPTIONLOCATION DEACTIVATESUBSCRIPTION ENDSUBSCRIPTIONRESTING EXTENDGRACEPERIOD REMOVEINSTALLEDITEM REMOVESERVICE RESTSUBSCRIPTION STARTSERVICE STOPSERVICE SWAPINSTALLEDITEM SWAPSERVICE TERMINATESUBSCRIPTION
business_classification_code (optional)	String	The business classification code of the subscription sub action types that will be retrieved along with the action type. If specified then only sub action types having the specified business classification code will be retrieved. The supported business classification codes, per behavior code are the following: ACTIVATESUBSCRIPTION ADDINSTALLEDITEM ADDSERVICEUSAGE ADDSERVICE / ADDSERVICEASDRAFT NEWBINDINGPERIODTERMS / RENEWEDBINDINGPERIODTERMS / EXTENDEDBINDINGPERIODTERMS / ADJUSTEDBINDINGPERIODTERMS / CANCELEDBINDINGPERIODTERMS / NOBINDINGPERIODTERMCHANGES CREATEACTIVATESUBSCRIPTION / CREATEDRAFTSUBSCRIPTION NORMAL CHANGESUBSCRIBER / CHANGEACCOUNTSRECEIVABLE CHANGESUBSCRIPTIONLOCATION DEACTIVATESUBSCRIPTION ENDSUBSCRIPTIONRESTING EXTENDGRACEPERIOD REMOVEINSTALLEDITEM / UNDOADDINSTITEM REGRETSERVICE / UNDOADDSERVICE / REGRETSERVICE / CANCELSERVICE RESTSUBSCRIPTION STARTSERVICE STOPSERVICE SWAPINSTALLEDITEM UPGRADESERVICE / DOWNGRADESERVICE / SWITCHSERVICE REGRETSUBSCRIPTION / CANCELSUBSCRIPTION
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 action type
name	String	The name of the retrieved subscription action type
alternative_code	String	The alternative code of the retrieved subscription action type
description	String	The description of the retrieved subscription action type
behavior_code	String	The behavior code of the retrieved subscription action type
sub_action_types_set	Set of Subscription Sub Action Type Objects	The sub action types related with the retrieved subscription type

Referred Objects Response Data

Sub action type referred response objet

Name	Type	Description
id	String	The id of the retrieved subscription sub action type
name	String	The name of the retrieved subscription sub action type
alternative_code	String	The alternative code of the retrieved subscription sub action type
description	String	The description of the retrieved subscription sub action type
business_classification_code	String	The business classification code of the retrieved subscription sub action type

Examples

Example 1

HTTP Method: GET

Request:

Response:

GET subscriptions/configuration/become_subscriber/services/list

accounts receivable, subscription type, billing term scheme, mandatory / optional / provisioning distributor

GET subscriptions/configuration/add_services/services/list

subscription, mandatory / optional / provisioning distributor

GET subscriptions/configuration/swap_services/services/list

subscription, product, mandatory / optional / provisioning distributor

GET subscriptions/configuration/become_subscriber/installed_items/list

accounts receivable, subscription type, billing term scheme, mandatory / optional / provisioning distributor

GET subscriptions/configuration/add_installed_items/installed_items/list

subscription, mandatory / optional / provisioning distributor

GET subscriptions/configuration/swap_installed_items/installed_items/list

subscription, installed item, mandatory / optional / provisioning distributor

subscriptions/installed_items/configuration

GET subscriptions/configuration/types/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/billing_term_schemes/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/billing_term_schemes/price_plans/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/provisioning_distributors/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/action_types/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/allowed_actions/list

Resource URL

Parameters

Response Data

Examples

GET subscriptions/configuration/become_subscriber/services/list

GET subscriptions/configuration/add_services/services/list

GET subscriptions/configuration/swap_services/services/list

GET subscriptions/configuration/become_subscriber/installed_items/list

GET subscriptions/configuration/add_installed_items/installed_items/list

GET subscriptions/configuration/swap_installed_items/installed_items/list