POST subscriptions/list

Available from CRM.COM R13.0.0

This method returns information related with subscriptions. This method is similar to the GET method, but it supports identifying the accounts receivable of a subscription that will be retrieved using an access token. Multiple subscriptions are returned by each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier

The identifier of the accounts receivable that should be returned as a result. 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

access_token_identifier

(semi-optional)

Access Token Identifier

The identifier of the access token which is related with the accounts receivable. Only effective access tokens can be used to identify an accounts receivable. The allowed access token identifier fields are the following

Name	Type	Description
authentication_code (semi-optional)	String	The authentication code of the access token
identifier (semi-optional)	String	The identifier of the access token. If the identifier is specified then it will be validated against the specified pass code
pass_code (mandatory on conditions)	String	The pass code of the access token, which is applicable and mandatory if the identifier is specified
one_time_password (semi-optional)	Integer	The one-time password (OTP) of the access token Available from CRM.COM R13.0.0

Available from CRM.COM R8.0.0

Deprecated from CRM.COM R18.0.0

wallet_identifier

(semi-optional)

Wallet identifier

The identifier of the wallet elated with the subscription that should be returned as a result. The allowed wallet identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the wallet

number

(semi-optional)

String

The number of the wallet

type_identifier

(optional)

Subscription type identifier

The identifier of the subscription type related with the subscriptions that will be retrieved. 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

Restrictions

It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Response Data

Name	Type	Description
id	String	The ID of the retrieved subscription
number	String	The number of the retrieved subscription
life_cycle_state	String	The subscription life cycle state which can be one of the following: DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, REPLACED, PENDING_VERIFICATION REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0 PENDING_VERIFICATION life cycle state available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription became effective for the first time (i.e. the date that the first effective period of that subscription started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the subscription was rated. Available from CRM.COM R12.1.0
free	Boolean	Indicates whether the retrieved subscription is classified as Free or a Paid one. If true then the subscription is a free subscription Available from CRM.COM R14.2.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
accounts_receivable	Accounts Receivable Object	The accounts receivable owning the subscription
pricing_agreement_price_plan	Price Plan Object	The pricing agreement that was assigned against an Accounts Receivable Applicable for an Accounts Receivable that is owned by a Company (Corporate Account) and a Price Plan was agreed as part of a special pricing agreement) Applicable for Accounts Receivables that are members in the related Corporate Account Group as well Available from CRM.COM R14.0.0 From CRM.COM R15.0.0, pricing agreements are also available for accounts receivable owned by Person contact information
type	Subscription type object	The subscription type of the retrieved subscription
billing_terms	Billing terms object	The billing terms of the retrieved subscription
subscription_address	Address object	The address denoting the location of the retrieved subscription
owned_by_group	Group object	The group that is owning the subscription Deprecated from CRM.COM R18.0.0 (replaced with owned_by_business_unit)
owned_by_business_unit	Business Unit Object	The business unit that is owning the subscription Available from CRM.COM R18.0.0
privacy_level	Privacy level object	The subscription's privacy level Deprecated from CRM.COM R18.0.0
log_information	Log Information Object	The log information related with the retrieved subscription
wallet	Wallet Object	The wallet related to the subscription, if the subscription is following a prepaid scheme Available from CRM.COM R12.1.0 From CRM.COM R18.0.0, the wallet is returned for all subscriptions regardless of the billing model and as long as an effective wallet exists
usage_allowance_limits	Usage Allowance Limits Object	The usage allowance limits of the retrieved subscription. Available from CRM.COM R18.0.0
termed_services_set	Set of termed subscription service objects	The termed subscription services of the retrieved subscription
one_time_services_set	Set of one time subscription service objects	The one time subscription services of the retrieved subscription Deprecated in CRM.COM R7.0.0
usage_services_set	Set of usage subscription service objects	The usage subscription services of the retrieved subscription Deprecated in CRM.COM R7.0.0
installed_items_set	Set of subscription installed item objects	The subscription installed items of the retrieved subscription
termed_services_distribution_set	Set of termed service distribution objects	The distribution of termed subscription services Deprecated in CRM.COM R18.0.0
one_time_services_distribution_set	Set of one time service distribution objects	The distribution of one time subscription services Deprecated in CRM.COM R7.0.0
usage_services_distribution_set	Set of usage service distribution objects	The distribution of usage subscription services Deprecated in CRM.COM R7.0.0
installed_items_distribution_set	Set of installed item distribution objects	The distribution of subscription installed items Deprecated in CRM.COM R18.0.0
expense_services_set	Set of expense subscription service objects	The expenses applied on the retrieved subscription Available from CRM.COM R7.0.0

