GET pricing/get_rates

Available from CRM.COM R15.0.0

This method returns the available price plan rates included in a price plan either for a specific product or for all products by providing one of the billable entities (semi-optional parameters) the rates are requested for between subscription, job or accounts receivable (for physical good sales). Multiple price plan rates might be retrieved by each call.

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

Subscription Identifier

The identifier of the subscription for which rates should be returned as a result. The allowed subscription identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of subscription

number

(semi-optional)

String

The number of subscription

job_identifier

(semi-optional)

Job Identifier

The identifier of the job for which rates should be returned as a result. The allowed job identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the job

number

(semi-optional)

String

The number of the job

accounts_receivable_identifier

(semi-optional)

Accounts Receivable Identifier

The identifier of the accounts receivable for which a sale is made against and for which rates 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

product_identifier

(semi-optional)

Product Identifier

The identifier of the product whose price plan rates should be returned as a result. The allowed product identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product

code

(semi-optional)

String

The code of the product

alternative_code

(semi-optional)

String

The alternative code of the product

If a single product is defined then only rates for the specific product will be retrieved.

Up to CRM.COM R17.0.0

In this case if there is different pricing per quantity (i.e. traceable physical goods in jobs or sales) it is not possible to return. In order to be able to return the exact pricing which considers tiered rates then no product must be defined.
- In case the product is a non-traceable physical good and the quantity is provided along with the product then the tiered rate can be returned

From CRM.COM R17.0.0

For all products, all tiered rates are retrieved

For CRM.COM R17.0.0, product_identifier is semi-optional and if a product is provided then the tiered rates are provided as well

date

(optional)

Date

The date for which you want to see the available rates for.

Applicable for all products apart from termed services

from_date

(optional)

The date from which the termed service is rated for.

Applicable only for termed services

to_date

(optional)

The date up to which the termed service is to be rated.

Applicable only for termed services

quantity

(optional)

The quantity of the physical goods or termed services.

Applicable only for physical goods and termed services (multiple viewing points)

duration

(optional)

The duration of the one time service.

Applicable only for one time services

usage_amount

(optional)

The usage amount of the usage service.

Applicable only for usage services

usage_zone

(optional)

The usage zone the required usage service belongs to.

Applicable only for usage services

rate_model

(optional)

String

The price plan rate model that determines how the calculation will be performed in order to retrieve a product's final price. If specified then price plan rates that are following the specific rate model will be retrieved, otherwise price plan rates of any model will be retrieved. The allowed price plan rate models are the following:

QUANTITYBASED
QUANTITYANDMATURITYBASED
BILLABLEPERIODBASED (FLATRATEMATURITYBASED)
DURATIONBASED
FLATFEEBASED (FLATRATE)
USAGEBASED (NEW)

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

fields_set

(optional)

List of Strings, comma separated

A list of fields that should be included in the results. If not specified then all the available fields will be returned.

Response Data

Name	Type	Description
code	String	The code of the retrieved price plan rate
rate_model	String	The rate model of the retrieved price plan rate. Available values are: FLATRATEQUANTITYBASED TIEREDRATEQUANTITYBASED FLATRATEMATURITYBASED TIEREDRATEMATURITYBASED FLATRATEDURATIONBASED TIEREDRATEDURATIONBASED FLATRATEQUANTITYANDMATURITYBASED TIEREDRATEQUANTITYANDMATURITYBASED FLATRATE FLATRATEMATURITYBASED, FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED are available from CRM.COM R14.0.0 From CRM.COM R15.0.0 the following values are available: QUANTITYBASED QUANTITYANDPERIODBASED BILLABLEPERIODBASED (FLATRATEMATURITYBASED) DURATIONBASED FLATFEEBASED (FLATRATE) USAGEBASED (NEW) From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED
base_amount	Number	The base rate that is applied if not tiered rates are applied
base_rate_applied_per	String	Determines whether the amount provided is per period or period and quantity. The following options are available Period Period & Item Applicable only for Period & Quantity Based
effective_starting_from	Sting	The date option that determines when a recurring charges will become active. Applicable only for termed services. The applicable values are: BINDINGSTARTDATE, SERVICEEFFECTIVEDATE, AGREEMENTDATE and LATESTRATEDUPTODATE Available from CRM.COM R12.0.0 Not Available from CRM.COM R15.0.0
uot	String	The unit of time that can be used to measure time. This is mandatory information only for termed services.The applicable values are: SECONDS MINUTES HOUR DAY WEEK MONTH YEAR From CRM.COM R14.0.0 the time period object should be used for termed services, although the uot will still be available for duration based rate models
currency	Currency Object	The currency in which the price plan rate is returned Available from CRM.COM R14.2.0
uom	String	Unit of Measurement represents the unit of measurement that can be used in the system in order to measure usage UOM are configurable. Available from CRM.COM R15.0.0
aggregate_tiered_rates	Boolean	If the tiered rates of a model are defined as aggregate the final price is the sum of tiered rates, according to the duration or usage of the service or quantity of the product. Available from CRM.COM R15.0.0
tiered_level_start_at_last_rated_to_date	Boolean	Used to define that each tier level should start from the last rated to date applicable only for Billable Period Based rate model and Period & Quantity Based. Available from CRM.COM R15.0.0
price_plan_period	Price Plan Period object	The period for which the rate is applicable for Available from CRM.COM R15.0.0
time_period	Time Period Object	The period and unit of time used to calculate the rates for termed services. This is applicable only on termed services rates. Only days, weeks, months and years are applicable for termed services rates. The period and unit of time used to calculate the rates for termed services. This is applicable only on termed services rates. Only days, weeks, months and years are applicable for termed services rates. Available from CRM.COM R14.0.0
price_plan	Price Plan Object	The base price plan related with the retrieved price plan. This information is available only if the retrieved price plan is a conditional price plan
product	Product Object	The physical good or service whose price plan rate is returned as a result.
product_bundle	Product Object	The product bundle related with the selected product whose price plan rate is returned as a result.. This information is applicable only if the specified product is used as a product component belonging to a product having a type classified as flexible bundle product.
tiered_rates_set	Set of Tiered Rates Objects	A list of tiered rates related to the specified product. From CRM.COM R14.0.0 the termed_services_rates_set should be used for termed services. The tiered_rates_set will still be available but it will not be applicable for termed services following the FLATRATEQUANTITYANDMATURITYBASED and TIEREDRATEQUANTITYANDMATURITYBASED rate models From CRM.COM R15.0.0 applicable for termed services following the BILLABLEPERIODBASED rate model
termed_services_tiered_rates_set	Set of Termed Services Tiered Rates Objects	A list of tiered rates related to termed service of Matrutity & Quantity Rate model. Applicable for termed services following the QUANTITYANDMATURITYBASED rate model Available from CRM.COM R14.0.0
usage_services_tiered_rates_set	Set of Usage Services Tiered Rates Objects	A list of tiered rates related to the specified usage service. Applicable for usage services Available from CRM.COM R15.0.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

