Page Comparison

token

String

The token retrieved from the login method

subscription_identifier

(semi-optional)

The subscription to be modified. The allowed subscription identifier fields are the following:

accounts_receivable_identifier

(semi-optional)

The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:

business_classification_code

(mandatory)

The classification of the Amend Billing Terms Action which can be one of the following:

• NEW_BINDING_PERIOD_TERMS
• CANCELED_BINDING_PERIOD_TERMS
• RENEWED_BINDING_PERIOD_TERMS
• EXTENDED_BINDING_PERIOD_TERMS
• ADJUSTED_BINDING_PERIOD_TERMS
• NO_BINDING_PERIOD_TERM_CHANGES

action_type_identifier

(optional)

The action type that should be used. The allowed subscription action type identifier fields are the following:

sub_action_type_identifier

(optional)

Thesub action type that should be used. The allowed subscription sub action type identifier fields are the following:

transaction_reference_number

(optional)

The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions.

performed_by_user_identifier

(optional)

The user that actually performed the action. The allowed user identifier fields are the following:

performed_by_unit_identifier

(optional)

The unit that performed the action. The allowed unit identifier fields are the following:

performed_on

(optional)

agreement_date

(mandatory)

is_auto_renewed

(optional)

Defines whether the subscription's billing terms will be auto-renewed or not.

billing_cycle_day

(semi-optional and applicable on conditions)

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:

• NO_BINDING_PERIOD_TERM_CHANGES

billing_cycle_last_day_of_month

(semi-optional and applicable on conditions)

billing_frequency

(mandatory on conditions)

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:

• NO_BINDING_PERIOD_TERM_CHANGES

billing_term_scheme_identifier

(mandatory and applicable on conditions)

The billing term scheme that will be used on the billing terms. The allowed billing term scheme identifier fields are the following:

This information is available ONLY if classification_code is:

• NO_BINDING_PERIOD_TERM_CHANGES

price_plan_identifier

(mandatory and applicable on conditions)

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:

• NO_BINDING_PERIOD_TERM_CHANGES

scheduled_date

(optional)

The date that the action is scheduled to be executed. If not specified then the action will be executed immediately

use_proposed_scheduled_date

(optional)

Defines whether the scheduled date automatically calculated and proposed by the system based on business rules, will be automatically set as the subscription's scheduled date or not. Applicable only if the subscription action includes a scheduled date and only if this scheduled date does not meet the business rules.

udf_string_1 

(optional)

User DefinedField Defined Field of type String

udf_string_2 

(optional)

User DefinedField Defined Field of type String

udf_string_3 

(optional)

User DefinedField Defined Field of type String

udf_string_4 

(optional)

User DefinedField Defined Field of type String

udf_string_5

(optional)

User DefinedField Defined Field of type String

udf_string_6 

(optional)

User DefinedField Defined Field of type String

udf_string_7

(optional)

User DefinedField Defined Field of type String

udf_string_8

(optional)

User DefinedField Defined Field 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

binding_information

(mandatory and applicable on conditions)

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:

• NEW_BINDING_PERIOD_TERMS

extended_by_information

(mandatory and applicable on conditions)

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:

• EXTENDED_BINDING_PERIOD_TERMS

adjust_by_information

(mandatory and applicable on conditions)

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:

• ADJUSTED_BINDING_PERIOD_TERMS 

concurrent_usage_based_pricing

(mandatory on conditions)

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 concurrent usage is enabled and classification_code is:

• NO_BINDING_PERIOD_TERM_CHANGES

services_period_billed_in_advance

(optional and based on conditions)

Includes a set of services and for each service its period to be billed in advance is provided. Applicable only for prepaid pre-rated services and only in case sin which the period to be billed in advance for at leas tone of these services is required.

This information is available ONLY if selected Billing Term Scheme is of type PREPAID, the services have billing type "Pre-rate" and classification_code is:

• NO_BINDING_PERIOD_TERM_CHANGES

period_billed_in_advance

(mandatory on conditions)

The period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. If nothing is specified then the default value will be provided

(mandatory on conditions)

The unit of time for the period that the specified service will be billed in advance. Applicable and mandatory only for prepaid and pre-rated billing term scheme. The supported values are DAYS, WEEKS or MONTHS. If nothing is specified then the default value will be provided

fields_set

(optional)

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