billing_terms_jobs_short

 job_billing_terms object response data

Name

Type

Description

id

String

The ID of the retrieved billing terms

life_cycle_stateStringThe life cycle state of the retrieved billing terms which can be EFFECTIVE or TERMINATED
agreement_dateDateThe agreement date of the retrieved billing terms. Billing terms agreement date is used to log the date that the billing terms were agreed and signed by the customer
effective_dateDate The effective date of the retrieved billing terms
expiration_dateDateThe expiration date of the retrieved billing terms
concurrent_usage_based_pricingConcurrent 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 services

Not available from CRM.COM R10.0.0 and onward

billing_term_schemeBilling term scheme objectThe billing term scheme of the retrieved billing terms
price_planPrice plan objectThe price plan of the retrieved billing terms

Referred Objects Response Data

 concurrent_usage_based_pricing object response data

Name

Type

Description

concurrent_usage

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

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_itemsNumber

The agreed number of installed items that will be concurrently consuming the subscription's services

Available from CRM.COM R15.0.0

 concurrent_usage_billing_methodString

Defines how the subscriber will be billed because of the concurrent usage of the subscription's services. Available options are:

  • BASED_ON_NUMBER_OF_INSTALLED_ITEMS,
  • BASED_ON_MAXIMUM_CAPACITY
  • BASED_ON_ACTUAL_CAPACITY

Available from CRM.COM R15.0.0


 billing_term_scheme object response data

Name

Type

Description

id

String

The ID of the retrieved billing term scheme

codeStringThe code of the retrieved billing term scheme
nameStringThe name of the retrieved billing term scheme
life_cycle_stateString

The life cycle state of the retrieved billing term scheme. The supported life cycle states are the following

DRAFT, EFFECTIVE, TERMINATED

classificationString

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_typeString

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_methodStringThe billing method of the billing term scheme which can be ANNIVERSARY or PERIOD

 price_plan object data response
NameType Description
IdStringThe ID of the retrieved price plan
nameStringThe Name of the retrieved price plan
codeStringThe Code of the retrieved price plan
descriptionStringThe Description of the retrieved price plan
typeStringThe Type of the retrieved price plan which can be BASE or CONDITIONAL
effective_date DateThe Effective Date of the retrieved price plan
expiration_date Date

The Expiration Date of the retrieved price plan

currencyCurrency Object

The Currency of the retrieved price plan

Available from CRM.COM R14.2.0

Referred Objects Response Data

 currency object response data

Name

Type

Description

id

String

The ID of the retrieved currency

code

String

The code of the retrieved currency

prefix_symbolStringThe prefix symbol for the specified currency

suffix_symbol

StringThe suffix symbol for the specified currency
life_cycle_stateString

The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE

Available from CRM.COM R14.0.0

integer_part_nameStringThe integer part name for the specified currency
decimal_part_nameStringThe decimal part name for the specified currency