The Invoice object 

Attributes

• idstring

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

• auto_advanceboolean

  Controls whether Stripe performs automatic collection of the invoice. If false, the invoice’s state doesn’t automatically advance without an explicit action.

• automatic_taxMap

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

  Hide child attributes

  • automatic_tax.disabled_reasonnullable enum

    If Stripe disabled automatic tax, this enum describes why.

    Possible enum values

    finalization_requires_location_inputs Stripe’s systems automatically turned off Tax for this invoice when finalizing it with a missing or incomplete location for your customer.

    finalization_system_error Stripe’s systems automatically turned off Tax for this invoice due to an internal outage during tax calculation. We expect this to be very rare. Contact support for additional assistance.

  • automatic_tax.enabledboolean

    Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified tax rates, negative amounts, or tax_behavior=unspecified) cannot be added to automatic tax invoices.

  • automatic_tax.liabilitynullable MapConnect only

    The account that’s liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account.

    Hide child attributes

    • automatic_tax.liability.accountnullable stringExpandable

      The connected account being referenced when type is account.

    • automatic_tax.liability.typeenum

      Type of the account referenced.

      Possible enum values

      account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

      self Indicates that the account being referenced is the account making the API request.

  • automatic_tax.providernullable string

    The tax provider powering automatic tax.

  • automatic_tax.statusnullable enum

    The status of the most recent automated tax calculation for this invoice.

    Possible enum values

    complete The automatic tax calculation was successful.

    failed The tax calculation failed, please try again later.

    requires_location_inputs The location details supplied on the customer aren’t valid or don’t provide enough location information to accurately determine tax rates for the customer.

• 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 MapExpandable

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

  Hide child attributes

  • confirmation_secret.client_secretstring

    The client_secret of the payment that Stripe creates for the invoice after finalization.

  • confirmation_secret.typestring

    The type of client_secret. Currently this is always payment_intent, referencing the default payment_intent that Stripe creates during invoice finalization

• currencyenum

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

• customerstringExpandable

  The ID of the customer who will be billed.

• descriptionnullable string

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

• hosted_invoice_urlnullable string

  The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.

