Core Resources
Payment Methods
Money Management
Products
Product Catalog
Commerce
Agentic Commerce
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury for Platforms
Payment Records
Account Evaluation
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Tax Reporting
Forwarding
Privacy
Webhooks

The Quote object v1

Attributes

  • idstring

    Unique identifier for the object.

  • line_itemsobjectIncludable

    A list of items the customer is being quoted for.

  • metadatamap

    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.

More attributes

  • objectstring, value is "quote"

  • amount_subtotalinteger

  • amount_totalinteger

  • applicationnullable stringExpandableConnect only

  • application_fee_amountnullable integerConnect only

  • application_fee_percentnullable numberConnect only

  • automatic_taxobject

  • collection_methodenum

  • computedobject

  • createdtimestamp

  • currencynullable string

  • customernullable stringExpandable

  • customer_accountnullable string

  • default_tax_ratesarray of stringsExpandable

  • descriptionnullable string

  • discountsarray of stringsExpandable

  • expires_attimestamp

  • footernullable string

  • from_quotenullable object

  • headernullable string

  • invoicenullable stringExpandable

  • invoice_settingsobject

  • livemodeboolean

  • numbernullable string

  • on_behalf_ofnullable stringExpandableConnect only

  • statusenum

  • status_transitionsobject

  • subscriptionnullable stringExpandable

  • subscription_dataobject

  • subscription_schedulenullable stringExpandable

  • test_clocknullable stringExpandable

  • total_detailsobject

  • transfer_datanullable objectConnect only

The Quote object
{
  "id": "",
  "object": "quote",
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "application": null,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "collection_method": "charge_automatically",
  "computed": {
    "recurring": null,
    "upfront": {
      "amount_subtotal": 2198,
      "amount_total": 2198,
      "total_details": {
        "amount_discount": 0,
        "amount_shipping": 0,
        "amount_tax": 0
      }
    }
  },
  "created": 1680130691,
  "currency": "usd",
  "customer": "",
  "default_tax_rates": [],
  "description": null,
  "discounts": [],
  "expires_at": 1682722691,
  "footer": null,
  "from_quote": null,
  "header": null,
  "invoice": null,
  "invoice_settings": {
    "days_until_due": null,
    "issuer": {
      "type": "self"
    }
  },
  "livemode": false,
  "metadata": {},
  "number": null,
  "on_behalf_of": null,
  "status": "draft",
  "status_transitions": {
    "accepted_at": null,
    "canceled_at": null,
    "finalized_at": null
  },
  "subscription": null,
  "subscription_data": {
    "description": null,
    "effective_date": null,
    "trial_period_days": null
  },
  "subscription_schedule": null,
  "test_clock": null,
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "transfer_data": null
}

The Quote Preview Invoice object v1Preview

Attributes

  • idstring

    Unique identifier for the object. For preview invoices created using the create preview endpoint, this id will be prefixed with upcoming_in.

  • automatic_taxobject

    Settings and latest results for automatic tax lookup for this invoice.

  • collection_methodenum

    Either charge_automatically, or send_invoice. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions.

    Possible enum values
    charge_automatically

    Attempt payment using the default source attached to the customer.

    send_invoice

    Email payment instructions to the customer.

  • confirmation_secretnullable objectIncludable

    The confirmation secret associated with this invoice. Currently, this contains the client_secret of the PaymentIntent that Stripe creates during invoice finalization.

  • currencyenum

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

  • customer_accountnullable string

    The ID of the account representing the customer to bill.

  • descriptionnullable string

    An arbitrary string attached to the object. Often useful for displaying to users. Referenced as ‘memo’ in the Dashboard.

  • linesobject

    The individual line items that make up the invoice. lines is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.

  • metadatanullable map

    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.

  • parentnullable object

    The parent that generated this invoice

  • paymentsobjectIncludable

    Payments for this invoice. Use invoice payment to get more details.

  • period_endtimestamp

    The latest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.

  • period_starttimestamp

    The earliest timestamp at which invoice items can be associated with this invoice. Use the line item period to get the service period for each price.

  • statusnullable enum

    The status of the invoice, one of draft, open, paid, uncollectible, or void. Learn more

    Possible enum values
    draft
    open
    paid
    uncollectible
    void

  • totalinteger

    Total after discounts and taxes.

More attributes

  • objectstring, value is "quote_preview_invoice"

  • account_countrynullable string

  • account_namenullable string

  • account_tax_idsnullable array of stringsExpandable

  • amount_dueinteger

  • amount_overpaidinteger

  • amount_paidinteger

  • amount_paid_off_stripeintegerIncludable

  • amount_remaininginteger

  • amount_shippinginteger

  • applicationnullable stringExpandableConnect only

  • attempt_countinteger

  • attemptedboolean

  • automatically_finalizes_atnullable timestamp

  • billing_reasonnullable enum

  • createdtimestamp

  • custom_fieldsnullable array of objects

  • customer_addressnullable object

  • customer_emailnullable string

  • customer_namenullable string

  • customer_phonenullable string

  • customer_shippingnullable object

  • customer_tax_exemptnullable enum

  • customer_tax_idsnullable array of objects

  • default_payment_methodnullable stringExpandable

  • default_sourcenullable stringExpandable

  • default_tax_ratesarray of objects

  • discountsarray of stringsExpandable

  • due_datenullable timestamp

  • effective_atnullable timestamp

  • ending_balancenullable integer

  • footernullable string

  • from_invoicenullable object

  • issuerobjectConnect only

  • last_finalization_errornullable object

  • latest_revisionnullable stringExpandable

  • livemodeboolean

  • next_payment_attemptnullable timestamp

  • numbernullable string

  • on_behalf_ofnullable stringExpandableConnect only

  • payment_settingsobject

  • post_payment_credit_notes_amountinteger

  • pre_payment_credit_notes_amountinteger

  • receipt_numbernullable string

  • renderingnullable object

  • shipping_costnullable object

  • shipping_detailsnullable object

  • starting_balanceinteger

  • statement_descriptornullable string

  • status_detailsnullable object

  • status_transitionsobject

  • subtotalinteger

  • subtotal_excluding_taxnullable integer

  • test_clocknullable stringExpandable

  • threshold_reasonnullable object

  • total_discount_amountsnullable array of objects

  • total_excluding_taxnullable integer

  • total_pretax_credit_amountsnullable array of objects

  • total_taxesnullable array of objects

  • webhooks_delivered_atnullable timestamp

The Quote Preview Invoice object
{
  "id": "preview_in_1MtHbELkdIwHu7ixl4OzzPMv",
  "object": "quote_preview_invoice",
  "account_country": "US",
  "account_name": "Stripe Docs",
  "account_tax_ids": null,
  "amount_due": 0,
  "amount_paid": 0,
  "amount_overpaid": 0,
  "amount_remaining": 0,
  "amount_shipping": 0,
  "application": null,
  "applies_to": {
    "type": "new_reference",
    "new_reference": "subscription-1",
    "subscription_schedule": null
  },
  "attempt_count": 0,
  "attempted": false,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_reason": "subscription_create",
  "collection_method": "charge_automatically",
  "created": 1680644467,
  "currency": "usd",
  "custom_fields": null,
  "customer_address": null,
  "customer_email": "jennyrosen@example.com",
  "customer_name": "Jenny Rosen",
  "customer_phone": null,
  "customer_shipping": null,
  "customer_tax_exempt": "none",
  "customer_tax_ids": [],
  "confirmation_secret": null,
  "default_payment_method": null,
  "default_source": null,
  "default_tax_rates": [],
  "description": null,
  "discounts": [],
  "due_date": null,
  "ending_balance": null,
  "footer": null,
  "from_invoice": null,
  "issuer": {
    "type": "self"
  },
  "last_finalization_error": null,
  "latest_revision": null,
  "lines": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/quotes/qt_1Mr7CILkdIwHu7ixwSqY2nMz/preview_invoices/preview_in_1MtHbELkdIwHu7ixl4OzzPMv/lines"
  },
  "payments": {
    "object": "list",
    "data": [],
    "has_more": false,
    "total_count": 0,
    "url": "/v1/invoice_payments"
  },
  "livemode": false,
  "metadata": {},
  "next_payment_attempt": null,
  "number": null,
  "on_behalf_of": null,
  "parent": null,
  "payment_settings": {
    "default_mandate": null,
    "payment_method_options": null,
    "payment_method_types": null
  },
  "period_end": 1680644467,
  "period_start": 1680644467,
  "post_payment_credit_notes_amount": 0,
  "pre_payment_credit_notes_amount": 0,
  "receipt_number": null,
  "shipping_cost": null,
  "shipping_details": null,
  "starting_balance": 0,
  "statement_descriptor": null,
  "status": "draft",
  "status_transitions": {
    "finalized_at": null,
    "marked_uncollectible_at": null,
    "paid_at": null,
    "voided_at": null
  },
  "subscription": null,
  "subtotal": 0,
  "subtotal_excluding_tax": 0,
  "test_clock": null,
  "total": 0,
  "total_discount_amounts": [],
  "total_excluding_tax": 0,
  "total_taxes": [],
  "webhooks_delivered_at": 1680644467
}

The Quote Preview Subscription Schedule object v1Preview

Attributes

  • idstring

    Unique identifier for the object.

  • applies_toobject

    Details to identify the subscription schedule the quote line applies to.

  • current_phasenullable object

    Object representing the start and end dates for the current phase of the subscription schedule, if it is active.

  • customerstringExpandable

    ID of the customer who owns the subscription schedule.

  • metadatanullable map

    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.

  • phasesarray of objects

    Configuration for the subscription schedule’s phases.

  • statusenum

    The present status of the subscription schedule. Possible values are not_started, active, completed, released, and canceled. You can read more about the different states in our behavior guide.

    Possible enum values
    active
    canceled
    completed
    not_started
    released

  • subscriptionnullable stringExpandable

    ID of the subscription managed by the subscription schedule.

More attributes

  • objectstring, value is "quote_preview_subscription_schedule"

  • applicationnullable stringExpandableConnect only

  • billing_modeobject

  • canceled_atnullable timestamp

  • completed_atnullable timestamp

  • createdtimestamp

  • customer_accountnullable string

  • default_settingsobject

  • end_behaviorenum

  • livemodeboolean

  • pause_schedulesarray of objects

  • released_atnullable timestamp

  • released_subscriptionnullable string

  • test_clocknullable stringExpandable

The Quote Preview Subscription Schedule object
{
  "id": "preview_sub_sched_1Mr3YdLkdIwHu7ixjop3qtff",
  "object": "quote_preview_subscription_schedule",
  "application": null,
  "applies_to": {
    "type": "new_reference",
    "new_reference": "subscription-1",
    "subscription_schedule": null
  },
  "billing_mode": {
    "type": "classic",
    "updated_at": null
  },
  "canceled_at": null,
  "completed_at": null,
  "created": 1724058651,
  "current_phase": null,
  "customer": "",
  "default_settings": {
    "application_fee_percent": null,
    "automatic_tax": {
      "enabled": false,
      "liability": null
    },
    "billing_cycle_anchor": "automatic",
    "collection_method": "charge_automatically",
    "default_payment_method": null,
    "default_source": null,
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "on_behalf_of": null,
    "transfer_data": null
  },
  "end_behavior": "release",
  "livemode": false,
  "metadata": {},
  "phases": [
    {
      "add_invoice_items": [],
      "application_fee_percent": null,
      "billing_cycle_anchor": null,
      "collection_method": null,
      "currency": "usd",
      "default_payment_method": null,
      "default_tax_rates": [],
      "description": null,
      "discounts": null,
      "end_date": 1818666418,
      "invoice_settings": null,
      "items": [
        {
          "discounts": null,
          "metadata": {},
          "plan": "",
          "price": "",
          "quantity": 1,
          "tax_rates": []
        }
      ],
      "metadata": {},
      "on_behalf_of": null,
      "proration_behavior": "create_prorations",
      "start_date": 1787130418,
      "transfer_data": null,
      "trial_end": null
    }
  ],
  "released_at": null,
  "released_subscription": null,
  "renewal_interval": null,
  "status": "not_started",
  "subscription": null,
  "test_clock": null
}