period object response data

Name

Type

Description

time_period_value

Number

The time period value

time_period_uot

String

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

period object response data

Name

Type

Description

period_id

String

The id of the period

period_effective_date

Date

The date from which the period is effective

period_expiration_date

Date

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

MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS

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

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

tiered rates object response data

Name	Type	Description
tier_level	String	The level of the tiered rate
tier_rate_from	Number	The tiered rate's number from which the tiered amount is applicable (inclusive)
tier_rate_to	Number	The tiered rate's number until which the tiered amount is applicable (inclusive). This information is optional.
tier_rate_to_option	String	The option that defines how the tier rate's to will be used. The available options are SPECIFIC_NUMBER, UNLIMITED and BINDING_END_DATE. If the SPECIFIC_NUMBER option is set, then the tier rate to value is also returned.
tiered_amount	Number	The tiered rate amount

termed services tiered rates object response data

Name	Type	Description
level	String	The level of the tiered rate
from_maturity_period	Number	The beginning of the maturity period, inclusive, that will provide the specified rate
to_maturity_period	Number	The end of the maturity period (inclusive) that will provide the specified rate
from_quantity	Number	The minimum quantity (number of times that the service is distributed), inclusive, that will provide the specified rate
to_quantity	Number	The maximum quantity (number of times that the service is distributed), inclusive, that will provide the specified rate
amount	Number	The tiered rate amount provided if the maturity period and the quantity (number of times that the service is distributed) are within the ranges specified above

usage services tiered rates object response data

Name	Type	Description
level	String	The level of the tiered rate
time_model	String	The time model the usage service should belong in to provide the specified rate
usage_zone	String	The usage zone the usage service should belong in to provide the specified rate
amount	Number	The tiered rate amount provided if the maturity period and the quantity (number of times that the service is distributed) are within the ranges specified above

Examples

Example 1

HTTP Method: GET

Request:

{{server}}/crmapi/rest/v2/pricing/get_rates?token={{token}}&subscription_identifier=number=S0000009439&number_of_results=5&offset=1&product_identifier=code=Bronze

Response:

{ "data": [ { "product": { "code": "Bronze", "product_type": { "meter_reading_type": null, "service_type": "TERMED", "used_for_provisioning": true, "alternative_code": "Main Packages", "udr_type": null, "composition_method": "FLAT", "name": "Main Packages", "description": null, "id": "E186E293AAAB49EE86A729540A4287FE", "classification": "SERVICES", "physical_good_type": null }, "alternative_code": "B", "description": "Bronze", "id": "F50CC52934BD4F119B6E18E215A4FC55", "priority_level": null }, "code": "1766229", "price_plan": { "code": "SOA_4", "name": "SOA 4", "effective_date": "2018-05-18T00:00:00", "description": null, "id": "157440BB0DEC436CAA403362DDC03A43", "type": "BASE", "expiration_date": null }, "base_amount": 5, "rate_model": "BILLABLEPERIODBASED", "effective_starting_from": null, "uot": null, "time_period": null, "product_bundle": null, "tiered_rates_set": [] } ], "status": { "code": "OK", "description": "", "message": "" } }