Defines the object schema located at components.schemas.quote in the specification.
A Quote is a way to model prices that you'd like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.
Constructors
QuotequoteAmountSubtotal :: Intamount_subtotal: Total before any discounts or taxes are applied.
quoteAmountTotal :: Intamount_total: Total after discounts and taxes are applied.
quoteApplication :: Maybe (Nullable QuoteApplication'NonNullableVariants)application: ID of the Connect Application that created the quote.
quoteApplicationFeeAmount :: Maybe (Nullable Int)application_fee_amount: 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.
quoteApplicationFeePercent :: Maybe (Nullable Double)application_fee_percent: A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.
quoteAutomaticTax :: QuotesResourceAutomaticTaxautomatic_tax:
quoteCollectionMethod :: QuoteCollectionMethod'collection_method: 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. Defaults to `charge_automatically`.
quoteComputed :: QuotesResourceComputedcomputed:
quoteCreated :: Intcreated: Time at which the object was created. Measured in seconds since the Unix epoch.
quoteCurrency :: Maybe (Nullable Text)currency: Three-letter ISO currency code, in lowercase. Must be a supported currency.
Constraints:
Maximum length of 5000
quoteCustomer :: Maybe (Nullable QuoteCustomer'NonNullableVariants)customer: The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.
quoteDefaultTaxRates :: Maybe [QuoteDefaultTaxRates'Variants]default_tax_rates: The tax rates applied to this quote.
quoteDescription :: Maybe (Nullable Text)description: A description that will be displayed on the quote PDF.
Constraints:
Maximum length of 5000
quoteDiscounts :: [QuoteDiscounts'Variants]discounts: The discounts applied to this quote.
quoteExpiresAt :: Intexpires_at: The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch.
quoteFromQuote :: Maybe (Nullable QuoteFromQuote'NonNullable)from_quote: Details of the quote that was cloned. See the cloning documentation for more details.
quoteHeader :: Maybe (Nullable Text)header: A header that will be displayed on the quote PDF.
Constraints:
Maximum length of 5000
quoteId :: Textid: Unique identifier for the object.
Constraints:
Maximum length of 5000
quoteInvoice :: Maybe (Nullable QuoteInvoice'NonNullableVariants)invoice: The invoice that was created from this quote.
quoteInvoiceSettings :: Maybe (Nullable QuoteInvoiceSettings'NonNullable)invoice_settings: All invoices will be billed using the specified settings.
quoteLineItems :: Maybe QuoteLineItems'line_items: A list of items the customer is being quoted for.
quoteLivemode :: Boollivemode: Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
quoteMetadata :: Objectmetadata: 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.
quoteNumber :: Maybe (Nullable Text)number: A unique number that identifies this particular quote. This number is assigned once the quote is finalized.
Constraints:
Maximum length of 5000
quoteOnBehalfOf :: Maybe (Nullable QuoteOnBehalfOf'NonNullableVariants)on_behalf_of: The account on behalf of which to charge. See the Connect documentation for details.
quoteStatus :: QuoteStatus'status: The status of the quote.
quoteStatusTransitions :: QuotesResourceStatusTransitionsstatus_transitions:
quoteSubscription :: Maybe (Nullable QuoteSubscription'NonNullableVariants)subscription: The subscription that was created or updated from this quote.
quoteSubscriptionData :: QuotesResourceSubscriptionDatasubscription_data:
quoteSubscriptionSchedule :: Maybe (Nullable QuoteSubscriptionSchedule'NonNullableVariants)subscription_schedule: The subscription schedule that was created or updated from this quote.
quoteTestClock :: Maybe (Nullable QuoteTestClock'NonNullableVariants)test_clock: ID of the test clock this quote belongs to.
quoteTotalDetails :: QuotesResourceTotalDetailstotal_details:
quoteTransferData :: Maybe (Nullable QuoteTransferData'NonNullable)transfer_data: 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.