Available from CRM.COM R12.0.0
This method is amending the billing terms of a Draft, Effective, Not Effective or In Resting subscription. The method can be applied to a single subscription only
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
subscription_identifier (semi-optional) | Subscription identifier | The subscription to be modified. The allowed subscription identifier fields are the following:
Up to CRM.COM R12.0.0 the subscription_identifier is mandatory | ||||||||||||||||||||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
business_classification_code (mandatory) | String | The classification of the Amend Billing Terms Action which can be one of the following:
| ||||||||||||||||||||||||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||||||||||||||||||||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | Thesub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||||||||||||||||||||||||||
transaction_reference_number (optional) | String | The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions. Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_by_unit_identifier (optional) | Unit Identifier | The unit that performed the action. The allowed unit identifier fields are the following:
Available from CRM.COM R14.0.0 | ||||||||||||||||||||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||||||||||||||||||||
agreement_date (mandatory) | Date | The agreement date of the billing terms that will be created. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer. | ||||||||||||||||||||||||||||||
billing_cycle_day (semi-optional and applicable on conditions) | Number | The billing cycle day of the billing terms that will be created. Billing cycle day is used to specify up to which day of the month a subscription should be billed. Applicable and mandatory only when Billing Term Scheme specifies an Anniversary Billing and no automation on how the billing cycle day should be set are defined in the Billing Term Scheme. This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification_code is:
| ||||||||||||||||||||||||||||||
billing_cycle_last_day_of_month (semi-optional and applicable on conditions)
| Boolean | Defines that the billing cycle date is the last day of each month. Applicable only for Anniversary subscriptions and only if and no automation on how the billing cycle day should be set are defined in the Billing Term Scheme. Either a specific day of month (billing_cycle_day) or the last day of month can be specified in these cases. | ||||||||||||||||||||||||||||||
billing_frequency (mandatory on conditions) | String | The billing frequency of the billing terms that will be created. Billing Frequencies are used to denote how often a subscription should be billed.The supported options are the following: DAILY, WEEKLY, MONTHLY, QUARTERLY, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification_code is:
| ||||||||||||||||||||||||||||||
billing_term_scheme_identifier (mandatory and applicable on conditions) | Billing term scheme identifier | The billing term scheme that willbeusedonthebillingterms. The allowed billing term scheme identifier fields are the following:
This information is available ONLY if classification_code is:
| ||||||||||||||||||||||||||||||
price_plan_identifier (mandatory and applicable on conditions) | Price plan identifier | The price plan that will be used on the terms. The allowed price plan identifier fields are the following:
This information is available ONLY if classification_code is:
| ||||||||||||||||||||||||||||||
scheduled_date (optional) | Date | The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
| ||||||||||||||||||||||||||||||
udf_string_1 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_2 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_3 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_4 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_5 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_6 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_7 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_string_8 (optional) | String | User DefinedField of type String | ||||||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
(mandatory and applicable on conditions) | Binding information object | The binding information of the billing term that will be created. 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. Applicable and mandatory only when Billing Term Scheme specifies that it is mandatory to provide binding period. This information is available ONLY if classification_code is:
| ||||||||||||||||||||||||||||||
(mandatory and applicable on conditions) | Extend by information object | The extended by information that will extend the binding period. The extended by period will define the new Binding End Date. This information is available ONLY if classification_code is:
| ||||||||||||||||||||||||||||||
(mandatory and applicable on conditions) | Adjust by information object | The adjust by information that will adjust the binding period. The adjust by period will define the new Binding Start Date. This information is available ONLY if classification_code is:
| ||||||||||||||||||||||||||||||
concurrent_usage_based_pricing (mandatory on conditions) | 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. Concurrent usage based pricing is applicable and mandatory only if it is supported by the billing term schemes This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification_code is:
| ||||||||||||||||||||||||||||||
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 Parameter Objects Data
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"{{token}}",
"subscription_identifier":{"number":"S0000000065"},
"business_classification_code":"NO_BINDING_PERIOD_TERM_CHANGES",
"billing_term_scheme_identifier":{"code":"ASK"},
"billing_cycle_day":2,
"billing_frequency":"MONTHLY",
"agreement_date":"2017-01-23T00:00:00",
"binding_information":
{
"binding_period":"MONTH",
"start_date":"2017-02-16T00:00:00"
},
"concurrent_usage_based_pricing":
{
"concurrent_usage":1,
"rate_percentage":"100"
},
"price_plan_identifier":{"code":"MPP"}
}
Response:
{
"data": {
"performed_by": null,
"action_type": null,
"submitted_by": {
"person_name": "CRM COM",
"id": "1",
"username": "MPAdministrator"
},
"executed_on": "2017-01-24T09:36:46",
"life_cycle_state": "EXECUTED",
"subscription": {
"number": "S0000000065",
"first_activated_date": "2016-03-13T18:43:25",
"rating_state": "PENDING",
"accounts_receivable": {
"number": "ACR0000000066",
"name": "ACR0000000066 Polina Kestora",
"id": "4CDD142DE76743FB91721756FC05A16E",
"life_cycle_state": "ACTIVE",
"account_owner": {
"company_profile": null,
"company_name": null,
"name": "Polina Kestora",
"last_name": "Kestora",
"id": "E1253BE26EB74589BD065F70ACEF75D8",
"life_cycle_state": "FINANCIAL",
"middle_name": null,
"title": null,
"type": "PERSON",
"first_name": "Polina",
"demographics": {
"name_day": {
"month": null,
"day": null
},
"id_number": null,
"gender": null,
"country_of_residence": {
"alternative_code": "IRN",
"three_character_code": null,
"name": "IRAN (ISLAMIC REPUBLIC OF)",
"id": "231",
"two_character_code": null
},
"date_of_birth": {
"month": null,
"year": null,
"day": null
},
"industry_sector": null,
"passport_number": null,
"industry": null,
"social_security_number": null,
"id_issued_by_country": null,
"passport_issued_by_country": null
}
}
},
"id": "C8358DE48C2F4F1CA1FC2C6C5C3C065A",
"life_cycle_state": "EFFECTIVE",
"type": {
"alternative_code": "normalsub",
"name": "Normal",
"description": null,
"id": "D1BAE6454A2248189EBCD7ADD3B4B65F"
}
},
"scheduled_date": "2017-01-24T09:36:46",
"performed_on": null,
"sub_action_type": null,
"business_classification_code": "NO_BINDING_PERIOD_TERM_CHANGES",
"number": "5653",
"submitted_on": "2017-01-24T09:36:46",
"id": "5736E6D6549B41828C13DA6F9E14EA0A",
"job": null,
"behavior_code": "AMEND_BILLING_TERMS"
},
"status": {
"code": "OK",
"description": "",
"message": ""
}
}