Referred Objects Response Data

accounts_receivable object response data

Name	Type	Description
id	String	The ID of the retrieved accounts receivable
number	String	The number of the retrieved accounts receivable
name	String	The name of the retrieved accounts receivable
life_cycle_state	String	The life cycle state of the accounts receivable. One of the following values is returned: ACTIVE, SUSPENDED, TERMINATED
account_owner	Contact information object	The contact information owning the accounts receivable

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

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

subscription type object 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 R17.0.0

subscription_billing_terms object response data

Name	Type	Description
id	String	The ID of the retrieved billing terms
life_cycle_state	String	The life cycle state of the retrieved billing terms which can be EFFECTIVE or TERMINATED
is_auto_renewed	Boolean	Indicates whether the subscription will be auto-renewed at the end of its billing cycle or not. Available from CRM.COM R15.0.0
next_renewal_date	Date	Defines the date on which the subscription's billing terms will be auto-renewed. Applicable only if customer opts in to auto-renewals. The date is automatically calculated based on the subscription's billing cycle. Available from CRM.COM R18.0.0
expires_on	Date	Defines the date on which the subscription's billing terms will be expired (i.e. it will not be automatically renewed). Applicable only if customer opts out from auto-renewals. Available from CRM.COM R18.0.0
billing_cycle_day	Number	The billing cycle day of the retrieved billing terms. Billing cycle day is used to specify up to which day of the month a subscription should be billed
billing_cycle_last_day_of_month	Boolean	Indicates that the billing term's billing cycle day is the last day of each month. Applicable only when the billing method is Anniversary. If set to Yes, then the billing_cycle_day is not applicable Available from CRM.COM R12.0.0
agreement_date	Date	The agreement date of the retrieved billing terms. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer
allowed_cancel_date	Date	The allowed cancel date of the retrieved billing terms. Allowed cancel date is used to define the date that the billable entity can be churned or terminated. Deprecated from CRM.COM R15.0.0
effective_date	Date	The effective date of the retrieved billing terms
expiration_date	Date	The expiration date of the retrieved billing terms. The expiration date is set when billing terms are amended and a new version of billing terms is in effect. The old version of billing terms (i.e. the replaced one) is expired and no longer valid.
concurrent_usage_based_pricing	Concurrent usage based pricing object	Concurrent usage based pricing is used to apply price plan rates based on the number of concurrent usage of the services or the installed items that will be billed, and a rate percentage which is agreed between the customer and the company providing those service
billing_term_scheme	Billing term scheme object	The billing term scheme of the retrieved billing terms
price_plan	Price Plan Object	The price plan of the retrieved billing terms Deprecated from CRM.COM R15.0.0
billing_frequency	Billing Frequency Object	The billing frequency of the retrieved billing terms. Billing Frequencies are used to denote how often a subscription should be billed.
binding_information	Binding Information Object	The binding information of the retrieved billing terms. Binding information is used to determine if a customer is contractually committed to receive services from the service provider for a fixed period of time.

Referred Objects Response Data

concurrent_usage_based_pricing object response data

Name	Type	Description
concurrent_usage	Number	Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
rate_percentage	Number	Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
number_of_installed_items	Number	The agreed number of installed items that will be concurrently consuming the subscription's services Available from CRM.COM R15.0.0
concurrent_usage_billing_method	String	Defines how the subscriber will be billed because of the concurrent usage of the subscription's services. Available options are: BASED_ON_NUMBER_OF_INSTALLED_ITEMS, BASED_ON_MAXIMUM_CAPACITY BASED_ON_ACTUAL_CAPACITY Available from CRM.COM R15.0.0

billing_term_scheme object 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 NORMAL or PREPAID Classification options NORMAL and PREPAID are available from CRM.COM R15.0.0 Prior CRM.COM R15.0.0 the options are SUBSCRIPTIONS or JOBS
billing_type	String	The billing type of the billing term scheme which can be PRE_BILL or POST_BILL for NORMAL billing term schemes and PRE_RATED or POST_RATED for PREPAID billing term schemes Billing type options PRE/POST_BILL and PRE/POST_RATED are available from CRM.COM R15.0.0 Prior CRM.COM R15.0.0 the options are NORMAL and PREPAID
billing_method	String	The billing method of the billing term scheme which can be ANNIVERSARY or PERIOD

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

