| Name | Type | Description | Notes |
|---|---|---|---|
| created | datetime | { "description" : "The UTC DateTime when the object was created.", "verbs":[] } | [optional] |
| changed_by | str | { "description" : "ID of the user who last updated the entity.", "verbs":[] } | [optional] |
| product | str | {"description":"The product for which a price quote is requested.","verbs":["POST","GET"]} | [optional] |
| product_rate_plan | str | {"description":"The rate plan (of some product) for which a price quote is requested.","verbs":["POST","GET"]} | |
| account_id | str | {"description":"ID of the account for which a price quote is requested.","verbs":["POST","GET"]} | [optional] |
| subscription_id | str | {"description":"ID of the subscription for which a price quote is requested.","verbs":["POST","GET"]} | [optional] |
| subscription_version_id | str | {"description":"version ID of the subscription for which a price quote is requested.","verbs":["POST","GET"]} | [optional] |
| quote_for | str | {"default":"RecurringPeriod","description":"Subscription scenario with which the quote is concerned.","verbs":["POST","GET"]} | [optional] |
| prorated | bool | {"default":true,"description":"Whether or not to pro-rate the price (if the quote concerns a time interval containing a partial period).","verbs":["POST","GET"]} | [optional] [default to False] |
| free | bool | {"default":false,"description":"Whether or not to present a waived final price in the quote.","verbs":["POST","GET"]} | [optional] [default to False] |
| include_applied_coupons | bool | {"default":true,"description":"Whether or not to include coupons which have already been applied to the subscription.","verbs":["POST","GET"]} | [optional] [default to False] |
| period_start | datetime | {"default":"(Now)","description":"The time-beginning of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.","verbs":["POST","GET"]} | [optional] |
| period_end | datetime | {"default":"(End of current period)","description":"The time-ending of the interval with which the quote is concerned. This can be used to request a quote across partial or multiple periods — potentially pro-rating its price.","verbs":["POST","GET"]} | |
| remaining_credit_behaviour | str | {"default":"<span class=\"label label-default\">Rollover</span>","description":"Defines the behaviour applied to any outstanding credit resulting from the application of the charge..<br><span class=\"label label-default\">Rollover</span> — Outstanding credit is returned to the accounts credit pool.<br><span class=\"label label-default\">Discard</span> — Outstanding credit is lost.","verbs":["POST","GET"]} | |
| quantities | list[QuoteRequestValue] | {"description":"A list of pricing components (and their values) to consider in calculating the quote.","verbs":["POST"]} | [optional] |
| coupon_codes | list[str] | {"description":"A list of coupon codes to consider in calculating the quote.","verbs":["POST","GET"]} | [optional] |
| pricing_behaviour | str | { "description" : "Pricing behaviour defines how migration charges are calculated. <span class=\"label label-default\">DifferenceProRated</span> calculates the difference between in-advance charges of the existing and new rate-plan, then pro-rates based on time remaining. <span class=\"label label-default\">None</span> sets the migration charge as zero cost. <span class=\"label label-default\">Full</span> sets the costs as the total of the new rate-plans in-advance charges. <span class=\"label label-default\">Difference</span> is the same calculation as <span class=\"label label-default\">DifferenceProRated</span> but no pro-ration is applied. <span class=\"label label-default\">ProRated</span> differs depending on two cases; when moving to a rate-plan of the same duration it pro-rates the in-advance charges of the new rate-plan. If the duration is different, a credit-note will be issued any remaining time on the existing plans billing period.", "default" : "DifferenceProRated", "verbs":["POST","GET"] } |
This repository was archived by the owner on Oct 17, 2023. It is now read-only.