| 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] |
| id | String | { "description" : "", "verbs":["GET"] } | |
| version_id | String | { "description" : "", "verbs":["GET"] } | [optional] |
| pricing_component_id | String | { "description" : "", "verbs":["POST","GET"] } | |
| pricing_component_name | String | { "description" : "Name of the pricing-component associated with the pricing-component-value.", "verbs":["GET"] } | [optional] |
| subscription_id | String | { "description" : "Value can be left null if setting the pricing component value on the subscription directly.", "verbs":["GET", "POST"] } | |
| organization_id | String | { "description" : "", "verbs":["GET"] } | [optional] |
| value | Integer | { "description" : "Quantity of a particular pricing component the subscription should have. For example if you have a pricing component for widgets, where $5/widget/month and you set the value to 10 then the customer will be charged $50 ($5 x 10) monthly.", "verbs":["POST","PUT","GET"] } | |
| applies_from | DateTime | { "description" : "<p>The appliesFrom can be left null. If appliesFrom is set, it indicates when a value came into effect.</p>", "verbs":["POST","PUT","GET"] } | [optional] |
| applies_till | DateTime | { "description" : "<p>For <span class=\"label label-default\">setup</span>, <span class=\"label label-default\">subscription</span>, and <span class=\"label label-default\">arrears</span> pricing components if appliesTill is specificed the value will be used whilst the time has not been reached. If appliesTill is null the pricing component value will be used until a new value is added. When a new value is added appliesTill will be set to the time the new value will take effect.</p><p><span class=\"label label-default\">usage</span> pricing applies to the previous billing period as it is charged in-arrears. When adding usage a new pricing component value should be added with appliesTill set to the end of the usages billing period. For example a monthly subscription results in an invoice being generated on the 1<sup>st</sup> of March, the previous months usage period ended on the same date. A usage value should be added to the subscription with the appliesTill set to the invoices periodStart, the 1<sup>st</sup> of March.</p>", "verbs":["POST","PUT","GET"] } | [optional] |
| pending_change | PendingComponentValueChange | [optional] |
This repository has been archived by the owner on Oct 17, 2023. It is now read-only.