PostInvoicesInvoicePay

{
  "type": "object",
  "description": "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/billing/invoices/workflow/#auto_advance), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send Invoices to Customers](https://stripe.com/docs/billing/invoices/sending).",
  "required": [
    "amount_due",
    "amount_paid",
    "amount_remaining",
    "amount_shipping",
    "attempt_count",
    "attempted",
    "automatic_tax",
    "collection_method",
    "created",
    "currency",
    "default_tax_rates",
    "lines",
    "livemode",
    "object",
    "paid",
    "paid_out_of_band",
    "payment_settings",
    "period_end",
    "period_start",
    "post_payment_credit_notes_amount",
    "pre_payment_credit_notes_amount",
    "starting_balance",
    "status_transitions",
    "subtotal",
    "total",
    "total_tax_amounts"
  ],
  "properties": {
    "account_country": {
      "type": "string",
      "description": "The country of the business associated with this invoice, most often the business creating the invoice."
    },
    "account_name": {
      "type": "string",
      "description": "The public name of the business associated with this invoice, most often the business creating the invoice."
    },
    "account_tax_ids": {
      "type": "array",
      "description": "The account tax IDs associated with the invoice. Only editable when the invoice is a draft.",
      "items": {
        "type": "object"
      }
    },
    "amount_due": {
      "type": "integer",
      "description": "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_paid": {
      "type": "integer",
      "description": "The amount, in %s, that was paid."
    },
    "amount_remaining": {
      "type": "integer",
      "description": "The difference between amount_due and amount_paid, in %s."
    },
    "amount_shipping": {
      "type": "integer",
      "description": "This is the sum of all the shipping amounts."
    },
    "application": {
      "description": "ID of the Connect Application that created the invoice.",
      "type": "object"
    },
    "application_fee_amount": {
      "type": "integer",
      "description": "The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid."
    },
    "attempt_count": {
      "type": "integer",
      "description": "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."
    },
    "attempted": {
      "type": "boolean",
      "description": "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."
    },
    "auto_advance": {
      "type": "boolean",
      "description": "Controls whether Stripe will perform [automatic collection](https://stripe.com/docs/billing/invoices/workflow/#auto_advance) of the invoice. When `false`, the invoice's state will not automatically advance without an explicit action."
    },
    "automatic_tax": {
      "type": "object",
      "required": [
        "enabled"
      ],
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."
        },
        "status": {
          "type": "string",
          "description": "The status of the most recent automated tax calculation for this invoice.",
          "enum": [
            "complete",
            "failed",
            "requires_location_inputs"
          ]
        }
      }
    },
    "billing_reason": {
      "type": "string",
      "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.",
      "enum": [
        "automatic_pending_invoice_item_invoice",
        "manual",
        "quote_accept",
        "subscription",
        "subscription_create",
        "subscription_cycle",
        "subscription_threshold",
        "subscription_update",
        "upcoming"
      ]
    },
    "charge": {
      "description": "ID of the latest charge generated for this invoice, if any.",
      "type": "object"
    },
    "collection_method": {
      "type": "string",
      "description": "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.",
      "enum": [
        "charge_automatically",
        "send_invoice"
      ]
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
    },
    "custom_fields": {
      "type": "array",
      "description": "Custom fields displayed on the invoice.",
      "items": {
        "type": "object",
        "required": [
          "name",
          "value"
        ],
        "properties": {
          "name": {
            "type": "string",
            "description": "The name of the custom field."
          },
          "value": {
            "type": "string",
            "description": "The value of the custom field."
          }
        }
      }
    },
    "customer": {
      "description": "The ID of the customer who will be billed.",
      "type": "object"
    },
    "customer_address": {
      "description": "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.",
      "type": "object"
    },
    "customer_email": {
      "type": "string",
      "description": "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_name": {
      "type": "string",
      "description": "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_phone": {
      "type": "string",
      "description": "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_shipping": {
      "description": "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.",
      "type": "object"
    },
    "customer_tax_exempt": {
      "type": "string",
      "description": "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.",
      "enum": [
        "exempt",
        "none",
        "reverse"
      ]
    },
    "customer_tax_ids": {
      "type": "array",
      "description": "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.",
      "items": {
        "type": "object",
        "required": [
          "type"
        ],
        "properties": {
          "type": {
            "type": "string",
            "description": "The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `eu_oss_vat`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `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`, `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`, or `unknown`",
            "enum": [
              "ae_trn",
              "au_abn",
              "au_arn",
              "bg_uic",
              "br_cnpj",
              "br_cpf",
              "ca_bn",
              "ca_gst_hst",
              "ca_pst_bc",
              "ca_pst_mb",
              "ca_pst_sk",
              "ca_qst",
              "ch_vat",
              "cl_tin",
              "eg_tin",
              "es_cif",
              "eu_oss_vat",
              "eu_vat",
              "gb_vat",
              "ge_vat",
              "hk_br",
              "hu_tin",
              "id_npwp",
              "il_vat",
              "in_gst",
              "is_vat",
              "jp_cn",
              "jp_rn",
              "jp_trn",
              "ke_pin",
              "kr_brn",
              "li_uid",
              "mx_rfc",
              "my_frp",
              "my_itn",
              "my_sst",
              "no_vat",
              "nz_gst",
              "ph_tin",
              "ru_inn",
              "ru_kpp",
              "sa_vat",
              "sg_gst",
              "sg_uen",
              "si_tin",
              "th_vat",
              "tr_tin",
              "tw_vat",
              "ua_vat",
              "unknown",
              "us_ein",
              "za_vat"
            ]
          },
          "value": {
            "type": "string",
            "description": "The value of the tax ID."
          }
        }
      }
    },
    "default_payment_method": {
      "description": "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.",
      "type": "object"
    },
    "default_source": {
      "description": "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.",
      "type": "object"
    },
    "default_tax_rates": {
      "type": "array",
      "description": "The tax rates applied to this invoice, if any.",
      "items": {
        "type": "object",
        "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).",
        "required": [
          "active",
          "created",
          "display_name",
          "id",
          "inclusive",
          "livemode",
          "object",
          "percentage"
        ],
        "properties": {
          "active": {
            "type": "boolean",
            "description": "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."
          },
          "country": {
            "type": "string",
            "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
          },
          "created": {
            "type": "integer",
            "format": "unix-time",
            "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
          },
          "description": {
            "type": "string",
            "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."
          },
          "display_name": {
            "type": "string",
            "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page."
          },
          "id": {
            "type": "string",
            "description": "Unique identifier for the object."
          },
          "inclusive": {
            "type": "boolean",
            "description": "This specifies if the tax rate is inclusive or exclusive."
          },
          "jurisdiction": {
            "type": "string",
            "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice."
          },
          "livemode": {
            "type": "boolean",
            "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
          },
          "metadata": {
            "type": "object",
            "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
          },
          "object": {
            "type": "string",
            "description": "String representing the object's type. Objects of the same type share the same value.",
            "enum": [
              "tax_rate"
            ]
          },
          "percentage": {
            "type": "number",
            "description": "This represents the tax rate percent out of 100."
          },
          "state": {
            "type": "string",
            "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States."
          },
          "tax_type": {
            "type": "string",
            "description": "The high-level tax type, such as `vat` or `sales_tax`.",
            "enum": [
              "gst",
              "hst",
              "igst",
              "jct",
              "lease_tax",
              "pst",
              "qst",
              "rst",
              "sales_tax",
              "vat"
            ]
          }
        }
      }
    },
    "description": {
      "type": "string",
      "description": "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard."
    },
    "discount": {
      "description": "Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.",
      "type": "object"
    },
    "discounts": {
      "type": "array",
      "description": "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.",
      "items": {
        "type": "object"
      }
    },
    "due_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`."
    },
    "ending_balance": {
      "type": "integer",
      "description": "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."
    },
    "footer": {
      "type": "string",
      "description": "Footer displayed on the invoice."
    },
    "from_invoice": {
      "description": "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details.",
      "type": "object"
    },
    "hosted_invoice_url": {
      "type": "string",
      "description": "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."
    },
    "id": {
      "type": "string",
      "description": "Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details."
    },
    "invoice_pdf": {
      "type": "string",
      "description": "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null."
    },
    "last_finalization_error": {
      "description": "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.",
      "type": "object"
    },
    "latest_revision": {
      "description": "The ID of the most recent non-draft revision of this invoice",
      "type": "object"
    },
    "lines": {
      "type": "object",
      "description": "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.",
      "required": [
        "data",
        "has_more",
        "object",
        "url"
      ],
      "properties": {
        "data": {
          "type": "array",
          "description": "Details about each object.",
          "items": {
            "type": "object",
            "required": [
              "amount",
              "currency",
              "discountable",
              "id",
              "livemode",
              "metadata",
              "object",
              "period",
              "proration",
              "type"
            ],
            "properties": {
              "amount": {
                "type": "integer",
                "description": "The amount, in %s."
              },
              "amount_excluding_tax": {
                "type": "integer",
                "description": "The integer amount in %s representing the amount for this line item, excluding all tax and discounts."
              },
              "currency": {
                "type": "string",
                "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies)."
              },
              "description": {
                "type": "string",
                "description": "An arbitrary string attached to the object. Often useful for displaying to users."
              },
              "discount_amounts": {
                "type": "array",
                "description": "The amount of discount calculated per discount for this line item.",
                "items": {
                  "type": "object",
                  "required": [
                    "amount",
                    "discount"
                  ],
                  "properties": {
                    "amount": {
                      "type": "integer",
                      "description": "The amount, in %s, of the discount."
                    },
                    "discount": {
                      "description": "The discount that was applied to get this discount amount.",
                      "type": "object"
                    }
                  }
                }
              },
              "discountable": {
                "type": "boolean",
                "description": "If true, discounts will apply to this line item. Always false for prorations."
              },
              "discounts": {
                "type": "array",
                "description": "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.",
                "items": {
                  "type": "object"
                }
              },
              "id": {
                "type": "string",
                "description": "Unique identifier for the object."
              },
              "invoice_item": {
                "type": "string",
                "description": "The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any."
              },
              "livemode": {
                "type": "boolean",
                "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
              },
              "metadata": {
                "type": "object",
                "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) 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` this will reflect the metadata of the subscription that caused the line item to be created."
              },
              "object": {
                "type": "string",
                "description": "String representing the object's type. Objects of the same type share the same value.",
                "enum": [
                  "line_item"
                ]
              },
              "period": {
                "type": "object",
                "required": [
                  "end",
                  "start"
                ],
                "properties": {
                  "end": {
                    "type": "integer",
                    "format": "unix-time",
                    "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive."
                  },
                  "start": {
                    "type": "integer",
                    "format": "unix-time",
                    "description": "The start of the period. This value is inclusive."
                  }
                }
              },
              "price": {
                "description": "The price of the line item.",
                "type": "object"
              },
              "proration": {
                "type": "boolean",
                "description": "Whether this is a proration."
              },
              "proration_details": {
                "description": "Additional details for proration line items",
                "type": "object"
              },
              "quantity": {
                "type": "integer",
                "description": "The quantity of the subscription, if the line item is a subscription or a proration."
              },
              "subscription": {
                "type": "string",
                "description": "The subscription that the invoice item pertains to, if any."
              },
              "subscription_item": {
                "type": "string",
                "description": "The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription."
              },
              "tax_amounts": {
                "type": "array",
                "description": "The amount of tax calculated per tax rate for this line item",
                "items": {
                  "type": "object",
                  "required": [
                    "amount",
                    "inclusive",
                    "tax_rate"
                  ],
                  "properties": {
                    "amount": {
                      "type": "integer",
                      "description": "The amount, in %s, of the tax."
                    },
                    "inclusive": {
                      "type": "boolean",
                      "description": "Whether this tax amount is inclusive or exclusive."
                    },
                    "tax_rate": {
                      "description": "The tax rate that was applied to get this tax amount.",
                      "type": "object"
                    }
                  }
                }
              },
              "tax_rates": {
                "type": "array",
                "description": "The tax rates which apply to the line item.",
                "items": {
                  "type": "object",
                  "description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax Rates](https://stripe.com/docs/billing/taxes/tax-rates).",
                  "required": [
                    "active",
                    "created",
                    "display_name",
                    "id",
                    "inclusive",
                    "livemode",
                    "object",
                    "percentage"
                  ],
                  "properties": {
                    "active": {
                      "type": "boolean",
                      "description": "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."
                    },
                    "country": {
                      "type": "string",
                      "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."
                    },
                    "created": {
                      "type": "integer",
                      "format": "unix-time",
                      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
                    },
                    "description": {
                      "type": "string",
                      "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."
                    },
                    "display_name": {
                      "type": "string",
                      "description": "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page."
                    },
                    "id": {
                      "type": "string",
                      "description": "Unique identifier for the object."
                    },
                    "inclusive": {
                      "type": "boolean",
                      "description": "This specifies if the tax rate is inclusive or exclusive."
                    },
                    "jurisdiction": {
                      "type": "string",
                      "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice."
                    },
                    "livemode": {
                      "type": "boolean",
                      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
                    },
                    "metadata": {
                      "type": "object",
                      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
                    },
                    "object": {
                      "type": "string",
                      "description": "String representing the object's type. Objects of the same type share the same value.",
                      "enum": [
                        "tax_rate"
                      ]
                    },
                    "percentage": {
                      "type": "number",
                      "description": "This represents the tax rate percent out of 100."
                    },
                    "state": {
                      "type": "string",
                      "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States."
                    },
                    "tax_type": {
                      "type": "string",
                      "description": "The high-level tax type, such as `vat` or `sales_tax`.",
                      "enum": [
                        "gst",
                        "hst",
                        "igst",
                        "jct",
                        "lease_tax",
                        "pst",
                        "qst",
                        "rst",
                        "sales_tax",
                        "vat"
                      ]
                    }
                  }
                }
              },
              "type": {
                "type": "string",
                "description": "A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`.",
                "enum": [
                  "invoiceitem",
                  "subscription"
                ]
              },
              "unit_amount_excluding_tax": {
                "type": "string",
                "format": "decimal",
                "description": "The amount in %s representing the unit amount for this line item, excluding all tax and discounts."
              }
            }
          }
        },
        "has_more": {
          "type": "boolean",
          "description": "True if this list has another page of items after this one that can be fetched."
        },
        "object": {
          "type": "string",
          "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
          "enum": [
            "list"
          ]
        },
        "url": {
          "type": "string",
          "description": "The URL where this list can be accessed."
        }
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."
    },
    "next_payment_attempt": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`."
    },
    "number": {
      "type": "string",
      "description": "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."
    },
    "object": {
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.",
      "enum": [
        "invoice"
      ]
    },
    "on_behalf_of": {
      "description": "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](https://stripe.com/docs/billing/invoices/connect) documentation for details.",
      "type": "object"
    },
    "paid": {
      "type": "boolean",
      "description": "Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance."
    },
    "paid_out_of_band": {
      "type": "boolean",
      "description": "Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe."
    },
    "payment_intent": {
      "description": "The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.",
      "type": "object"
    },
    "payment_settings": {
      "type": "object",
      "properties": {
        "default_mandate": {
          "type": "string",
          "description": "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_method_options": {
          "description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
          "type": "object"
        },
        "payment_method_types": {
          "type": "array",
          "description": "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](https://dashboard.stripe.com/settings/billing/invoice).",
          "items": {
            "type": "string",
            "enum": [
              "ach_credit_transfer",
              "ach_debit",
              "acss_debit",
              "au_becs_debit",
              "bacs_debit",
              "bancontact",
              "boleto",
              "card",
              "customer_balance",
              "fpx",
              "giropay",
              "grabpay",
              "ideal",
              "konbini",
              "link",
              "paynow",
              "promptpay",
              "sepa_debit",
              "sofort",
              "us_bank_account",
              "wechat_pay"
            ]
          }
        }
      }
    },
    "period_end": {
      "type": "integer",
      "format": "unix-time",
      "description": "End of the usage period during which invoice items were added to this invoice."
    },
    "period_start": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start of the usage period during which invoice items were added to this invoice."
    },
    "post_payment_credit_notes_amount": {
      "type": "integer",
      "description": "Total amount of all post-payment credit notes issued for this invoice."
    },
    "pre_payment_credit_notes_amount": {
      "type": "integer",
      "description": "Total amount of all pre-payment credit notes issued for this invoice."
    },
    "quote": {
      "description": "The quote this invoice was generated from.",
      "type": "object"
    },
    "receipt_number": {
      "type": "string",
      "description": "This is the transaction number that appears on email receipts sent for this invoice."
    },
    "rendering_options": {
      "description": "Options for invoice PDF rendering.",
      "type": "object"
    },
    "shipping_cost": {
      "description": "The details of the cost of shipping, including the ShippingRate applied on the invoice.",
      "type": "object"
    },
    "shipping_details": {
      "description": "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.",
      "type": "object"
    },
    "starting_balance": {
      "type": "integer",
      "description": "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_descriptor": {
      "type": "string",
      "description": "Extra information about an invoice for the customer's credit card statement."
    },
    "status": {
      "type": "string",
      "description": "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)",
      "enum": [
        "deleted",
        "draft",
        "open",
        "paid",
        "uncollectible",
        "void"
      ]
    },
    "status_transitions": {
      "type": "object",
      "properties": {
        "finalized_at": {
          "type": "integer",
          "format": "unix-time",
          "description": "The time that the invoice draft was finalized."
        },
        "marked_uncollectible_at": {
          "type": "integer",
          "format": "unix-time",
          "description": "The time that the invoice was marked uncollectible."
        },
        "paid_at": {
          "type": "integer",
          "format": "unix-time",
          "description": "The time that the invoice was paid."
        },
        "voided_at": {
          "type": "integer",
          "format": "unix-time",
          "description": "The time that the invoice was voided."
        }
      }
    },
    "subscription": {
      "description": "The subscription that this invoice was prepared for, if any.",
      "type": "object"
    },
    "subscription_proration_date": {
      "type": "integer",
      "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations."
    },
    "subtotal": {
      "type": "integer",
      "description": "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_tax": {
      "type": "integer",
      "description": "The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated"
    },
    "tax": {
      "type": "integer",
      "description": "The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice."
    },
    "test_clock": {
      "description": "ID of the test clock this invoice belongs to.",
      "type": "object"
    },
    "threshold_reason": {
      "type": "object",
      "required": [
        "item_reasons"
      ],
      "properties": {
        "amount_gte": {
          "type": "integer",
          "description": "The total invoice amount threshold boundary if it triggered the threshold invoice."
        },
        "item_reasons": {
          "type": "array",
          "description": "Indicates which line items triggered a threshold invoice.",
          "items": {
            "type": "object",
            "required": [
              "line_item_ids",
              "usage_gte"
            ],
            "properties": {
              "line_item_ids": {
                "type": "array",
                "description": "The IDs of the line items that triggered the threshold invoice.",
                "items": {
                  "type": "string"
                }
              },
              "usage_gte": {
                "type": "integer",
                "description": "The quantity threshold boundary that applied to the given line item."
              }
            }
          }
        }
      }
    },
    "total": {
      "type": "integer",
      "description": "Total after discounts and taxes."
    },
    "total_discount_amounts": {
      "type": "array",
      "description": "The aggregate amounts calculated per discount across all line items.",
      "items": {
        "type": "object",
        "additionalProperties": true
      }
    },
    "total_excluding_tax": {
      "type": "integer",
      "description": "The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax."
    },
    "total_tax_amounts": {
      "type": "array",
      "description": "The aggregate amounts calculated per tax rate for all line items.",
      "items": {
        "type": "object",
        "required": [
          "amount",
          "inclusive",
          "tax_rate"
        ],
        "properties": {
          "amount": {
            "type": "integer",
            "description": "The amount, in %s, of the tax."
          },
          "inclusive": {
            "type": "boolean",
            "description": "Whether this tax amount is inclusive or exclusive."
          },
          "tax_rate": {
            "description": "The tax rate that was applied to get this tax amount.",
            "type": "object"
          }
        }
      }
    },
    "transfer_data": {
      "description": "The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.",
      "type": "object"
    },
    "webhooks_delivered_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). 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."
    }
  }
}