billing frequency object response data

Name	Type	Description
code	String	The code of the retrieved billing frequency
name	String	The name of the retrieved billing frequency

binding_information object response data

Name	Type	Description
state	String	The binding state which can be INBINDING or OUTOFBINDING
start_date	Date	The date that the binding period starts
end_date	Date	The date that the binding period ends
binding_period	Binding period object	The binding period

Referred Objects Response Data

binding period object response data

Name	Type	Description
code	String	The code of the retrieved binding period
name	String	The name of the retrieved binding period

address object response data

From R14.2.0, the following object is applicable for CRM.COM Address Format

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
street_name	String	The street name of the retrieved address
street_number	String	The street number of the retrieved address
floor	Integer	The floor of the retrieved address
apartment_number	String	The apartment number of the retrieved address
area	String	The area of the retrieved address
town_city	String	The town / city of the retrieved address
district	String	The district of the retrieved address
municipality	String	The municipality of the retrieved address
po_box	String	The PO box of the retrieved address
po_box_postal_code	String	The PO box postal code of the retrieved address
care_of	String	The care of person of the retrieved address
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_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	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
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

From R14.2.0, the following object is applicable for International Address Format

Name	Type	Description
id	String	The ID of the retrieved address
type	String	The type of the retrieved address which can be HOME, BUSINESS, POBOX, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5
postal_code	String	The postal code of the retrieved address
town_city	String	The town / city of the retrieved address
address_line_1	String	The address line 1
address_line_2	String	The address line 2
state_province_county	String	The state or province or county of the address.
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_string_9	String	User Defined Field of type String
udf_string_10	String	User Defined Field of type String
udf_string_11	String	User Defined Field of type String
udf_string_12	String	User Defined Field of type String
udf_string_13	String	User Defined Field of type String
udf_string_14	String	User Defined Field of type String
udf_string_15	String	User Defined Field of type String
udf_string_16	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
country	Country Object	The country of the retrieved address
is_primary	Boolean	Defines if the address is the contact's primary address or not. Available from CRM.COM R15

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

privacy_level object response data

Name	Type	Description
id	String	The id of the retrieved privacy level
number	String	The number of the retrieved privacy level
name	String	The name of the retrieved privacy level
hierarchy_level	String	The hierarchy level of the retrieved privacy level

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

wallet info object response data

Name	Type	Description
id	String	The ID of the retrieved wallet
number	String	The number of the retrieved wallet
life_cycle_state	String	The life cycle state of the retrieved wallet. Supported values are EFFECTIVE and CANCELLED
balance	Number	The balance of the retrieved wallet in the wallet's currency
alternative_balance	Number	The balance of the retrieved wallet in the wallet's alternative currency Available form CRM.COM R14.2.0
opening_balance	Number	The opening balance of the wallet as this was calculated for the latest and still Open Wallet Balance Period, in wallet's currency. This information is calculated during the latest Wallet Balance per Period process
opening_alternative_balance	Number	The opening balance of the wallet as this was calculated for the latest and still Open Wallet Balance Period, in wallet's alternative currency. This information is calculated during the latest Wallet Balance per Period process Available form CRM.COM R14.2.0
currency	Currency Object	The retrieved wallet's currency
alternative_currency	Currency Object	The retrieved wallet's alternative currency Available form 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

usage_allowance_limits object response data

Name	Type	Description
block_services_not_included_in_usage_allowance_limits_settings	Boolean	Defines if the only usage services includes in usage allowance are allowed to be consumed or not
block_usage_consumption_when_all_amounts_exceed_credit_limit	Boolean	Defines whether usage consumption is blocked when the total amount of billed and un-billed usage exceeds the credit limit of the account owner.
accumulated_maximum_rated_amount_per_day	Number	The accumulated maximum rated amount that is allowed to use within a day.
accumulated_maximum_rated_amount_per_billing_cycle	Number	The accumulated maximum rated amount that is allowed to use within a billing cycle.
accumulated_maximum_rated_amount_per_transaction	Number	The accumulated maximum rated amount that is allowed to use per transaction.
accumulated_maximum_usage_per_day	Number	The accumulated maximum usage amount that is allowed to use within a day.
accumulated_maximum_usage_per_billing_cycle	Number	The accumulated maximum usage amount that s allowed to use within a billing cycle.
accumulated_maximum_usage_per_transaction	Number	The accumulated maximum usage amount that is allowed to use per transaction.
currency	Currency object	The accounts receivable's currency
usage_services_allowance_set	Set of Usage Services Allowance objects	The usage allowance limits per usage service, service type or service family
usage_organisational_units_set	Set of Organizational Unit objects	The Organisational Units at which a usage service is allowed to be consumed

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

