pub struct Quote {Show 34 fields
pub id: QuoteId,
pub amount_subtotal: i64,
pub amount_total: i64,
pub application: Option<Expandable<Application>>,
pub application_fee_amount: Option<i64>,
pub application_fee_percent: Option<f64>,
pub automatic_tax: QuotesResourceAutomaticTax,
pub collection_method: QuoteCollectionMethod,
pub computed: QuotesResourceComputed,
pub created: Timestamp,
pub currency: Option<Currency>,
pub customer: Option<Expandable<Customer>>,
pub default_tax_rates: Option<Vec<Expandable<TaxRate>>>,
pub description: Option<String>,
pub discounts: Vec<Expandable<Discount>>,
pub expires_at: Timestamp,
pub footer: Option<String>,
pub from_quote: Option<QuotesResourceFromQuote>,
pub header: Option<String>,
pub invoice: Option<Expandable<Invoice>>,
pub invoice_settings: InvoiceSettingQuoteSetting,
pub line_items: Option<List<CheckoutSessionItem>>,
pub livemode: bool,
pub metadata: Metadata,
pub number: Option<String>,
pub on_behalf_of: Option<Expandable<Account>>,
pub status: QuoteStatus,
pub status_transitions: QuotesResourceStatusTransitions,
pub subscription: Option<Expandable<Subscription>>,
pub subscription_data: QuotesResourceSubscriptionDataSubscriptionData,
pub subscription_schedule: Option<Expandable<SubscriptionSchedule>>,
pub test_clock: Option<Expandable<TestHelpersTestClock>>,
pub total_details: QuotesResourceTotalDetails,
pub transfer_data: Option<QuotesResourceTransferData>,
}
Expand description
The resource representing a Stripe “Quote”.
For more details see https://stripe.com/docs/api/quotes/object
Fields§
§id: QuoteId
Unique identifier for the object.
amount_subtotal: i64
Total before any discounts or taxes are applied.
amount_total: i64
Total after discounts and taxes are applied.
application: Option<Expandable<Application>>
ID of the Connect Application that created the quote.
application_fee_amount: Option<i64>
The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner’s Stripe account.
Only applicable if there are no line items with recurring prices on the quote.
application_fee_percent: Option<f64>
A non-negative decimal between 0 and 100, with at most two decimal places.
This represents the percentage of the subscription invoice total that will be transferred to the application owner’s Stripe account. Only applicable if there are line items with recurring prices on the quote.
automatic_tax: QuotesResourceAutomaticTax
§collection_method: QuoteCollectionMethod
Either charge_automatically
, or send_invoice
.
When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer.
When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as active
.
Defaults to charge_automatically
.
computed: QuotesResourceComputed
§created: Timestamp
Time at which the object was created.
Measured in seconds since the Unix epoch.
currency: Option<Currency>
Three-letter ISO currency code, in lowercase.
Must be a supported currency.
customer: Option<Expandable<Customer>>
The customer which this quote belongs to.
A customer is required before finalizing the quote. Once specified, it cannot be changed.
default_tax_rates: Option<Vec<Expandable<TaxRate>>>
The tax rates applied to this quote.
description: Option<String>
A description that will be displayed on the quote PDF.
discounts: Vec<Expandable<Discount>>
The discounts applied to this quote.
expires_at: Timestamp
The date on which the quote will be canceled if in open
or draft
status.
Measured in seconds since the Unix epoch.
A footer that will be displayed on the quote PDF.
from_quote: Option<QuotesResourceFromQuote>
Details of the quote that was cloned.
See the cloning documentation for more details.
header: Option<String>
A header that will be displayed on the quote PDF.
invoice: Option<Expandable<Invoice>>
The invoice that was created from this quote.
invoice_settings: InvoiceSettingQuoteSetting
§line_items: Option<List<CheckoutSessionItem>>
A list of items the customer is being quoted for.
livemode: bool
Has the value true
if the object exists in live mode or the value false
if the object exists in test mode.
metadata: Metadata
Set of key-value pairs that you can attach to an object.
This can be useful for storing additional information about the object in a structured format.
number: Option<String>
A unique number that identifies this particular quote.
This number is assigned once the quote is finalized.
on_behalf_of: Option<Expandable<Account>>
The account on behalf of which to charge.
See the Connect documentation for details.
status: QuoteStatus
The status of the quote.
status_transitions: QuotesResourceStatusTransitions
§subscription: Option<Expandable<Subscription>>
The subscription that was created or updated from this quote.
subscription_data: QuotesResourceSubscriptionDataSubscriptionData
§subscription_schedule: Option<Expandable<SubscriptionSchedule>>
The subscription schedule that was created or updated from this quote.
test_clock: Option<Expandable<TestHelpersTestClock>>
ID of the test clock this quote belongs to.
total_details: QuotesResourceTotalDetails
§transfer_data: Option<QuotesResourceTransferData>
The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices.