Mayson Monorepo Documentation
    Preparing search index...
    Index

    Properties

    application_fee_amount?: Emptyable<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. There cannot be any line items with recurring prices when using this field.

    application_fee_percent?: Emptyable<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. There must be at least 1 line item with a recurring price to use this field.

    Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.

    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or at invoice 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.

    customer?: string

    The customer for which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed.

    customer_account?: string

    The account for which this quote belongs to. A customer or account is required before finalizing the quote. Once specified, it cannot be changed.

    default_tax_rates?: Emptyable<string[]>

    The tax rates that will apply to any line item that does not have tax_rates set.

    description?: string

    A description that will be displayed on the quote PDF.

    The discounts applied to the quote.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    expires_at?: number

    A future timestamp 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.

    header?: string

    A header that will be displayed on the quote PDF.

    All invoices will be billed using the specified settings.

    A list of line items the customer is being quoted for. Each line item includes information about the product, the quantity, and the resulting cost.

    metadata?: MetadataParam

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    on_behalf_of?: string

    The account on behalf of which to charge.

    When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if subscription_data[effective_date] is present and in the future, otherwise a subscription is created.

    The data with which to automatically create a Transfer for each of the invoices.