usage_allowance_limit_per_service object response data

Name	Type	Description
maximum_rated_amount_per_transaction	Number	The maximum rated amount that can be used per transaction on the specific usage service, service type or service family.
maximum_rated_amount_per_day	Number	The maximum rated amount that can be used within a day on the specific usage service, service type or service family.
maximum_rated_amount_per_billing_cycle	Number	The maximum rated amount that can be used within a billing cycle on the specific usage service, service type or service family. Available from CRM.COM R17.0.0
maximum_rated_amount_per_month	Number	The maximum rated amount that can be used within a month on the specific usage service, service type or service family. Deprecated in CRMCOM R17.0.0
maximum_usage_per_transaction	Number	The maximum usage amount that can be used per transaction on the specific usage service, service type or service family.
maximum_usage_per_day	Number	The maximum usage amount that can be used within a day on the specific usage service, service type or service family.
maximum_usage_per_billing_cycle	Number	The maximum usage amount that can be used within a billing cycle on the specific usage service, service type or service family. Available from CRM.COM R17.0.0
maximum_usage_per_month	Number	The maximum usage amount that can be used within a month on the specific usage service, service type or service family. Deprecated in CRM.COM R17.0.0
service	Product object	The product related with the retrieved usage allowance limit.
service_type	Product Type object	The product type related with the retrieved usage allowance limit.
service_family	Product Family object	The product family related with the retrieved usage allowance limit.

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

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

product_family object data response

Name	Type	Description
Id	String	The ID of the retrieved product family
name	String	The Name of the retrieved product family
code	String	The code of the retrieved product family
description	String	The Description of the retrieved product family

usage_organisational_condition object response data

Name	Type	Description
business_unit	Business Unit Object	The business unit at which usage consumption base don usage limits is allowed Available from CRM.COM R18.0.0
unit	Unit object	The unit at which usage consumption base don usage limits is allowed Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
group	Group object	The group at which usage consumption base don usage limits is allowed Deprecated from CRM.COM R18.0.0 (replaced with business_unit)
community	Community object	The community at which usage consumption base don usage limits is allowed Deprecated from CRM.COM R18.0.0 (replaced with business_unit)

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

group object response data

Name	Type	Description
id	String	The ID of the retrieved group
name	String	The name of the retrieved group
community_name	String	The name of the community that the retrieved group belongs to
alternative_code	String	The alternative code of the retrieved group
unified_code	String	The unified code of the retrieved group Available from CRM.COM R16.2.2
description	String	The description of the retrieved group

community object response data

Name	Type	Description
id	String	The ID of the retrieved community
name	String	The name of the retrieved community
alternative_code	String	The alternative code of the retrieved community
description	String	The description of the retrieved community

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

termed_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
mandatory	Boolean	Defines whether the retrieved termed service was added on the subscription as a mandatory or an additional one. Available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.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
trial_end_date	Date	Defines the end of the service's trial period, if any Available from CRM.COM R14.17.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
period_billed_in_advance	Period Billed in Advance Object	Defines the period that the specified service will be billed in advance. Applicable only for prepaid pre-rated services Available from CRM.COM R14.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service
service_bundle	Subscription Service Bundle Object	The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.

Referred Objects Response Data

period billed in advance object response data

Name	Type	Description
period_billed_in_advance	Integer	Defines the period for which the the service will be pre-rated. Applicable only for prepaid services of PRERATE billing type
period_billed_in_advance_uot	String	The unit of time that measures the specified period billed in advance for the service. The supported values are DAYS, WEEKS or MONTHS. Applicable only for prepaid services of PRERATE billing type

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

termed_subscription_service_bundle object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service

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

one_time_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved one time subscription service
life_cycle_state	String	The life cycle state of the one time subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
product	Product object	The product classified as one time service which is related with the retrieved one time subscription service

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

usage_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved usage subscription service
life_cycle_state	String	The life cycle state of the usage subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
product	Product object	The product classified as usage service which is related with the retrieved usage subscription service

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

subscription_installed_item object response data

