job_subscription_terms_amendment_short
Georgia Kountouri
Name | Type | Description |
|---|---|---|
amend_billing_terms_classification | String | The business classification of the requested subscription billing term amendments. Available values are :
|
agreement_date | Date | The agreement date of the billing terms that will be created through this job. |
| billing_cycle_day | Number | The billing cycle day of the billing terms that will be created through the retrieved job. Applicable only when Billing Term Scheme specifies an Anniversary Billing This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification code is:
|
| billing_cycle_last_day_of_month | Boolean | Defines that the billing cycle date of the amended billing term will be the last day of each month. Applicable only for Anniversary subscriptions and only if no specific billing cycle day This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification code is:
|
| billing_frequency | String | The billing frequency of the billing terms that will be created through the retrieved job.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 billing term amendment's classification code is set to:
|
| billing_term_scheme | Billing Term Scheme Object | The billing term scheme requested to be provided in the subscription's amended billing terms. Applicable only if the billing term amendment's classification was set to
|
| price_plan | Price Plan Object | The price plan requested to be provided in the subscription's amended billing terms. Applicable only if the billing term amendment's classification was set to
|
| binding_period_information | Binding Period Information Object | The binding period of the subscription's amended billing terms. This information is available ONLY if classification code is:
|
| binding_period_extended_by | Extended Binding Period Information Object | Information related to the requested extension of the binding period This information is available ONLY if classification code is:
|
| binding_period_adjusted_by | Adjusted Binding Period Information Object | Information related to the requested adjustment of the binding period. This information is available ONLY if classification code is:
|
| concurrent_usage_based_pricing | Concurrent usage based pricing object | Information regarding the subscription's concurrent usage. This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification_code is:
|
Referred Objects 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 |
| 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
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 |
Name | Type | Description |
|---|---|---|
binding_period | String | The binding period which can be one of the following: WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
| start_date | Date | The date that the binding period starts |
| end_date | Date | The date that the binding period ends |
Name | Type | Description |
|---|---|---|
extend_by_period | String | The period that the binding period will be extended by. |
extend_by_uot  | String | The unit of time that can be used to measure the period denoted in extend_by_period. The applicable values are:
|
Name | Type | Description |
|---|---|---|
adjust_by_period | Number | The period that the binding period will be adjusted to. This value can either be positive (adjusting the Binding Start Date to the future) or negative (adjusting the Binding Start Date in the past). |
adjust_by_uot | String | The unit of time that can be used to measure the period denoted in adjust_by_period. The applicable values are:
|
Name | Type | Description |
|---|---|---|
concurrent_usage | Number | Defines the concurrent usage of services which will be billed based on the specified billing terms |
rate_percentage  | Number | Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms |