APIQuote.md

APIQuote

Properties

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]
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	str	{"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	str	{"description":"Name of the product for which a price quote is requested.","verbs":["POST","GET"]}	[optional]
public_product_name	str	{"description":"Public name of the product for which a price quote is requested.","verbs":["POST","GET"]}	[optional]
product_rate_plan_name	str	{"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	str	{"description":"Public name of the rate plan (of some product) for which a price quote is requested.","verbs":["POST","GET"]}	[optional]
product_id	str	{"description":"ID of the product for which a price quote is requested.","verbs":["POST","GET"]}	[optional]
product_rate_plan_id	str	{"description":"ID of the rate plan (of some product) 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]
account_id	str	{"description":"ID of the account for which a price quote is requested.","verbs":["POST","GET"]}	[optional]
quantities	list[APIQuoteResponseQuantity]	{"description":"A list of calculated prices for each pricing component described in the quote request.","verbs":["POST","GET"]}	[optional]
discounts	list[CouponWrapperResponse]	{"description":"A list of discounts applied in calculating the quote.","verbs":["POST","GET"]}	[optional]
quote_for	str	{"default":"RecurringPeriod","description":"Subscription scenario with which the quote is concerned.","verbs":["POST","GET"]}	[optional]
period_start	datetime	{"default":"(Time at which quote is requested)","description":"The start date-time of the interval for which a price quote is requested.","verbs":["POST","GET"]}
period_end	datetime	{"default":"(End of period described in `periodStart`)","description":"The end date-time of the interval for which a price quote is requested.","verbs":["POST","GET"]}
total_periods	float	{"default":"ZERO","description":"","verbs":["POST","GET"]}	[optional]
proration_enabled	bool	{"default":true,"description":"Whether consumption for fractions/multiples of periods is calculated as a fraction/multiple of the cost of consumption for a whole period.","verbs":["POST","GET"]}	[optional] [default to False]
uplift	float	{"description":"","verbs":["POST","GET"]}	[optional]
coupon_codes	list[str]	{"description":"A list of coupon codes to consider in calculating the quote.","verbs":["POST","GET"]}	[optional]
organization_id	str	{"description":"ID of the organization in whose name the quote was generated.","verbs":["POST","GET"]}	[optional]
same_product_period	bool	{"description":"If migration quote whether or not the rate plans have the same duration","verbs":["POST","GET"]}	[optional] [default to False]

[Back to Model list] [Back to API list] [Back to README]