This method returns a list of auto-apply discounts that could be applied to a subscription or job having the specified characteristics. Multiple auto apply discounts are returned by each call
Resource URL
Parameters
Name | Type | Description |
token | String | The token retrieved from the login method |
| accounts_receivable (semi-optional) | Accounts Receivable Object | Information related with the accounts receivable that will own the subscription or the job that could possibly be discounted Up to CRM.COM R14 accounts receivable was a mandatory |
(semi-optional) | Subscriptions Object | Information related with the subscription that could possibly be discounted |
(semi-optional) | Job Object | Information related with the job that could possibly be discounted |
| (optional)
| Buy in Advance Request Object | Information related with buy in advance request that might be applicable on the subscription that could possible be discounted. This information is applicable only if a subscription is specified. Not available from CRM.COM R15.0.0 |
(optional) | Products Object | The product the discount is for. Applicable from CRM.COM R15.0.0 |
(optional) | Set of invoice physical goods | A list of physical goods that will be bought by the customer, used to validated against discounts' existing product conditions. This is only applicable for quick sales, as the existing products of jobs and subscriptions are taken through the defined entity. Applicable from CRM.COM R15.0.0 |
date (optional) | Date | The date for which you want to see the available discounts for. Applicable from CRM.COM R15.0.0 |
from_date (optional) | Date | The date from which the termed service discount will be applied from. Applicable only for termed services Applicable from CRM.COM R15.0.0 |
to_date (optional) | Date | The date up to which the termed service discount will be applied to Applicable only for termed services Applicable from CRM.COM R15.0.0 |
usage_amount (optional) | Float | The usage amount of the usage service. Applicable only for usage services Applicable from CRM.COM R15.0.0 |
usage_zone (optional) | String | The usage zone the usage service belongs to. Applicable only for usage services Applicable from CRM.COM R15.0.0 |
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 |
Referred Parameters Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one semi-optional parameter can be specified.
Response Data
Name | Type | Description |
|---|---|---|
| discount_option | String | The type of discount which will be applied, which can be one of the following
Available from CRM.COM R15.0.0 |
| discount_amount | Number | The discount amount that will be applied, if the additive discount definition is set up to provide a range of discount based on amount. |
| discount_percentage | Number | The discount percentage that will be applied, if the additive discount definition is set up to provide a range of discount based on percentage Available from CRM.COM R15.0.0 |
| discount_free_usage | Number | The free usage discount that will be applied, if the additive discount definition is set up to provide a range of discount based on usage. The UOM depends on the UOM of the usage service being discounted Available from CRM.COM R15.0.0 |
| for | For Object | The discounted period every time the discount is given when the Discount Option is Percentage per Period or Amount per Period. The possible options are the following:
Available from CRM.COM R15.0.0 |
| renew | Renew Object | How often the discount is renewed (provided again) when the Discount Option is Percentage per Period or Amount per Period which can have one of the following options:
Available from CRM.COM R15.0.0 |
| from_date | Date | The date that the auto apply additive discount will be applicable from |
| to_date | Date | The date that the auto apply additive discount will be applicable to |
| currency | Currency Object | The currency in which the discount amount is returned Available from CRM.COM R14.2.0 |
| additive_discount_definition | Additive Discount Definition Object | The auto apply additive discount definition that will be applied |
| product | Product Object | The product that will be discounted by the specified auto apply additive discount definition |
Referred Objects Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"accounts_receivable":
{
"classification_identifier":{"name":"Residential Customer"}
},
"subscription":
{
"type_identifier":{"name":"Normal"},
"owned_by_group_identifier": {"name":"Main Group"},
"billing_terms":
{
"billing_term_scheme_identifier":{"code":"Normal Billing Scheme"},
"price_plan_identifier" : {"code":"BPPT"},
"billing_cycle_day":5,
"agreement_date": "2015-05-05T15:49:59",
"billing_frequency":"DAILY",
"binding_information":
{
"binding_period":"WEEK",
"start_date": "2015-06-05T15:49:59"
},
"concurrent_usage_based_pricing":
{
"concurrent_usage":10,
"rate_percentage":25
}
},
"services_set":
[
{
"service_identifier":{"code":"Bronze"}
}
]
}
}
Response:
{
"data": [
{
"product": null,
"from_date": "2015-05-05T00:00:00",
"to_date": null,
"discount_amount": null,
"additive_discount_definition": {
"alternative_code": "PS1B",
"name": "Pricing SB 19 B",
"id": "F7A2BAD8EC1C49A18F4E394BA37973FC",
"life_cycle_state": "EFFECTIVE",
"classification": "GENERAL",
"type": "AUTO_APPLY"
},
"free_period": null,
"discount_percentage": 20,
"free_period_UOT": null,
"discount_amount_UOT": null
},
{
"product": null,
"from_date": "2015-05-05T00:00:00",
"to_date": null,
"discount_amount": null,
"additive_discount_definition": {
"alternative_code": "PS1C",
"name": "Pricing SB 19 C",
"id": "7482128AE0644004AD823A103A50CC9C",
"life_cycle_state": "EFFECTIVE",
"classification": "GENERAL",
"type": "AUTO_APPLY"
},
"free_period": null,
"discount_percentage": 30,
"free_period_UOT": null,
"discount_amount_UOT": null
},
{
"product": null,
"from_date": "2015-05-05T00:00:00",
"to_date": null,
"discount_amount": null,
"additive_discount_definition": {
"alternative_code": "PS2A",
"name": "Pricing SB 20 A",
"id": "FACFA7509F46492A98BE37841B5A9D3A",
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY"
},
"free_period": null,
"discount_percentage": null,
"free_period_UOT": null,
"discount_amount_UOT": null
},
{
"product": null,
"from_date": "2015-05-05T00:00:00",
"to_date": null,
"discount_amount": null,
"additive_discount_definition": {
"alternative_code": "PS2C",
"name": "Pricing SB 20 C",
"id": "63855F7EFCEA4E73A6C9B8C64FDF709A",
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY"
},
"free_period": null,
"discount_percentage": null,
"free_period_UOT": null,
"discount_amount_UOT": null
},
{
"product": null,
"from_date": "2015-05-05T00:00:00",
"to_date": null,
"discount_amount": null,
"additive_discount_definition": {
"alternative_code": "PS2B",
"name": "Pricing SB 20 B",
"id": "803D9FDAB06B4F6ABF5E99C5FE347706",
"life_cycle_state": "EFFECTIVE",
"classification": "SUBSCRIPTIONS",
"type": "AUTO_APPLY"
},
"free_period": null,
"discount_percentage": null,
"free_period_UOT": null,
"discount_amount_UOT": null
}
],
"status": {
"code": "OK",
"description": "",
"message": ""
}
}