Skip to content
This repository was archived by the owner on Oct 17, 2023. It is now read-only.

Latest commit

 

History

History
36 lines (33 loc) · 6.82 KB

APIQuote.md

File metadata and controls

36 lines (33 loc) · 6.82 KB

Bfwd::APIQuote

Properties

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]
subtotal Float {"description":"The cost — including tax, but excluding discounts — of all items described in the quote.","verbs":["POST","GET"]} [optional]
subtotal_excluding_tax Float {"description":"The cost — excluding tax, and excluding discounts — of all items described in the quote.","verbs":["POST","GET"]} [optional]
total Float {"description":"The cost — including tax, and with discounts (themselves including tax) applied — of all items described in the quote.","verbs":["POST","GET"]} [optional]
total_excluding_tax Float {"description":"The cost — excluding tax, and with discounts (themselves excluding tax) applied — of all items described in the quote.","verbs":["POST","GET"]} [optional]
tax Float {"description":"The portion of this quote's cost which is comprised of tax.","verbs":["POST","GET"]} [optional]
discount Float {"description":"Total amount deducted from price via discounts — includes any tax upon the discounts themselves.","verbs":["POST","GET"]} [optional]
discount_excluding_tax Float {"description":"Total amount deducted from price via discounts — excludes any tax upon the discounts themselves.","verbs":["POST","GET"]} [optional]
currency String {"description":"The currency of any quoted prices — as specified by a three-character ISO 4217 currency code (i.e. USD).","verbs":["POST","GET"]} [optional]
product_name String {"description":"Name of the product for which a price quote is requested.","verbs":["POST","GET"]} [optional]
public_product_name String {"description":"Public name of the product for which a price quote is requested.","verbs":["POST","GET"]} [optional]
product_rate_plan_name String {"description":"Name of the rate plan (of some product) for which a price quote is requested.","verbs":["POST","GET"]} [optional]
public_product_rate_plan_name String {"description":"Public name of the rate plan (of some product) for which a price quote is requested.","verbs":["POST","GET"]} [optional]
product_id String {"description":"ID of the product for which a price quote is requested.","verbs":["POST","GET"]} [optional]
product_rate_plan_id String {"description":"ID of the rate plan (of some product) for which a price quote is requested.","verbs":["POST","GET"]} [optional]
subscription_id String {"description":"ID of the subscription for which a price quote is requested.","verbs":["POST","GET"]} [optional]
account_id String {"description":"ID of the account for which a price quote is requested.","verbs":["POST","GET"]} [optional]
quantities Array<APIQuoteResponseQuantity> {&quot;description&quot;:&quot;A list of calculated prices for each pricing component described in the quote request.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
discounts Array<CouponWrapperResponse> {&quot;description&quot;:&quot;A list of discounts applied in calculating the quote.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
quote_for String {&quot;default&quot;:&quot;RecurringPeriod&quot;,&quot;description&quot;:&quot;Subscription scenario with which the quote is concerned.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
period_start DateTime {&quot;default&quot;:&quot;(Time at which quote is requested)&quot;,&quot;description&quot;:&quot;The start date-time of the interval for which a price quote is requested.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]}
period_end DateTime {&quot;default&quot;:&quot;(End of period described in `periodStart`)&quot;,&quot;description&quot;:&quot;The end date-time of the interval for which a price quote is requested.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]}
total_periods Float {&quot;default&quot;:&quot;ZERO&quot;,&quot;description&quot;:&quot;&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
proration_enabled BOOLEAN {&quot;default&quot;:true,&quot;description&quot;:&quot;Whether consumption for fractions/multiples of periods is calculated as a fraction/multiple of the cost of consumption for a whole period.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional] [default to false]
uplift Float {&quot;description&quot;:&quot;&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
coupon_codes Array<String> {&quot;description&quot;:&quot;A list of coupon codes to consider in calculating the quote.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
organization_id String {&quot;description&quot;:&quot;ID of the organization in whose name the quote was generated.&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional]
same_product_period BOOLEAN {&quot;description&quot;:&quot;If migration quote whether or not the rate plans have the same duration&quot;,&quot;verbs&quot;:[&quot;POST&quot;,&quot;GET&quot;]} [optional] [default to false]