| Name | Type | Description | Notes |
|---|---|---|---|
| created | DateTime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | String | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| updated | DateTime | { "description" : "The UTC DateTime when the object was last updated.", "verbs":[] } | [optional] |
| type | String | { "description" : "", "default" : "", "verbs":["POST","GET"] } | |
| version_id | String | { "description" : "", "verbs":["GET"] } | |
| crm_id | String | { "description" : "", "verbs":["POST","PUT","GET"] } | [optional] |
| id | String | { "description" : "", "verbs":["GET"] } When associating a pricing component with a product rate plan, this ID should be used. | |
| product_rate_plan_id | String | { "description" : "", "verbs":["POST","PUT","GET"] } | |
| unit_of_measure_id | String | { "description" : "", "verbs":["POST","PUT","GET"] } | |
| organization_id | String | { "description" : "", "verbs":[] } | |
| name | String | { "description" : "", "verbs":["POST","PUT","GET"] } | |
| public_name | String | {"description":"A friendly non-unique name used to identify this pricing-component","verbs":["POST","PUT","GET"]} | [optional] |
| description | String | { "description" : "", "verbs":["POST","PUT","GET"] } | [optional] |
| charge_type | String | { "description" : "The charge type of the pricing-component.", "verbs":["POST","PUT","GET"] } | |
| invoicing_type | String | { "default" : "Aggregated", "description" : "For <span class=\"label label-default\">setup</span> pricing components <span class=\"label label-default\">Immediate</span> invoicing will result in an invoice being issued on subscription being set to the AwaitingPayment state, irrespective of the subscription start date. <span class=\"label label-default\">Aggregated</span> invoicing will add a charge to the first invoice of the subscription.", "verbs":["POST","PUT","GET"] } | [optional] |
| charge_model | String | { "description" : "The charge model of the pricing-component.", "verbs":["POST","PUT","GET"] } | |
| upgrade_mode | String | {"default":"<span class=\"label label-default\">immediate</span>","description":"Default behaviour when a value is upgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\"label label-default\">immediate</span> — Upgrade will apply at the time the request is made.<br><span class=\"label label-default\">delayed</span> — Upgrade will apply at the end of the current billing cycle.","verbs":["POST","GET"]} | [optional] |
| downgrade_mode | String | {"default":"<span class=\"label label-default\">delayed</span>","description":"Default behaviour when a value is downgraded using this pricing component, this behaviour can be overridden when changing the value.<br><span class=\"label label-default\">immediate</span> — Downgrade will apply at the time the request is made.<br><span class=\"label label-default\">delayed</span> — Downgrade will apply at the end of the current billing cycle.","verbs":["POST","GET"]} | [optional] |
| default_quantity | Integer | { "description" : "The default quantity of the pricing-component. If no value is supplied on a subscription this value will be used. This is useful for setting an expected purchase level of for introducing new pricing components to existing subscriptions and not having to back-fill values", "verbs":["POST","PUT","GET"] } | |
| min_quantity | Integer | { "default" : "0", "description" : "The minimum quantity of the pricing-component.", "verbs":[] } | [optional] |
| max_quantity | Integer | { "description" : "The maximum quantity of the pricing-component.", "verbs":[] } | [optional] |
| valid_from | DateTime | { "default" : "current time", "description" : "The DateTime specifying when the pricing-component is valid from.", "verbs":["POST","PUT","GET"] } | |
| valid_till | DateTime | { "default" : "null", "description" : "The UTC DateTime specifying when the pricing-component is valid till.", "verbs":["POST","PUT","GET"] } | [optional] |
| tiers | Array<PricingComponentTier> | { "default" : "[]", "description" : "The pricing-component-tiers associated with the pricing-component.", "verbs":["POST","PUT","GET"] } | [optional] |
| unit_of_measure | UnitOfMeasure | { "description" : "The unit-of-measure associated with the pricing-component.", "verbs":["POST","PUT","GET"] } | [optional] |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.