job_amend_subscription_billing_terms_update_parameters

 job_amend_subscription_billing_terms object parameter data

Name

Type

Description

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

billing_cycle_day

(semi-optional and applicable on conditions)

Number

The billing cycle day of the billing terms that will be created. Applicable and mandatory only when Billing Term Scheme specifies an Anniversary Billing

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)

BooleanDefines that the billing cycle date is the last day of each month. Applicable only for Anniversary subscriptions. Either a specific day of month (billing_cycle_day) or the last day of month can be specified in these cases

billing_frequency

(mandatory on conditions)

String

The billing frequency of the billing terms that will be created.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

price_plan_identifier

(mandatory and applicable on conditions)

Price plan identifier

The price plan that will be used on the 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

This information is available ONLY if classification_code is:

  • NO_BINDING_PERIOD_TERM_CHANGES

amend_billing_terms_classification

(mandatory)

String

The business classification of the requested subscription billing term amendments. Available values are :

  • 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
binding_period_informationBinding information object

The binding information of the billing term that will be created. 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
binding_period_extended_byExtended Binding Period Information Object

Information related to the requested extension of the binding period

This information is available ONLY if classification code is:

    • EXTENDED_BINDING_PERIOD_TERMS
binding_period_adjusted_byAdjusted Binding Period Information ObjectInformation related to the requested adjustment of the binding period.

This information is available ONLY if classification code is:

    • ADJUSTED_BINDING_PERIOD_TERMS
concurrent_usage_based_pricingConcurrent usage based pricing object

Information regarding the subscription's concurrent usage. This information is available ONLY if selected Billing Term Scheme is of type NORMAL and classification_code is:

  • NO_BINDING_PERIOD_TERM_CHANGE

Referred Parameter Objects Data

 time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS