billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory on conditions)

Billing term scheme identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

The billing_term_scheme_identifier is considered as mandatory up until CRM.COM R13.0.0.

From CRM.COM R14.0.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package. Subscription Types of classification Package provide a default Billing Term scheme and the billing_term_scheme_identifier is not applicable in such cases.

price_plan_identifier

(mandatory on conditions)

Price plan identifier

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

Name

Type

Description

(semi-optional)

String

The ID of the price plan

code

(semi-optional)

String

The code of the price plan

The price_plan_identifier is considered as mandatory up until CRM.COM R11.2.0. From CRM.COM R11.2.0 the identifier becomes mandatory on conditions, which means that it is mandatory only as long as no default price plan is specified in the Billing Term Scheme

From CRM.COM R14.0.0 if the subscription's type is of classification Package which provides a default Price Plan, then that price plan is automatically applied and the price_plan_identifier is not applicable.

Deprecated from CRM.COM R15.0.0

is_auto_renewed

(optional)

Boolean

Defines whether the subscription's billing terms will be auto-renewed or not. If not specified, then the subscription's billing terms are marked as auto-renewed.

Available from CRM.COM R15.0.0

billing_cycle_day

(mandatory 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. Mandatory if no automations on how the billing cycle day should be set are defined in the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case.

From CRM.COM R12.0.0, billing_cycle_day becomes mandatory on conditions. In previous releases this is optional.

billing_cycle_last_day_of_month

(mandatory on conditions)

Boolean

Defines whether Anniversary Subscriptions will be billed up until the last day of each month. Applicable only for Anniversary subscriptions and only if no automations on how the billing cycle day is set are defined on the Billing Term Scheme. Either a specific billing cycle day or the fact that the billing cycle day is the last day of each month are mandatory in this case.

Available from CRM.COM R12.0.0

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_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

Billing frequency is applicable and mandatory only if the specified billing term scheme is of type "Normal"

From CRM.COM R14.0.0 the billing frequency is not mandatory if the subscription's type is of classification Package that provides a default Billing Frequency (it can be amended though).

binding_information

(optional)

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.

concurrent_usage_based_pricing

(mandatory on conditions)

Concurrent usage based pricing object

Concurrent usage based pricing is used to apply pricing and billing rules based on the subscription's concurrent usage 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

period_billed_in_advance

(mandatory on conditions)

float

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

Icon

Available from CRM.COM R15.0.0

period_billed_in_advance_uot

(mandatory on conditions)

String

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

Icon

Available from CRM.COM R15.0.0

Referred Objects Response Data

binding_information object parameter data

Name	Type	Description
binding_period (mandatory)	String	The binding period which can be one of the following: WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 From CRM.COM R14.0.0 the binding period becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package which provides a default Binding period (it can be amended though). From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)
start_date (mandatory on conditions)	Date	The date that the binding period starts. From CRM.COM R14.0.0 onwards start_date is mandatory only if no configuration exists in Subscription Billing Term Definitions related to Binding Start Date Automation. From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)

Name

Type

Description

binding_period

(mandatory)

String

The binding period which can be one of the following:

WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5

From CRM.COM R14.0.0 the binding period becomes mandatory on conditions, which means that it is mandatory only as long as the subscription's type is not of classification Package which provides a default Binding period (it can be amended though).

From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)

start_date

(mandatory on conditions)

Date

The date that the binding period starts.

From CRM.COM R14.0.0 onwards start_date is mandatory only if no configuration exists in Subscription Billing Term Definitions related to Binding Start Date Automation.

From CRM.COM R18.0.0 the binding period is mandatory (Package subscription types are deprecated)

concurrent_usage_based_pricing object parameter data

Name	Type	Description
concurrent_usage (mandatory)	Number	Defines the concurrent usage of services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
rate_percentage (mandatory)	Number	Defines the rate percentage that should be applied on all services which will be billed based on the specified billing terms Deprecated from CRM.COM R15.0.0
number_of_installed_items (mandatory on conditions)	Number	The agreed number of installed items that will be concurrently consuming the related subscription's services. Applicable and mandatory if concurrent usage billing method is set to "based on number of installed items". Available from CRM.COM R15.0.0
concurrent_usage_billing_method (mandatory)	String	Defines how the subscription will be billed for the agreed concurrent usage. Available options are: BASED_ON_NUMBER_OF_INSTALLED_ITEMS BASED_ON_MAXIMUM_CAPACITY BASED_ON_ACTUAL_CAPACITY If not specified, then the billing method is considered as "based on number of installed items". Available from CRM.COM R15.0.0