Name	Type	Description
id	String	The ID of the retrieved subscription installed item
ownership_status	String	The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following: SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE, BROUGHT_BY_CUSTOMER Available from CRM.COM R10.0.0. Prior to that release the supported values were the following: SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER From CRM.COM R14.0.0, BROUGHT_BY_CUSTOMER is supported From CRM.COM R15.0.0 the available ownership statuses are: RENTED_TO_CUSTOMER SOLD_TO_CUSTOMER_THROUGH_COMPANY SOLD_TO_CUSTOMER_THROUGH_PARTNER OWNED_BY_CUSTOMER
enabled	Boolean	Indicates whether the subscription installed item is enabled in a provisioning provider Available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
installed_item	Installed item object	The installed item related with the retrieved subscription installed item
installed_item_bundle	Subscription Installed item bundle object	The subscription installed item bundle that contains the specified installed item as a product bundle. This information is available only if the specified installed item was added as part of a fixed product bundle.

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

subscription_installed_item_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_status

String

The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE

Available from CRM.COM R10.0.0. Prior to that release the supported values were the following:

SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER

installed_item

Installed item object

The installed item related with the retrieved subscription installed item

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

termed_subscription_service_distribution object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
provisioning_distributor_labels	String	The label of the provisioning distributor for that specific subscription Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.0.0
subscription_service	Termed subscription service object	The termed subscription service
provisioning_distributor	Provisioning distributor object	The provisioning distributor Deprecated from CRM.COM R15.0.0
subscription_installed_items_set	Subscription Installed Items Set	A set of subscription installed items delivering the retrieved subscription service Available from CRM.COM R15.0.0
provisioning_providers_set	Provisioning Providers Set	A set of provisioning providers through which the retrieved subscription service will be delivered to the subscriber Available from CRM.COM R15.0.0

Referred Objects Response Data

termed_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
mandatory	Boolean	Defines whether the retrieved termed service was added on the subscription as a mandatory or an additional one. Available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.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
trial_end_date	Date	Defines the end of the service's trial period, if any Available from CRM.COM R14.17.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
period_billed_in_advance	Period Billed in Advance Object	Defines the period that the specified service will be billed in advance. Applicable only for prepaid pre-rated services Available from CRM.COM R14.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service
service_bundle	Subscription Service Bundle Object	The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.

Referred Objects Response Data

period billed in advance object response data

Name	Type	Description
period_billed_in_advance	Integer	Defines the period for which the the service will be pre-rated. Applicable only for prepaid services of PRERATE billing type
period_billed_in_advance_uot	String	The unit of time that measures the specified period billed in advance for the service. The supported values are DAYS, WEEKS or MONTHS. Applicable only for prepaid services of PRERATE billing type

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

termed_subscription_service_bundle object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service

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

provisioning_distributor object 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

subscription_installed_item object response data

Name	Type	Description
id	String	The ID of the retrieved subscription installed item
ownership_status	String	The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following: SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE, BROUGHT_BY_CUSTOMER Available from CRM.COM R10.0.0. Prior to that release the supported values were the following: SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER From CRM.COM R14.0.0, BROUGHT_BY_CUSTOMER is supported From CRM.COM R15.0.0 the available ownership statuses are: RENTED_TO_CUSTOMER SOLD_TO_CUSTOMER_THROUGH_COMPANY SOLD_TO_CUSTOMER_THROUGH_PARTNER OWNED_BY_CUSTOMER
enabled	Boolean	Indicates whether the subscription installed item is enabled in a provisioning provider Available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
installed_item	Installed item object	The installed item related with the retrieved subscription installed item
installed_item_bundle	Subscription Installed item bundle object	The subscription installed item bundle that contains the specified installed item as a product bundle. This information is available only if the specified installed item was added as part of a fixed product bundle.

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

subscription_installed_item_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_status

String

The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE

Available from CRM.COM R10.0.0. Prior to that release the supported values were the following:

SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER

installed_item

Installed item object

The installed item related with the retrieved subscription installed item

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

provisioning_provider object response data

Name	Type	Description
id	String	The id of the retrieved provisioning provider
name	String	The name of the retrieved provisioning provider
alternative_code	String	The alternative code of the retrieved provisioning provider
description	String	The description of the retrieved provisioning providers
provisioning_protocol	String	The provisioning protocol used by the provisioning provider

one_time_subscription_service_distribution object response data

Name	Type	Description
id	String	The ID of the retrieved one time subscription service
subscription_service	Termed subscription service object	The one time subscription service
provisioning_distributor	Provisioning distributor object	The provisioning distributor

