Mayson Monorepo Documentation
    Preparing search index...

    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.

    interface Quote {
        id: string;
        object: "quote";
        amount_subtotal: number;
        amount_total: number;
        application: string | Application | DeletedApplication;
        application_fee_amount: number;
        application_fee_percent: number;
        automatic_tax: Stripe.Quote.AutomaticTax;
        collection_method: Stripe.Quote.CollectionMethod;
        computed: Stripe.Quote.Computed;
        created: number;
        currency: string;
        customer: string | Stripe.Customer | DeletedCustomer;
        customer_account: string;
        default_tax_rates?: (string | Stripe.TaxRate)[];
        description: string;
        discounts: (string | Stripe.Discount)[];
        expires_at: number;
        footer: string;
        from_quote: Stripe.Quote.FromQuote;
        header: string;
        invoice: string | Stripe.Invoice | DeletedInvoice;
        invoice_settings: Stripe.Quote.InvoiceSettings;
        line_items?: ApiList<Stripe.LineItem>;
        livemode: boolean;
        metadata: Metadata;
        number: string;
        on_behalf_of: string | Stripe.Account;
        status: Stripe.Quote.Status;
        status_transitions: Stripe.Quote.StatusTransitions;
        subscription: string | Stripe.Subscription;
        subscription_data: Stripe.Quote.SubscriptionData;
        subscription_schedule: string | Stripe.SubscriptionSchedule;
        test_clock: string | Stripe.TestHelpers.TestClock;
        total_details: Stripe.Quote.TotalDetails;
        transfer_data: Stripe.Quote.TransferData;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "quote"

    String representing the object's type. Objects of the same type share the same value.

    amount_subtotal: number

    Total before any discounts or taxes are applied.

    amount_total: number

    Total after discounts and taxes are applied.

    application: string | Application | DeletedApplication

    ID of the Connect Application that created the quote.

    application_fee_amount: number

    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: number

    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: Stripe.Quote.AutomaticTax
    collection_method: Stripe.Quote.CollectionMethod

    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.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    customer: string | Stripe.Customer | DeletedCustomer

    The customer who received this quote. A customer is required to finalize the quote. Once specified, you can't change it.

    customer_account: string

    The account representing the customer who received this quote. A customer or account is required to finalize the quote. Once specified, you can't change it.

    default_tax_rates?: (string | Stripe.TaxRate)[]

    The tax rates applied to this quote.

    description: string

    A description that will be displayed on the quote PDF.

    discounts: (string | Stripe.Discount)[]

    The discounts applied to this quote.

    expires_at: number

    The date on which the quote will be canceled if in open or draft status. Measured in seconds since the Unix epoch.

    footer: string

    A footer that will be displayed on the quote PDF.

    from_quote: Stripe.Quote.FromQuote

    Details of the quote that was cloned. See the cloning documentation for more details.

    header: string

    A header that will be displayed on the quote PDF.

    invoice: string | Stripe.Invoice | DeletedInvoice

    The invoice that was created from this quote.

    invoice_settings: Stripe.Quote.InvoiceSettings
    line_items?: ApiList<Stripe.LineItem>

    A list of items the customer is being quoted for.

    livemode: boolean

    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: string

    A unique number that identifies this particular quote. This number is assigned once the quote is finalized.

    on_behalf_of: string | Stripe.Account

    The account on behalf of which to charge. See the Connect documentation for details.

    The status of the quote.

    status_transitions: Stripe.Quote.StatusTransitions
    subscription: string | Stripe.Subscription

    The subscription that was created or updated from this quote.

    subscription_data: Stripe.Quote.SubscriptionData
    subscription_schedule: string | Stripe.SubscriptionSchedule

    The subscription schedule that was created or updated from this quote.

    test_clock: string | Stripe.TestHelpers.TestClock

    ID of the test clock this quote belongs to.

    total_details: Stripe.Quote.TotalDetails
    transfer_data: Stripe.Quote.TransferData

    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.