package_billing_terms_short

 package billing terms object response data

Name

Type

Description

billing_frequencyString

The billing frequency provided by the package, if applicable. Applicable only for Normal Billing Term Schemes

binding_periodStringThe binding information provided by the package, if applicable. Applicable only for Normal Billing Term Schemes
billing_term_schemeBilling term scheme objectThe billing term scheme provided by the package
price_planPrice Plan ObjectThe price plan provided by the package

Referred Objects Response Data

 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