• linesMap

  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.

  Hide child attributes

  • lines.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • lines.dataarray of Maps

    Details about each object.

    Hide child attributes

    • lines.data.idstring

      Unique identifier for the object.

    • lines.data.objectstring

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

    • lines.data.amountinteger

      The amount, in cents.

    • lines.data.currencyenum

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

    • lines.data.descriptionnullable string

      An arbitrary string attached to the object. Often useful for displaying to users.

    • lines.data.discount_amountsnullable array of Maps

      The amount of discount calculated per discount for this line item.

      Hide child attributes

      • lines.data.discount_amounts.amountinteger

        The amount, in cents, of the discount.

      • lines.data.discount_amounts.discountstringExpandable

        The discount that was applied to get this discount amount.

    • lines.data.discountableboolean

      If true, discounts will apply to this line item. Always false for prorations.

    • lines.data.discountsarray of stringsExpandable

      The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

    • lines.data.invoicenullable string

      The ID of the invoice that contains this line item.

    • lines.data.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • lines.data.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. Note that for line items with type=subscription, metadata reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation.

    • lines.data.parentnullable Map

      The parent that generated this line item.

      Hide child attributes

      • lines.data.parent.invoice_item_detailsnullable Map

        Details about the invoice item that generated this line item

        Hide child attributes

        • lines.data.parent.invoice_item_details.invoice_itemstring

          The invoice item that generated this line item

        • lines.data.parent.invoice_item_details.prorationboolean

          Whether this is a proration

        • lines.data.parent.invoice_item_details.proration_detailsnullable Map

          Additional details for proration line items

          Hide child attributes

          • lines.data.parent.invoice_item_details.proration_details.credited_itemsnullable Map

            For a credit proration line_item, the original debit line_items to which the credit proration applies.

            Hide child attributes

            • lines.data.parent.invoice_item_details.proration_details.credited_items.invoicestring

              Invoice containing the credited invoice line items

            • lines.data.parent.invoice_item_details.proration_details.credited_items.invoice_line_itemsarray of strings

              Credited invoice line items

        • lines.data.parent.invoice_item_details.subscriptionnullable string

          The subscription that the invoice item belongs to

      • lines.data.parent.subscription_item_detailsnullable Map

        Details about the subscription item that generated this line item

        Hide child attributes

        • lines.data.parent.subscription_item_details.invoice_itemnullable string

          The invoice item that generated this line item

        • lines.data.parent.subscription_item_details.prorationboolean

          Whether this is a proration

        • lines.data.parent.subscription_item_details.proration_detailsnullable Map

          Additional details for proration line items

          Hide child attributes

          • lines.data.parent.subscription_item_details.proration_details.credited_itemsnullable Map

            For a credit proration line_item, the original debit line_items to which the credit proration applies.

            Hide child attributes

            • lines.data.parent.subscription_item_details.proration_details.credited_items.invoicestring

              Invoice containing the credited invoice line items

            • lines.data.parent.subscription_item_details.proration_details.credited_items.invoice_line_itemsarray of strings

              Credited invoice line items

        • lines.data.parent.subscription_item_details.subscriptionnullable string

          The subscription that the subscription item belongs to

        • lines.data.parent.subscription_item_details.subscription_itemstring

          The subscription item that generated this line item

      • lines.data.parent.typeenum

        The type of parent that generated this line item

        Possible enum values

        invoice_item_details Details of the parent can be found in the invoice_item_details hash.

        subscription_item_details Details of the parent can be found in the subscription_item_details hash.

    • lines.data.periodMap

      The period this line_item covers. For subscription line items, this is the subscription period. For prorations, this starts when the proration was calculated, and ends at the period end of the subscription. For invoice items, this is the time at which the invoice item was created or the period of the item. If you have Stripe Revenue Recognition enabled, the period will be used to recognize and defer revenue. See the Revenue Recognition documentation for details.

      Hide child attributes

      • lines.data.period.endtimestamp

        The end of the period, which must be greater than or equal to the start. This value is inclusive.

      • lines.data.period.starttimestamp

        The start of the period. This value is inclusive.

    • lines.data.pretax_credit_amountsnullable array of Maps

      Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this line item.

      Hide child attributes

      • lines.data.pretax_credit_amounts.amountinteger

        The amount, in cents, of the pretax credit amount.

      • lines.data.pretax_credit_amounts.credit_balance_transactionnullable stringExpandable

        The credit balance transaction that was applied to get this pretax credit amount.

      • lines.data.pretax_credit_amounts.discountnullable stringExpandable

        The discount that was applied to get this pretax credit amount.

      • lines.data.pretax_credit_amounts.typeenum

        Type of the pretax credit amount referenced.

        Possible enum values

        credit_balance_transaction The pretax credit amount is from a credit balance transaction.

        discount The pretax credit amount is from a discount.

    • lines.data.pricingnullable Map

      The pricing information of the line item.

      Hide child attributes

      • lines.data.pricing.price_detailsnullable Map

        Additional details about the price this item is associated with. This is present only when the type is price_details

        Hide child attributes

        • lines.data.pricing.price_details.pricestring

          The ID of the price this item is associated with.

        • lines.data.pricing.price_details.productstring

          The ID of the product this item is associated with.

      • lines.data.pricing.typeenum

        The type of the pricing details.

      • lines.data.pricing.unit_amount_decimalnullable decimal string

        The unit amount (in the currency specified) of the item which contains a decimal value with at most 12 decimal places.

    • lines.data.quantitynullable integer

      The quantity of the subscription, if the line item is a subscription or a proration.

    • lines.data.taxesnullable array of Maps

      The tax information of the line item.

      Hide child attributes

      • lines.data.taxes.amountinteger

        The amount of the tax, in cents.

      • lines.data.taxes.tax_behaviorenum

        Whether this tax is inclusive or exclusive.

        Possible enum values

        exclusive

        inclusive

      • lines.data.taxes.tax_rate_detailsnullable Map

        Additional details about the tax rate. Only present when type is tax_rate_details.

      • lines.data.taxes.taxability_reasonenum

        The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.

        Possible enum values

        customer_exempt No tax is applied as the customer is exempt from tax.

        not_available The reasoning behind this tax is not available.

        not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

        not_subject_to_tax No tax is imposed on this transaction.

        not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

        portion_product_exempt A portion of the price is exempt from tax.

        portion_reduced_rated A portion of the price is taxed at a reduced rate.

        portion_standard_rated A portion of the price is taxed at the standard rate.

        product_exempt The product or service is nontaxable or exempt from tax.

        product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

        Show 6 more

      • lines.data.taxes.taxable_amountnullable integer

        The amount on which tax is calculated, in cents.

      • lines.data.taxes.typeenum

        The type of tax information.

  • lines.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • lines.urlstring

    The URL where this list can be accessed.

• 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 Map

  The parent that generated this invoice

  Hide child attributes

  • parent.quote_detailsnullable Map

    Details about the quote that generated this invoice

    Hide child attributes

    • parent.quote_details.quotestring

      The quote that generated this invoice

  • parent.subscription_detailsnullable Map

    Details about the subscription that generated this invoice

    Hide child attributes

    • parent.subscription_details.metadatanullable Map

      Set of key-value pairs defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization. Note: This attribute is populated only for invoices created on or after June 29, 2023.

    • parent.subscription_details.subscriptionstringExpandable

      The subscription that generated this invoice

    • parent.subscription_details.subscription_proration_datenullable timestamp

      Only set for upcoming invoices that preview prorations. The time used to calculate prorations.

  • parent.typeenum

    The type of parent that generated this invoice

    Possible enum values

    quote_details Details of the parent can be found in the quote_details hash.

    subscription_details Details of the parent can be found in the subscription_details hash.

• period_endtimestamp

  End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the line item period to get the service period for each price.

• period_starttimestamp

  Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription 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

• totalinteger

  Total after discounts and taxes.

More attributes

Collapse all

• objectstring

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

• account_countrynullable string

  The country of the business associated with this invoice, most often the business creating the invoice.

• account_namenullable string

  The public name of the business associated with this invoice, most often the business creating the invoice.

• account_tax_idsnullable array of stringsExpandable

  The account tax IDs associated with the invoice. Only editable when the invoice is a draft.

• amount_dueinteger

  Final amount due at this time for this invoice. If the invoice’s total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the amount_due may be 0. If there is a positive starting_balance for the invoice (the customer owes money), the amount_due will also take that into account. The charge that gets generated for the invoice will be for the amount specified in amount_due.

• amount_overpaidinteger

  Amount that was overpaid on the invoice. The amount overpaid is credited to the customer’s credit balance.

• amount_paidinteger

  The amount, in cents, that was paid.

• amount_remaininginteger

  The difference between amount_due and amount_paid, in cents.

• amount_shippinginteger

  This is the sum of all the shipping amounts.

• applicationnullable stringExpandableConnect only

  ID of the Connect Application that created the invoice.

• attempt_countinteger

  Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained.

• attemptedboolean

  Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the invoice.created webhook, for example, so you might not want to display that invoice as unpaid to your users.

• automatically_finalizes_atnullable timestamp

  The time when this invoice is currently scheduled to be automatically finalized. The field will be null if the invoice is not scheduled to finalize in the future. If the invoice is not in the draft state, this field will always be null - see finalized_at for the time when an already-finalized invoice was finalized.

• billing_reasonnullable enum

  Indicates the reason why the invoice was created.

  • manual: Unrelated to a subscription, for example, created via the invoice editor.
  • subscription: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.
  • subscription_create: A new subscription was created.
  • subscription_cycle: A subscription advanced into a new period.
  • subscription_threshold: A subscription reached a billing threshold.
  • subscription_update: A subscription was updated.
  • upcoming: Reserved for upcoming invoices created through the Create Preview Invoice API or when an invoice.upcoming event is generated for an upcoming invoice on a subscription.

  Possible enum values

  automatic_pending_invoice_item_invoice

  manual

  quote_accept

  subscription

  subscription_create

  subscription_cycle

  subscription_threshold

  subscription_update

  upcoming

• createdtimestamp

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

• custom_fieldsnullable array of Maps

  Custom fields displayed on the invoice.

  Hide child attributes

  • custom_fields.namestring

    The name of the custom field.

  • custom_fields.valuestring

    The value of the custom field.

• customer_addressnullable Map

  The customer’s address. Until the invoice is finalized, this field will equal customer.address. Once the invoice is finalized, this field will no longer be updated.

  Hide child attributes

  • customer_address.citynullable string

    City, district, suburb, town, or village.

  • customer_address.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • customer_address.line1nullable string

    Address line 1, such as the street, PO Box, or company name.

  • customer_address.line2nullable string

    Address line 2, such as the apartment, suite, unit, or building.

  • customer_address.postal_codenullable string

    ZIP or postal code.

  • customer_address.statenullable string

    State, county, province, or region.

• customer_emailnullable string

  The customer’s email. Until the invoice is finalized, this field will equal customer.email. Once the invoice is finalized, this field will no longer be updated.

• customer_namenullable string

  The customer’s name. Until the invoice is finalized, this field will equal customer.name. Once the invoice is finalized, this field will no longer be updated.

• customer_phonenullable string

  The customer’s phone number. Until the invoice is finalized, this field will equal customer.phone. Once the invoice is finalized, this field will no longer be updated.

• customer_shippingnullable Map

  The customer’s shipping information. Until the invoice is finalized, this field will equal customer.shipping. Once the invoice is finalized, this field will no longer be updated.

  Hide child attributes

  • customer_shipping.addressMap

    Customer shipping address.

    Hide child attributes

    • customer_shipping.address.citynullable string

      City, district, suburb, town, or village.

    • customer_shipping.address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • customer_shipping.address.line1nullable string

      Address line 1, such as the street, PO Box, or company name.

    • customer_shipping.address.line2nullable string

      Address line 2, such as the apartment, suite, unit, or building.

    • customer_shipping.address.postal_codenullable string

      ZIP or postal code.

    • customer_shipping.address.statenullable string

      State, county, province, or region.

  • customer_shipping.namestring

    Customer name.

  • customer_shipping.phonenullable string

    Customer phone (including extension).

• customer_tax_exemptnullable enum

  The customer’s tax exempt status. Until the invoice is finalized, this field will equal customer.tax_exempt. Once the invoice is finalized, this field will no longer be updated.

  Possible enum values

  exempt

  none

  reverse

• customer_tax_idsnullable array of Maps

  The customer’s tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as customer.tax_ids. Once the invoice is finalized, this field will no longer be updated.

  Hide child attributes

  • customer_tax_ids.typeenum

    The type of the tax ID, one of ad_nrt, ar_cuit, eu_vat, bo_tin, br_cnpj, br_cpf, cn_tin, co_nit, cr_tin, do_rcn, ec_ruc, eu_oss_vat, hr_oib, pe_ruc, ro_tin, rs_pib, sv_nit, uy_ruc, ve_rif, vn_tin, gb_vat, nz_gst, au_abn, au_arn, in_gst, no_vat, no_voec, za_vat, ch_vat, mx_rfc, sg_uen, ru_inn, ru_kpp, ca_bn, hk_br, es_cif, tw_vat, th_vat, jp_cn, jp_rn, jp_trn, li_uid, li_vat, my_itn, us_ein, kr_brn, ca_qst, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, my_sst, sg_gst, ae_trn, cl_tin, sa_vat, id_npwp, my_frp, il_vat, ge_vat, ua_vat, is_vat, bg_uic, hu_tin, si_tin, ke_pin, tr_tin, eg_tin, ph_tin, al_tin, bh_vat, kz_bin, ng_tin, om_vat, de_stn, ch_uid, tz_vat, uz_vat, uz_tin, md_vat, ma_vat, by_tin, ao_tin, bs_tin, bb_tin, cd_nif, mr_nif, me_pib, zw_tin, ba_tin, gn_nif, mk_vat, sr_fin, sn_ninea, am_tin, np_pan, tj_tin, ug_tin, zm_tin, kh_tin, aw_tin, az_tin, bd_bin, bj_ifu, et_tin, kg_tin, la_tin, cm_niu, cv_nif, bf_ifu, or unknown

    Possible enum values

    ad_nrt

    ae_trn

    al_tin

    am_tin

    ao_tin

    ar_cuit

    au_abn

    au_arn

    aw_tin

    az_tin

    Show 101 more

  • customer_tax_ids.valuenullable string

    The value of the tax ID.

• default_payment_methodnullable stringExpandable

  ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription’s default payment method, if any, or to the default payment method in the customer’s invoice settings.

• default_sourcenullable stringExpandable

  ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription’s default source, if any, or to the customer’s default source.

• default_tax_ratesarray of Maps

  The tax rates applied to this invoice, if any.

  Hide child attributes

  • default_tax_rates.idstring

    Unique identifier for the object.

  • default_tax_rates.objectstring

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

  • default_tax_rates.activeboolean

    Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

  • default_tax_rates.countrynullable string

    Two-letter country code (ISO 3166-1 alpha-2).

  • default_tax_rates.createdtimestamp

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

  • default_tax_rates.descriptionnullable string

    An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

  • default_tax_rates.display_namestring

    The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

  • default_tax_rates.effective_percentagenullable float

    Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

  • default_tax_rates.flat_amountnullable Map

    The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

    Hide child attributes

    • default_tax_rates.flat_amount.amountinteger

      Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

    • default_tax_rates.flat_amount.currencystring

      Three-letter ISO currency code, in lowercase.

  • default_tax_rates.inclusiveboolean

    This specifies if the tax rate is inclusive or exclusive.

  • default_tax_rates.jurisdictionnullable string

    The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

  • default_tax_rates.jurisdiction_levelnullable enum

    The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

    Possible enum values

    city

    country

    county

    district

    multiple

    state

  • default_tax_rates.livemodeboolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

  • default_tax_rates.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.

  • default_tax_rates.percentagefloat

    Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

  • default_tax_rates.rate_typenullable enum

    Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

    Possible enum values

    flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

    percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

  • default_tax_rates.statenullable string

    ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

  • default_tax_rates.tax_typenullable enum

    The high-level tax type, such as vat or sales_tax.

    Possible enum values

    amusement_tax Amusement Tax

    communications_tax Communications Tax

    gst Goods and Services Tax

    hst Harmonized Sales Tax

    igst Integrated Goods and Services Tax

    jct Japanese Consumption Tax

    lease_tax Chicago Lease Tax

    pst Provincial Sales Tax

    qst Quebec Sales Tax

    retail_delivery_fee Retail Delivery Fee

    Show 4 more

• discountsarray of stringsExpandable

  The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use expand[]=discounts to expand each discount.

• due_datenullable timestamp

  The date on which payment for this invoice is due. This value will be null for invoices where collection_method=charge_automatically.

• effective_atnullable timestamp

  The date when this invoice is in effect. Same as finalized_at unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the invoice PDF and receipt.

• ending_balancenullable integer

  Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.

• footernullable string

  Footer displayed on the invoice.

• from_invoicenullable Map

  Details of the invoice that was cloned. See the revision documentation for more details.

  Hide child attributes

  • from_invoice.actionstring

    The relation between this invoice and the cloned invoice

  • from_invoice.invoicestringExpandable

    The invoice that was cloned.

• invoice_pdfnullable string

  The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.

• issuerMapConnect only

  The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account.

  Hide child attributes

  • issuer.accountnullable stringExpandable

    The connected account being referenced when type is account.

  • issuer.typeenum

    Type of the account referenced.

    Possible enum values

    account Indicates that the account being referenced is a connected account which is different from the account making the API request but related to it.

    self Indicates that the account being referenced is the account making the API request.

• last_finalization_errornullable Map

  The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.

  Hide child attributes

  • last_finalization_error.advice_codenullable string

    For card errors resulting from a card issuer decline, a short string indicating how to proceed with an error if they provide one.

  • last_finalization_error.codenullable string

    For some errors that could be handled programmatically, a short string indicating the error code reported.

  • last_finalization_error.doc_urlnullable string

    A URL to more information about the error code reported.

  • last_finalization_error.messagenullable string

    A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.

  • last_finalization_error.network_advice_codenullable string

    For card errors resulting from a card issuer decline, a 2 digit code which indicates the advice given to merchant by the card network on how to proceed with an error.

  • last_finalization_error.network_decline_codenullable string

    For payments declined by the network, an alphanumeric code which indicates the reason the payment failed.

  • last_finalization_error.paramnullable string

    If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.

  • last_finalization_error.payment_method_typenullable string

    If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.

  • last_finalization_error.typeenum

    The type of error returned. One of api_error, card_error, idempotency_error, or invalid_request_error

    Possible enum values

    api_error

    card_error

    idempotency_error

    invalid_request_error

• latest_revisionnullable stringExpandable

  The ID of the most recent non-draft revision of this invoice

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• next_payment_attemptnullable timestamp

  The time at which payment will next be attempted. This value will be null for invoices where collection_method=send_invoice.

• numbernullable string

  A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer’s unique invoice_prefix if it is specified.

• on_behalf_ofnullable stringExpandableConnect only

  The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the Invoices with Connect documentation for details.

• payment_settingsMap

  Configuration settings for the PaymentIntent that is generated when the invoice is finalized.

  Hide child attributes

  • payment_settings.default_mandatenullable string

    ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice’s default_payment_method or default_source, if set.

  • payment_settings.payment_method_optionsnullable Map

    Payment-method-specific configuration to provide to the invoice’s PaymentIntent.

    Hide child attributes

    • payment_settings.payment_method_options.acss_debitnullable Map

      If paying by acss_debit, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent.

      Hide child attributes

      • payment_settings.payment_method_options.acss_debit.mandate_optionsnullable Map

        Additional fields for Mandate creation

        Hide child attributes

        • payment_settings.payment_method_options.acss_debit.mandate_options.transaction_typenullable enum

          Transaction type of the mandate.

          Possible enum values

          business Transactions are made for business reasons

          personal Transactions are made for personal reasons

      • payment_settings.payment_method_options.acss_debit.verification_methodnullable enum

        Bank account verification method.

        Possible enum values

        automatic Instant verification with fallback to microdeposits.

        instant Instant verification.

        microdeposits Verification using microdeposits.

    • payment_settings.payment_method_options.bancontactnullable Map

      If paying by bancontact, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent.

      Hide child attributes

      • payment_settings.payment_method_options.bancontact.preferred_languageenum

        Preferred language of the Bancontact authorization page that the customer is redirected to.

        Possible enum values

        de German

        en English

        fr French

        nl Dutch

    • payment_settings.payment_method_options.cardnullable Map

      If paying by card, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent.

      Hide child attributes

      • payment_settings.payment_method_options.card.installmentsnullable Map

        Installment details for this Invoice.

        For more information, see the installments integration guide.

        Hide child attributes

        • payment_settings.payment_method_options.card.installments.enablednullable boolean

          Whether Installments are enabled for this Invoice.

      • payment_settings.payment_method_options.card.request_three_d_securenullable enumadvanced

        We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and other requirements. However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on manually requesting 3D Secure for more information on how this configuration interacts with Radar and our SCA Engine.

        Possible enum values

        any Use any to manually request 3DS with a preference for a frictionless flow, increasing the likelihood of the authentication being completed without any additional input from the customer. 3DS will always be attempted if it is supported for the card, but Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

        automatic (Default) Our SCA Engine automatically prompts your customers for authentication based on risk level and other requirements.

        challenge Use challenge to request 3DS with a preference for a challenge flow, where the customer must respond to a prompt for active authentication. Stripe can’t guarantee your preference because the issuer determines the ultimate authentication flow. To learn more about 3DS flows, read our guide.

    • payment_settings.payment_method_options.customer_balancenullable Map

      If paying by customer_balance, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent.

      Hide child attributes

      • payment_settings.payment_method_options.customer_balance.bank_transfernullable Map

        Configuration for the bank transfer funding type, if the funding_type is set to bank_transfer.

        Hide child attributes

        • payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfernullable Map

          Configuration for eu_bank_transfer funding type.

          Hide child attributes

          • payment_settings.payment_method_options.customer_balance.bank_transfer.eu_bank_transfer.countryenum

            The desired country code of the bank account information. Permitted values include: BE, DE, ES, FR, IE, or NL.

            Possible enum values

            BE

            DE

            ES

            FR

            IE

            NL

        • payment_settings.payment_method_options.customer_balance.bank_transfer.typenullable enum

          The bank transfer type that can be used for funding. Permitted values include: eu_bank_transfer, gb_bank_transfer, jp_bank_transfer, mx_bank_transfer, or us_bank_transfer.

      • payment_settings.payment_method_options.customer_balance.funding_typenullable enum

        The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: bank_transfer.

        Possible enum values

        bank_transfer

    • payment_settings.payment_method_options.konbininullable Map

      If paying by konbini, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent.

    • payment_settings.payment_method_options.sepa_debitnullable Map

      If paying by sepa_debit, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent.

    • payment_settings.payment_method_options.us_bank_accountnullable Map

      If paying by us_bank_account, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent.

      Hide child attributes

      • payment_settings.payment_method_options.us_bank_account.financial_connectionsnullable Map

        Additional fields for Financial Connections Session creation

        Hide child attributes

        • payment_settings.payment_method_options.us_bank_account.financial_connections.filtersnullable Map

          Filter the list of accounts that are allowed to be linked.

          Hide child attributes

          • payment_settings.payment_method_options.us_bank_account.financial_connections.filters.account_subcategoriesnullable array of enums

            The account subcategories to use to filter for possible accounts to link. Valid subcategories are checking and savings.

            Possible enum values

            checking Bank account subcategory is checking

            savings Bank account subcategory is savings

        • payment_settings.payment_method_options.us_bank_account.financial_connections.permissionsnullable array of enums

          The list of permissions to request. The payment_method permission must be included.

          Possible enum values

          balances Allows accessing balance data from the account.

          ownership Allows accessing ownership data from the account.

          payment_method Allows the creation of a payment method from the account.

          transactions Allows accessing transactions data from the account.

        • payment_settings.payment_method_options.us_bank_account.financial_connections.prefetchnullable array of enums

          Data features requested to be retrieved upon account creation.

          Possible enum values

          balances Requests to prefetch balance data on accounts collected in this session.

          ownership Requests to prefetch ownership data on accounts collected in this session.

          transactions Requests to prefetch transaction data on accounts collected in this session.

      • payment_settings.payment_method_options.us_bank_account.verification_methodnullable enum

        Bank account verification method.

        Possible enum values

        automatic Instant verification with fallback to microdeposits.

        instant Instant verification only.

        microdeposits Verification using microdeposits. Cannot be used with Stripe Checkout, Hosted Invoices, or Payment Element.

  • payment_settings.payment_method_typesnullable array of enums

    The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your invoice template settings.

    Possible enum values

    ach_debit ACH

    acss_debit Canadian pre-authorized debit

    affirm Affirm If set, the Subscription collection_method must be send_invoice.

    amazon_pay Amazon Pay

    au_becs_debit BECS Direct Debit

    bacs_debit Bacs Direct Debit

    bancontact Bancontact If set, the Subscription collection_method must be send_invoice.

    boleto Boleto

    card Card

    cashapp Cash App Pay

    Show 27 more

