Skip to end of metadata
Go to start of metadata
subscription_billing_terms object parameter data
Name | Type | Description |
|---|
price_plan_identifier (mandatory) | 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 |
|
billing_cycle_day (optional) | Number | The 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) | Date | The 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: Name | Type | Description |
|---|
id (semi-optional) | String | The ID of the user | username (semi-optional) | String | The username of the user |
|
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 object | The 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 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 |
Referred Objects Response Data
binding_information object parameter data
Name | Type | Description |
|---|
binding_period (mandatory) | String | The binding period which can be one of the following: WEEK, MONTH, QUARTER, BIANNUAL, ANNUAL, TWOYEARS, CUSTOM1, CUSTOM2, CUSTOM3, CUSTOM4, CUSTOM5 |
start_date (mandatory on conditions) | Date | The date that the binding period starts. |
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 |
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 |
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". |
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". |