Referred Objects Response Data

one_time_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved one time subscription service
life_cycle_state	String	The life cycle state of the one time subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
product	Product object	The product classified as one time service which is related with the retrieved one time subscription service

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

provisioning_distributor object 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

usage_subscription_service_distribution object response data

Name	Type	Description
id	String	The ID of the retrieved usage subscription service
subscription_service	Usage Subscription Service Object	The usage subscription service
provisioning_distributor	Provisioning Distributor Object	The provisioning distributor

Referred Objects Response Data

usage_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved usage subscription service
life_cycle_state	String	The life cycle state of the usage subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
product	Product object	The product classified as usage service which is related with the retrieved usage subscription service

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

provisioning_distributor object 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

subscription_installed_item_distribution object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
provisioning_distributor_labels	String	The label of the provisioning distributor for that specific subscription Available from CRM.COM R13.0.0 Deprecated from CRM.COM R15.0.0
subscription_installed_item	Subscription installed item object	The subscription installed item
provisioning_distributor	Provisioning distributor object	The provisioning distributor Deprecated from CRM.COM R15.0.0
subscription_services_set	Subscription Service Set	A set of subscription services that the retrieved subscription installed item delivers Available from CRM.COM R15.0.0
provisioning_providers_set	Provisioning Providers Set	A set of provisioning providers through which the retrieved subscription service will be delivered to the subscriber Available from CRM.COM R15.0.0

Referred Objects Response Data

subscription_installed_item object response data

Name	Type	Description
id	String	The ID of the retrieved subscription installed item
ownership_status	String	The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following: SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE, BROUGHT_BY_CUSTOMER Available from CRM.COM R10.0.0. Prior to that release the supported values were the following: SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER From CRM.COM R14.0.0, BROUGHT_BY_CUSTOMER is supported From CRM.COM R15.0.0 the available ownership statuses are: RENTED_TO_CUSTOMER SOLD_TO_CUSTOMER_THROUGH_COMPANY SOLD_TO_CUSTOMER_THROUGH_PARTNER OWNED_BY_CUSTOMER
enabled	Boolean	Indicates whether the subscription installed item is enabled in a provisioning provider Available from CRM.COM R15.0.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
installed_item	Installed item object	The installed item related with the retrieved subscription installed item
installed_item_bundle	Subscription Installed item bundle object	The subscription installed item bundle that contains the specified installed item as a product bundle. This information is available only if the specified installed item was added as part of a fixed product bundle.

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

subscription_installed_item_bundle object response data

Name

Type

Description

id

String

The ID of the retrieved subscription installed item

ownership_status

String

The ownership status of the retrieved subscription installed item. The ownership status defines if the installed item is owned by the company or the customer, based on the business transactions that were applied on the installed item. This Information is calculated dynamically. The supported values are the following:

SOLD_TO_CUSTOMER_NOT_INVOICED, SOLD_TO_CUSTOMER_INVOICED, RENTED_TO_CUSTOMER, IN_INTERNAL_WAREHOUSE, IN_EXTERNAL_WAREHOUSE, NOT_IN_WAREHOUSE

Available from CRM.COM R10.0.0. Prior to that release the supported values were the following:

SOLD_TO_CUSTOMER, RENTED_TO_CUSTOMER

installed_item

Installed item object

The installed item related with the retrieved subscription installed item

Referred Objects Response Data

installed item object response data

Name	Type	Description
id	String	The ID of the retrieved installed item
serial_number	String	The serial number of the retrieved installed item
alternative_code	String	The alternative code of the retrieved installed item
state	String	The state of the retrieved installed item, which can be EFFECTIVE or NOT_EFFECTIVE
state_classification	State Classification object	The state classification of the retrieved installed item, which defines the reason why the installed item was set as Not Effective Applicable only if the Installed Item was set as Not Effective through automation process Available from CRM.COM R14.0.0
product	Product object	The product of the retrieved installed item

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

state classification object response data

Name	Type	Description
name	String	The name of the installed item's state classification
alternative_code	String	The alternative code of the installed item's state classification
description	String	The description of the installed item's state classification

provisioning_distributor object 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