• paymentsMapExpandable

  Payments for this invoice

  Hide child attributes

  • payments.objectstring

    String representing the object’s type. Objects of the same type share the same value. Always has the value list.

  • payments.dataarray of Maps

    Details about each object.

    Hide child attributes

    • payments.data.idstring

      Unique identifier for the object.

    • payments.data.objectstring

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

    • payments.data.amount_paidnullable integer

      Amount that was actually paid for this invoice, in cents. This field is null until the payment is paid. This amount can be less than the amount_requested if the PaymentIntent’s amount_received is not sufficient to pay all of the invoices that it is attached to.

    • payments.data.amount_requestedinteger

      Amount intended to be paid toward this invoice, in cents

    • payments.data.createdtimestamp

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

    • payments.data.currencystring

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

    • payments.data.invoicestringExpandable

      The invoice that was paid.

    • payments.data.is_defaultboolean

      Stripe automatically creates a default InvoicePayment when the invoice is finalized, and keeps it synchronized with the invoice’s amount_remaining. The PaymentIntent associated with the default payment can’t be edited or canceled directly.

    • payments.data.livemodeboolean

      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • payments.data.paymentMap

      The details on the payment.

      Hide child attributes

      • payments.data.payment.chargenullable stringExpandable

        ID of the successful charge for this payment when type is charge.Note: charge is only surfaced if the charge object is not associated with a payment intent. If the charge object does have a payment intent, the Invoice Payment surfaces the payment intent instead.

      • payments.data.payment.payment_intentnullable stringExpandable

        ID of the PaymentIntent associated with this payment when type is payment_intent. Note: This property is only populated for invoices finalized on or after March 15th, 2019.

      • payments.data.payment.payment_recordnullable stringExpandable

        ID of the PaymentRecord associated with this payment when type is payment_record.

      • payments.data.payment.typeenum

        Type of payment object associated with this invoice payment.

        Possible enum values

        charge

        payment_intent

    • payments.data.statusstring

      The status of the payment, one of open, paid, or canceled.

    • payments.data.status_transitionsMap

      The timestamps when the payment’s status was updated.

      Hide child attributes

      • payments.data.status_transitions.canceled_atnullable timestamp

        The time that the payment was canceled.

      • payments.data.status_transitions.paid_atnullable timestamp

        The time that the payment succeeded.

  • payments.has_moreboolean

    True if this list has another page of items after this one that can be fetched.

  • payments.urlstring

    The URL where this list can be accessed.

• post_payment_credit_notes_amountinteger

  Total amount of all post-payment credit notes issued for this invoice.

• pre_payment_credit_notes_amountinteger

  Total amount of all pre-payment credit notes issued for this invoice.

• receipt_numbernullable string

  This is the transaction number that appears on email receipts sent for this invoice.

• renderingnullable Map

  The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.

  Hide child attributes

  • rendering.amount_tax_displaynullable string

    How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.

  • rendering.pdfnullable Map

    Invoice pdf rendering options

    Hide child attributes

    • rendering.pdf.page_sizenullable enum

      Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale.

      Possible enum values

      a4

      auto

      letter

  • rendering.templatenullable string

    ID of the rendering template that the invoice is formatted by.

  • rendering.template_versionnullable integer

    Version of the rendering template that the invoice is using.

• shipping_costnullable Map

  The details of the cost of shipping, including the ShippingRate applied on the invoice.

  Hide child attributes

  • shipping_cost.amount_subtotalinteger

    Total shipping cost before any taxes are applied.

  • shipping_cost.amount_taxinteger

    Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0.

  • shipping_cost.amount_totalinteger

    Total shipping cost after taxes are applied.

  • shipping_cost.shipping_ratenullable stringExpandable

    The ID of the ShippingRate for this invoice.

  • shipping_cost.taxesnullable array of MapsExpandable

    The taxes applied to the shipping rate.

    Hide child attributes

    • shipping_cost.taxes.amountinteger

      Amount of tax applied for this rate.

    • shipping_cost.taxes.rateMap

      The tax rate applied.

      Hide child attributes

      • shipping_cost.taxes.rate.idstring

        Unique identifier for the object.

      • shipping_cost.taxes.rate.objectstring

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

      • shipping_cost.taxes.rate.activeboolean

        Defaults to true. When set to false, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set.

      • shipping_cost.taxes.rate.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • shipping_cost.taxes.rate.createdtimestamp

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

      • shipping_cost.taxes.rate.descriptionnullable string

        An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.

      • shipping_cost.taxes.rate.display_namestring

        The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page.

      • shipping_cost.taxes.rate.effective_percentagenullable float

        Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage reflects the rate actually used to calculate tax based on the product’s taxability and whether the user is registered to collect taxes in the corresponding jurisdiction.

      • shipping_cost.taxes.rate.flat_amountnullable Map

        The amount of the tax rate when the rate_type is flat_amount. Tax rates with rate_type percentage can vary based on the transaction, resulting in this field being null. This field exposes the amount and currency of the flat tax rate.

        Hide child attributes

        • shipping_cost.taxes.rate.flat_amount.amountinteger

          Amount of the tax when the rate_type is flat_amount. This positive integer represents how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99).

        • shipping_cost.taxes.rate.flat_amount.currencystring

          Three-letter ISO currency code, in lowercase.

      • shipping_cost.taxes.rate.inclusiveboolean

        This specifies if the tax rate is inclusive or exclusive.

      • shipping_cost.taxes.rate.jurisdictionnullable string

        The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.

      • shipping_cost.taxes.rate.jurisdiction_levelnullable enum

        The level of the jurisdiction that imposes this tax rate. Will be null for manually defined tax rates.

        Possible enum values

        city

        country

        county

        district

        multiple

        state

      • shipping_cost.taxes.rate.livemodeboolean

        Has the value true if the object exists in live mode or the value false if the object exists in test mode.

      • shipping_cost.taxes.rate.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.

      • shipping_cost.taxes.rate.percentagefloat

        Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions.

      • shipping_cost.taxes.rate.rate_typenullable enum

        Indicates the type of tax rate applied to the taxable amount. This value can be null when no tax applies to the location. This field is only present for TaxRates created by Stripe Tax.

        Possible enum values

        flat_amount A fixed amount applied as tax, regardless of the taxable amount, such as a retail delivery fee.

        percentage A tax rate expressed as a percentage of the taxable amount, such as the sales tax rate in California.

      • shipping_cost.taxes.rate.statenullable string

        ISO 3166-2 subdivision code, without country prefix. For example, “NY” for New York, United States.

      • shipping_cost.taxes.rate.tax_typenullable enum

        The high-level tax type, such as vat or sales_tax.

        Possible enum values

        amusement_tax Amusement Tax

        communications_tax Communications Tax

        gst Goods and Services Tax

        hst Harmonized Sales Tax

        igst Integrated Goods and Services Tax

        jct Japanese Consumption Tax

        lease_tax Chicago Lease Tax

        pst Provincial Sales Tax

        qst Quebec Sales Tax

        retail_delivery_fee Retail Delivery Fee

        Show 4 more

    • shipping_cost.taxes.taxability_reasonnullable enum

      The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.

      Possible enum values

      customer_exempt No tax is applied as the customer is exempt from tax.

      not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

      not_subject_to_tax No tax is imposed on this transaction.

      not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

      portion_product_exempt A portion of the price is exempt from tax.

      portion_reduced_rated A portion of the price is taxed at a reduced rate.

      portion_standard_rated A portion of the price is taxed at the standard rate.

      product_exempt The product or service is nontaxable or exempt from tax.

      product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

      proportionally_rated The shipping cost tax rate is calculated as a weighted average of the other line items’ rates, weighted by their amounts.

      Show 5 more

    • shipping_cost.taxes.taxable_amountnullable integer

      The amount on which tax is calculated, in cents.

• shipping_detailsnullable Map

  Shipping details for the invoice. The Invoice PDF will use the shipping_details value if it is set, otherwise the PDF will render the shipping address from the customer.

  Hide child attributes

  • shipping_details.addressMap

    Shipping address.

    Hide child attributes

    • shipping_details.address.citynullable string

      City, district, suburb, town, or village.

    • shipping_details.address.countrynullable string

      Two-letter country code (ISO 3166-1 alpha-2).

    • shipping_details.address.line1nullable string

      Address line 1, such as the street, PO Box, or company name.

    • shipping_details.address.line2nullable string

      Address line 2, such as the apartment, suite, unit, or building.

    • shipping_details.address.postal_codenullable string

      ZIP or postal code.

    • shipping_details.address.statenullable string

      State, county, province, or region.

  • shipping_details.namestring

    Recipient name.

  • shipping_details.phonenullable string

    Recipient phone (including extension).

• starting_balanceinteger

  Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.

• statement_descriptornullable string

  Extra information about an invoice for the customer’s credit card statement.

• status_transitionsMap

  The timestamps at which the invoice status was updated.

  Hide child attributes

  • status_transitions.finalized_atnullable timestamp

    The time that the invoice draft was finalized.

  • status_transitions.marked_uncollectible_atnullable timestamp

    The time that the invoice was marked uncollectible.

  • status_transitions.paid_atnullable timestamp

    The time that the invoice was paid.

  • status_transitions.voided_atnullable timestamp

    The time that the invoice was voided.

• subtotalinteger

  Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated

• subtotal_excluding_taxnullable integer

  The integer amount in cents representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated

• test_clocknullable stringExpandable

  ID of the test clock this invoice belongs to.

• threshold_reasonnullable Map

  If billing_reason is set to subscription_threshold this returns more information on which threshold rules triggered the invoice.

  Hide child attributes

  • threshold_reason.amount_gtenullable integer

    The total invoice amount threshold boundary if it triggered the threshold invoice.

  • threshold_reason.item_reasonsarray of Maps

    Indicates which line items triggered a threshold invoice.

    Hide child attributes

    • threshold_reason.item_reasons.line_item_idsarray of strings

      The IDs of the line items that triggered the threshold invoice.

    • threshold_reason.item_reasons.usage_gteinteger

      The quantity threshold boundary that applied to the given line item.

• total_discount_amountsnullable array of Maps

  The aggregate amounts calculated per discount across all line items.

  Hide child attributes

  • total_discount_amounts.amountinteger

    The amount, in cents, of the discount.

  • total_discount_amounts.discountstringExpandable

    The discount that was applied to get this discount amount.

• total_excluding_taxnullable integer

  The integer amount in cents representing the total amount of the invoice including all discounts but excluding all tax.

• total_pretax_credit_amountsnullable array of Maps

  Contains pretax credit amounts (ex: discount, credit grants, etc) that apply to this invoice. This is a combined list of total_pretax_credit_amounts across all invoice line items.

  Hide child attributes

  • total_pretax_credit_amounts.amountinteger

    The amount, in cents, of the pretax credit amount.

  • total_pretax_credit_amounts.credit_balance_transactionnullable stringExpandable

    The credit balance transaction that was applied to get this pretax credit amount.

  • total_pretax_credit_amounts.discountnullable stringExpandable

    The discount that was applied to get this pretax credit amount.

  • total_pretax_credit_amounts.typeenum

    Type of the pretax credit amount referenced.

    Possible enum values

    credit_balance_transaction The pretax credit amount is from a credit balance transaction.

    discount The pretax credit amount is from a discount.

• total_taxesnullable array of Maps

  The aggregate tax information of all line items.

  Hide child attributes

  • total_taxes.amountinteger

    The amount of the tax, in cents.

  • total_taxes.tax_behaviorenum

    Whether this tax is inclusive or exclusive.

    Possible enum values

    exclusive

    inclusive

  • total_taxes.tax_rate_detailsnullable Map

    Additional details about the tax rate. Only present when type is tax_rate_details.

  • total_taxes.taxability_reasonenum

    The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.

    Possible enum values

    customer_exempt No tax is applied as the customer is exempt from tax.

    not_available The reasoning behind this tax is not available.

    not_collecting No tax is collected either because you are not registered to collect tax in this jurisdiction, or because the non-taxable product tax code (txcd_00000000) was used.

    not_subject_to_tax No tax is imposed on this transaction.

    not_supported No tax applied. Stripe doesn’t support this jurisdiction, territory, or product.

    portion_product_exempt A portion of the price is exempt from tax.

    portion_reduced_rated A portion of the price is taxed at a reduced rate.

    portion_standard_rated A portion of the price is taxed at the standard rate.

    product_exempt The product or service is nontaxable or exempt from tax.

    product_exempt_holiday The product or service is not taxed due to a sales tax holiday.

    Show 6 more

  • total_taxes.taxable_amountnullable integer

    The amount on which tax is calculated, in cents.

  • total_taxes.typeenum

    The type of tax information.

• webhooks_delivered_atnullable timestamp

  Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have been exhausted. This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.