package_items_complete

Name	Type	Description
package_base_rate	Float	The base rate of the whole package calculated in the system's currency, based on the following mandatory termed services
billing_terms	Billing terms object	The billing terms provided by the subscription type.
mandatory_termed_services_set	Set of product objects	The mandatory termed subscription services provided by the subscription type. Not applicable if retrieved_services is set to "ONLY_ADDITIONAL"
additional_termed_services_set	Set of product objects	The additional termed subscription services provided by the subscription type. Not applicable if retrieved_services is set to "ONLY_MANDATORY"
installed_items_set	Set of product objects	The subscription installed items provided by the subscription type.
log_information	Log Information Object	The log information of the retrieved subscription type

Referred Objects Response Data

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

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

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