billing_terms_jobs_parameters

 job_billing_terms object parameter data

Name

Type

Description

billing_term_scheme_identifier

(mandatory)

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

id

(semi-optional)

String

The ID of the billing term scheme

code

(semi-optional)

String

The code of the billing term scheme

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

id

(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

agreement_date

(mandatory)

DateThe 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.

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 object is deprecated in CRM.COM R10.0.0 onwards

Referred Objects Response Data

 

 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