Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titlesubscription_billing_terms object parameter data

Name

Type

Description

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:

Include Page
price_plan_identifier
price_plan_identifier

Tip

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

billing_cycle_day

(optional)

NumberThe 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. If not specified then it defaults to the billing cycle day specified on 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.

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"

performed_by_user_identifier

(optional)

User identifier

 The user that actually performed the action. This information is applicable only if the job type fulfillment scope is set to New Subscription. The allowed user identifier fields are the following:

Include Page
user_identifier
user_identifier

performed_on

(optional)

Date The date that the action was actually performed. This information is applicable only if the job type fulfillment scope is set to New Subscription.

binding_information

(optional)

Binding information objectThe 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 objectConcurrent 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

Anchor
billing_terms referred object parameters
billing_terms referred object parameters
Referred Objects Response Data

Include Page
binding_information_parameters
binding_information_parameters

Include Page
concurrent_usage_based_pricing_parameters
concurrent_usage_based_pricing_parameters