termed_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, IN_RESTING, SHORT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED life cycle state available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
mandatory	Boolean	Defines whether the retrieved termed service was added on the subscription as a mandatory or an additional one. Available from CRM.COM R15.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.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
trial_end_date	Date	Defines the end of the service's trial period, if any Available from CRM.COM R14.17.0
udf_string_1	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_2	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_3	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_4	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_5	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_6	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_7	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_string_8	String	User Defined Field of type String Available from CRM.COM R14.3.0
udf_float_1	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_2	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_3	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_float_4	Float	User Defined Field of type Float Available from CRM.COM R14.3.0
udf_date_1	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_2	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_3	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
udf_date_4	Date	User Defined Field of type Date Available from CRM.COM R14.3.0
period_billed_in_advance	Period Billed in Advance Object	Defines the period that the specified service will be billed in advance. Applicable only for prepaid pre-rated services Available from CRM.COM R14.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service
service_bundle	Subscription Service Bundle Object	The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.

Referred Objects Response Data

period billed in advance object response data

Name	Type	Description
period_billed_in_advance	Integer	Defines the period for which the the service will be pre-rated. Applicable only for prepaid services of PRERATE billing type
period_billed_in_advance_uot	String	The unit of time that measures the specified period billed in advance for the service. The supported values are DAYS, WEEKS or MONTHS. Applicable only for prepaid services of PRERATE billing type

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

termed_subscription_service_bundle object response data

Name	Type	Description
id	String	The ID of the retrieved termed subscription service
life_cycle_state	String	The life cycle state of the termed subscription service. One of the following values is returned: DRAFT, EFFECTIVE, NOT_EFFECTIVE, SHIRT_TERM_EFFECTIVE, SHORT_TERM_NOT_EFFECTIVE, IN_RESTING, CANCELLED, REGRETTED, SWAPPED, REMOVED, REPLACED REPLACED available from CRM.COM R14.0.0, deprecated in CRM.COM R18.0.0
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started) Available from CRM.COM R9.0.0
rating_state	String	The rating state of the retrieved subscription service that can be PENDING or COMPLETED Available from CRM.COM R9.0.0
rated_up_to	Date	The date up until which the termed service was rated. Available from CRM.COM R9.0.0
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service

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

provisioning_provider object response data

Name	Type	Description
id	String	The id of the retrieved provisioning provider
name	String	The name of the retrieved provisioning provider
alternative_code	String	The alternative code of the retrieved provisioning provider
description	String	The description of the retrieved provisioning providers
provisioning_protocol	String	The provisioning protocol used by the provisioning provider

expense_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved expense subscription service
life_cycle_state	String	The life cycle state of the expense subscription service. One of the following values is returned: EFFECTIVE or CANCELLED
is_recurring	Boolean	Indicates whether the Expense service will be charged only once or multiple times Available from CRM.COM R13.0.0
product	Product object	The product classified as expense service

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

free_subscription_service object response data

Name	Type	Description
id	String	The ID of the retrieved free subscription service
life_cycle_state	String	The life cycle state of the free subscription service. One of the following values is returned: DRAFT, EFFECTIVE,CANCELLED, REGRETTED, SWAPPED, REMOVED
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started)
product	Product object	The product classified as free termed service which is related with the retrieved free subscription service
service_bundle	Subscription Service Bundle Object	The subscription service bundle that contains the specified product as a product bundle. This information is available only if the specified product was added as part of a flexible product bundle.

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

free_subscription_service_bundle object response data

Name	Type	Description
id	String	The ID of the retrieved free termed subscription service
life_cycle_state	String	The life cycle state of the free subscription service. One of the following values is returned: DRAFT, EFFECTIVE, CANCELLED, REGRETTED, SWAPPED, REMOVED
first_activated_date	Date	The date that the subscription service became effective for the first time (i.e. the date that the first effective period of that subscription service started)
product	Product object	The product classified as termed service which is related with the retrieved termed subscription service

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

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

Examples

Example 1

HTTP Method: POST

Request:

Body:

 {
    "token":"{{token}}",
    "accounts_receivable_identifier":
    {
    	"access_token_identifier":
    	{
    		"authentication_code":"111"
    	}
    },
    "type_identifier":{"alternative_code":"NM"},
    "fields_set":"id,number,life_cycle_state,first_activated_date,rating_state,rated_up_to,accounts_receivable,billing_terms,wallet,termed_services_set,one_time_services_set,usage_services_set,installed_items_set,termed_services_distribution_set,one_time_services_distribution_set,usage_services_distribution_set,installed_items_distribution_set,expense_services_set"
}

Response:

 {
  "data": [
    {
      "number": "S0000003438",
      "installed_items_distribution_set": [],
      "first_activated_date": "2017-01-26T14:30:39",
      "rating_state": "PENDING",
      "termed_services_set": [
        {
          "product": {
            "code": "Bronze",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "B",
            "description": "Bronze",
            "id": "F50CC52934BD4F119B6E18E215A4FC55"
          },
          "first_activated_date": "2017-01-26T14:30:39",
          "rating_state": "PENDING",
          "service_bundle": null,
          "rated_up_to_date": null,
          "id": "7D8A199374C74B5080B1786658E2EBFE",
          "life_cycle_state": "IN_RESTING"
        },
        {
          "product": {
            "code": "Silver",
            "product_type": {
              "service_type": "TERMED",
              "used_for_provisioning": true,
              "alternative_code": "Main Packages",
              "composition_method": "FLAT",
              "name": "Main Packages",
              "description": null,
              "id": "E186E293AAAB49EE86A729540A4287FE",
              "classification": "SERVICES",
              "physical_good_type": null
            },
            "alternative_code": "SLV",
            "description": "SILVER",
            "id": "AF390B58BCE646D485EAC39D44C2C81C"
          },
          "first_activated_date": "2017-01-26T14:30:39",
          "rating_state": "PENDING",
          "service_bundle": null,
          "rated_up_to_date": null,
          "id": "0CE72B3DABE2411FA3FA6D291701D646",
          "life_cycle_state": "EFFECTIVE"
        }
      ],
      "accounts_receivable": {
        "number": "ACR0000003523",
        "name": "ACR0000003523",
        "id": "621BDFF4912242C6B9E97E29BE0D6B58",
        "life_cycle_state": "ACTIVE",
        "account_owner": {
          "company_profile": null,
          "company_name": null,
          "name": "Marinos Anton",
          "last_name": "Anton",
          "id": "B927E1BA6C9C4F9C82E441089AB14994",
          "life_cycle_state": "FINANCIAL",
          "middle_name": null,
          "title": null,
          "type": "PERSON",
          "first_name": "Marinos",
          "demographics": {
            "name_day": {
              "month": null,
              "day": null
            },
            "id_number": "1354892",
            "gender": "MALE",
            "country_of_residence": {
              "alternative_code": "CUB",
              "three_character_code": null,
              "name": "CUBA",
              "id": "180",
              "two_character_code": null
            },
            "date_of_birth": {
              "month": 10,
              "year": 1987,
              "day": 10
            },
            "industry_sector": null,
            "passport_number": null,
            "industry": null,
            "social_security_number": null,
            "id_issued_by_country": {
              "alternative_code": "CUB",
              "three_character_code": null,
              "name": "CUBA",
              "id": "180",
              "two_character_code": null
            },
            "passport_issued_by_country": null
          }
        }
      },
      "termed_services_distribution_set": [],
      "life_cycle_state": "EFFECTIVE",
      "id": "26A884E4905A46D99E5EE5AB20767E54",
      "expense_services_set": [],
      "billing_terms": {
        "billing_frequency": {
          "code": "TWOYEARS",
          "name": "Two Years"
        },
        "billing_term_scheme": {
          "billing_method": "PERIOD",
          "code": "BTSBS10",
          "name": "Billing Term Scheme B CRMCOM6231 Story board 10",
          "billing_type": "NORMAL",
          "id": "0D285C928A1B480E9A0E69D836079BDD",
          "life_cycle_state": "EFFECTIVE",
          "classification": "SUBSCRIPTIONS"
        },
        "allowed_cancel_date": "2020-01-26T00:00:00",
        "billing_cycle_day": 1,
        "agreement_date": "2017-01-26T00:00:00",
        "effective_date": "2017-01-26T00:00:00",
        "price_plan": {
          "code": "MPP",
          "name": "Main Price Plan",
          "effective_date": "2017-01-16T00:00:00",
          "description": "Main Price Plan",
          "id": "207C35A41B5641098152ECF2FA99ACB5",
          "type": "BASE",
          "expiration_date": "2017-01-16T00:00:00"
        },
        "id": "3BEC251D785A47D9B4FC00CB7ACDEDDD",
        "expiration_date": null,
        "binding_information": {
          "end_date": "2020-01-26T00:00:00",
          "binding_period": {
            "code": "CUSTOM3",
            "name": "Three Years"
          },
          "state": "IN_BINDING",
          "start_date": "2017-01-26T00:00:00"
        }
      },
      "installed_items_set": []
    }
  ],
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}