{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/stripe/main/json-schema/stripe-card-schema.json",
  "title": "Card",
  "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/stripe-customers-api-openapi.yml#/components/schemas/card",
  "properties": {
    "account": {
      "anyOf": [
        {
          "maxLength": 5000,
          "type": "string"
        },
        {
          "$ref": "#/$defs/account"
        }
      ],
      "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/$defs/account"
          }
        ]
      }
    },
    "address_city": {
      "description": "City/District/Suburb/Town/Village.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_country": {
      "description": "Billing address country, if provided when creating card.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_line1": {
      "description": "Address line 1 (Street address/PO Box/Company name).",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_line1_check": {
      "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_line2": {
      "description": "Address line 2 (Apartment/Suite/Unit/Building).",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_state": {
      "description": "State/County/Province/Region.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_zip": {
      "description": "ZIP or postal code.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "address_zip_check": {
      "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "available_payout_methods": {
      "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.",
      "items": {
        "enum": [
          "instant",
          "standard"
        ],
        "type": "string"
      },
      "type": [
        "array",
        "null"
      ]
    },
    "brand": {
      "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.",
      "maxLength": 5000,
      "type": "string"
    },
    "country": {
      "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "currency": {
      "description": "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.",
      "type": [
        "string",
        "null"
      ]
    },
    "customer": {
      "anyOf": [
        {
          "maxLength": 5000,
          "type": "string"
        },
        {
          "$ref": "#/$defs/customer"
        },
        {
          "$ref": "#/$defs/deleted_customer"
        }
      ],
      "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/$defs/customer"
          },
          {
            "$ref": "#/$defs/deleted_customer"
          }
        ]
      }
    },
    "cvc_check": {
      "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "default_for_currency": {
      "description": "Whether this card is the default external account for its currency.",
      "type": [
        "boolean",
        "null"
      ]
    },
    "dynamic_last4": {
      "description": "(For tokenized numbers only.) The last four digits of the device account number.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "exp_month": {
      "description": "Two-digit number representing the card's expiration month.",
      "type": "integer"
    },
    "exp_year": {
      "description": "Four-digit number representing the card's expiration year.",
      "type": "integer"
    },
    "fingerprint": {
      "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same cardone for India and one for the rest of the world.*",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "funding": {
      "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
      "maxLength": 5000,
      "type": "string"
    },
    "id": {
      "description": "Unique identifier for the object.",
      "maxLength": 5000,
      "type": "string"
    },
    "last4": {
      "description": "The last four digits of the card.",
      "maxLength": 5000,
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {
        "maxLength": 500,
        "type": "string"
      },
      "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.",
      "type": [
        "object",
        "null"
      ]
    },
    "name": {
      "description": "Cardholder name.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "object": {
      "description": "String representing the object's type. Objects of the same type share the same value.",
      "enum": [
        "card"
      ],
      "type": "string"
    },
    "status": {
      "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    },
    "tokenization_method": {
      "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.",
      "maxLength": 5000,
      "type": [
        "string",
        "null"
      ]
    }
  },
  "required": [
    "brand",
    "exp_month",
    "exp_year",
    "funding",
    "id",
    "last4",
    "object"
  ],
  "type": "object",
  "x-expandableFields": [
    "account",
    "customer"
  ],
  "x-resourceId": "card",
  "$defs": {
    "bank_account": {
      "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](https://stripe.com/docs/api#external_accounts) are transfer\ndestinations on `Account` objects for [Custom accounts](https://stripe.com/docs/connect/custom-accounts).\nThey can be bank accounts or debit cards as well, and are documented in the links above.\n\nRelated guide: [Bank debits and transfers](https://stripe.com/docs/payments/bank-debits-transfers)",
      "properties": {
        "account": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/account"
            }
          ],
          "description": "The ID of the account that the bank account is associated with.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/account"
              }
            ]
          }
        },
        "account_holder_name": {
          "description": "The name of the person or business that owns the bank account.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "account_holder_type": {
          "description": "The type of entity that holds the account. This can be either `individual` or `company`.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "account_type": {
          "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "available_payout_methods": {
          "description": "A set of available payout methods for this bank account. Only values from this set should be passed as the `method` when creating a payout.",
          "items": {
            "enum": [
              "instant",
              "standard"
            ],
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "bank_name": {
          "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`).",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "country": {
          "description": "Two-letter ISO code representing the country the bank account is located in.",
          "maxLength": 5000,
          "type": "string"
        },
        "currency": {
          "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account.",
          "type": "string"
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            },
            {
              "$ref": "#/$defs/deleted_customer"
            }
          ],
          "description": "The ID of the customer that the bank account is associated with.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              },
              {
                "$ref": "#/$defs/deleted_customer"
              }
            ]
          }
        },
        "default_for_currency": {
          "description": "Whether this bank account is the default external account for its currency.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "fingerprint": {
          "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "future_requirements": {
          "anyOf": [
            {
              "$ref": "#/$defs/external_account_requirements"
            }
          ],
          "description": "Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when."
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "last4": {
          "description": "The last four digits of the bank account number.",
          "maxLength": 5000,
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {
            "maxLength": 500,
            "type": "string"
          },
          "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.",
          "type": [
            "object",
            "null"
          ]
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "bank_account"
          ],
          "type": "string"
        },
        "requirements": {
          "anyOf": [
            {
              "$ref": "#/$defs/external_account_requirements"
            }
          ],
          "description": "Information about the requirements for the bank account, including what information needs to be collected."
        },
        "routing_number": {
          "description": "The routing transit number for the bank account.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "status": {
          "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.",
          "maxLength": 5000,
          "type": "string"
        }
      },
      "required": [
        "country",
        "currency",
        "id",
        "last4",
        "object",
        "status"
      ],
      "title": "BankAccount",
      "type": "object",
      "x-expandableFields": [
        "account",
        "customer",
        "future_requirements",
        "requirements"
      ],
      "x-resourceId": "bank_account"
    },
    "card": {
      "description": "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)",
      "properties": {
        "account": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/account"
            }
          ],
          "description": "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/account"
              }
            ]
          }
        },
        "address_city": {
          "description": "City/District/Suburb/Town/Village.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_country": {
          "description": "Billing address country, if provided when creating card.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_line1": {
          "description": "Address line 1 (Street address/PO Box/Company name).",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_line1_check": {
          "description": "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_line2": {
          "description": "Address line 2 (Apartment/Suite/Unit/Building).",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_state": {
          "description": "State/County/Province/Region.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_zip": {
          "description": "ZIP or postal code.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "address_zip_check": {
          "description": "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "available_payout_methods": {
          "description": "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout.",
          "items": {
            "enum": [
              "instant",
              "standard"
            ],
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "brand": {
          "description": "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`.",
          "maxLength": 5000,
          "type": "string"
        },
        "country": {
          "description": "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "currency": {
          "description": "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency.",
          "type": [
            "string",
            "null"
          ]
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            },
            {
              "$ref": "#/$defs/deleted_customer"
            }
          ],
          "description": "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              },
              {
                "$ref": "#/$defs/deleted_customer"
              }
            ]
          }
        },
        "cvc_check": {
          "description": "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge).",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "default_for_currency": {
          "description": "Whether this card is the default external account for its currency.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "dynamic_last4": {
          "description": "(For tokenized numbers only.) The last four digits of the device account number.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "exp_month": {
          "description": "Two-digit number representing the card's expiration month.",
          "type": "integer"
        },
        "exp_year": {
          "description": "Four-digit number representing the card's expiration year.",
          "type": "integer"
        },
        "fingerprint": {
          "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same cardone for India and one for the rest of the world.*",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "funding": {
          "description": "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`.",
          "maxLength": 5000,
          "type": "string"
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "last4": {
          "description": "The last four digits of the card.",
          "maxLength": 5000,
          "type": "string"
        },
        "metadata": {
          "additionalProperties": {
            "maxLength": 500,
            "type": "string"
          },
          "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.",
          "type": [
            "object",
            "null"
          ]
        },
        "name": {
          "description": "Cardholder name.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "card"
          ],
          "type": "string"
        },
        "status": {
          "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "tokenization_method": {
          "description": "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "brand",
        "exp_month",
        "exp_year",
        "funding",
        "id",
        "last4",
        "object"
      ],
      "title": "Card",
      "type": "object",
      "x-expandableFields": [
        "account",
        "customer"
      ],
      "x-resourceId": "card"
    },
    "cash_balance": {
      "description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.",
      "properties": {
        "available": {
          "additionalProperties": {
            "type": "integer"
          },
          "description": "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
          "type": [
            "object",
            "null"
          ]
        },
        "customer": {
          "description": "The ID of the customer whose cash balance this object represents.",
          "maxLength": 5000,
          "type": "string"
        },
        "livemode": {
          "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
          "type": "boolean"
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "cash_balance"
          ],
          "type": "string"
        },
        "settings": {
          "$ref": "#/$defs/customer_balance_customer_balance_settings"
        }
      },
      "required": [
        "customer",
        "livemode",
        "object",
        "settings"
      ],
      "title": "cash_balance",
      "type": "object",
      "x-expandableFields": [
        "settings"
      ],
      "x-resourceId": "cash_balance"
    },
    "customer": {
      "description": "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)",
      "properties": {
        "address": {
          "anyOf": [
            {
              "$ref": "#/$defs/address"
            }
          ],
          "description": "The customer's address."
        },
        "balance": {
          "description": "The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.",
          "type": "integer"
        },
        "cash_balance": {
          "anyOf": [
            {
              "$ref": "#/$defs/cash_balance"
            }
          ],
          "description": "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically."
        },
        "created": {
          "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": "integer"
        },
        "currency": {
          "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "default_source": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/bank_account"
            },
            {
              "$ref": "#/$defs/card"
            },
            {
              "$ref": "#/$defs/source"
            }
          ],
          "description": "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/bank_account"
              },
              {
                "$ref": "#/$defs/card"
              },
              {
                "$ref": "#/$defs/source"
              }
            ]
          },
          "x-stripeBypassValidation": true
        },
        "delinquent": {
          "description": "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`.",
          "type": [
            "boolean",
            "null"
          ]
        },
        "description": {
          "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "discount": {
          "anyOf": [
            {
              "$ref": "#/$defs/discount"
            }
          ],
          "description": "Describes the current discount active on the customer, if there is one."
        },
        "email": {
          "description": "The customer's email address.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "invoice_credit_balance": {
          "additionalProperties": {
            "type": "integer"
          },
          "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.",
          "type": "object"
        },
        "invoice_prefix": {
          "description": "The prefix for the customer used to generate unique invoice numbers.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "invoice_settings": {
          "$ref": "#/$defs/invoice_setting_customer_setting"
        },
        "livemode": {
          "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
          "type": "boolean"
        },
        "metadata": {
          "additionalProperties": {
            "maxLength": 500,
            "type": "string"
          },
          "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.",
          "type": "object"
        },
        "name": {
          "description": "The customer's full name or business name.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "next_invoice_sequence": {
          "description": "The suffix of the customer's next invoice number (for example, 0001).",
          "type": "integer"
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "customer"
          ],
          "type": "string"
        },
        "phone": {
          "description": "The customer's phone number.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "preferred_locales": {
          "description": "The customer's preferred locales (languages), ordered by preference.",
          "items": {
            "maxLength": 5000,
            "type": "string"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "shipping": {
          "anyOf": [
            {
              "$ref": "#/$defs/shipping"
            }
          ],
          "description": "Mailing and shipping address for the customer. Appears on invoices emailed to this customer."
        },
        "sources": {
          "description": "The customer's payment sources, if any.",
          "properties": {
            "data": {
              "description": "Details about each object.",
              "items": {
                "anyOf": [
                  {
                    "$ref": "#/$defs/bank_account"
                  },
                  {
                    "$ref": "#/$defs/card"
                  },
                  {
                    "$ref": "#/$defs/source"
                  }
                ],
                "title": "Polymorphic",
                "x-stripeBypassValidation": true
              },
              "type": "array"
            },
            "has_more": {
              "description": "True if this list has another page of items after this one that can be fetched.",
              "type": "boolean"
            },
            "object": {
              "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
              "enum": [
                "list"
              ],
              "type": "string"
            },
            "url": {
              "description": "The URL where this list can be accessed.",
              "maxLength": 5000,
              "type": "string"
            }
          },
          "required": [
            "data",
            "has_more",
            "object",
            "url"
          ],
          "title": "ApmsSourcesSourceList",
          "type": "object",
          "x-expandableFields": [
            "data"
          ]
        },
        "subscriptions": {
          "description": "The customer's current subscriptions, if any.",
          "properties": {
            "data": {
              "description": "Details about each object.",
              "items": {
                "$ref": "#/$defs/subscription"
              },
              "type": "array"
            },
            "has_more": {
              "description": "True if this list has another page of items after this one that can be fetched.",
              "type": "boolean"
            },
            "object": {
              "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
              "enum": [
                "list"
              ],
              "type": "string"
            },
            "url": {
              "description": "The URL where this list can be accessed.",
              "maxLength": 5000,
              "type": "string"
            }
          },
          "required": [
            "data",
            "has_more",
            "object",
            "url"
          ],
          "title": "SubscriptionList",
          "type": "object",
          "x-expandableFields": [
            "data"
          ]
        },
        "tax": {
          "$ref": "#/$defs/customer_tax"
        },
        "tax_exempt": {
          "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.",
          "enum": [
            "exempt",
            "none",
            "reverse"
          ],
          "type": [
            "string",
            "null"
          ]
        },
        "tax_ids": {
          "description": "The customer's tax IDs.",
          "properties": {
            "data": {
              "description": "Details about each object.",
              "items": {
                "$ref": "#/$defs/tax_id"
              },
              "type": "array"
            },
            "has_more": {
              "description": "True if this list has another page of items after this one that can be fetched.",
              "type": "boolean"
            },
            "object": {
              "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
              "enum": [
                "list"
              ],
              "type": "string"
            },
            "url": {
              "description": "The URL where this list can be accessed.",
              "maxLength": 5000,
              "type": "string"
            }
          },
          "required": [
            "data",
            "has_more",
            "object",
            "url"
          ],
          "title": "TaxIDsList",
          "type": "object",
          "x-expandableFields": [
            "data"
          ]
        },
        "test_clock": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/test_helpers.test_clock"
            }
          ],
          "description": "ID of the test clock that this customer belongs to.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/test_helpers.test_clock"
              }
            ]
          }
        }
      },
      "required": [
        "created",
        "id",
        "livemode",
        "object"
      ],
      "title": "Customer",
      "type": "object",
      "x-expandableFields": [
        "address",
        "cash_balance",
        "default_source",
        "discount",
        "invoice_settings",
        "shipping",
        "sources",
        "subscriptions",
        "tax",
        "tax_ids",
        "test_clock"
      ],
      "x-resourceId": "customer"
    },
    "deleted_customer": {
      "description": "",
      "properties": {
        "deleted": {
          "description": "Always true for a deleted object",
          "enum": [
            true
          ],
          "type": "boolean"
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "customer"
          ],
          "type": "string"
        }
      },
      "required": [
        "deleted",
        "id",
        "object"
      ],
      "title": "DeletedCustomer",
      "type": "object",
      "x-expandableFields": [],
      "x-resourceId": "deleted_customer"
    },
    "discount": {
      "description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)",
      "properties": {
        "checkout_session": {
          "description": "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "coupon": {
          "$ref": "#/$defs/coupon"
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            },
            {
              "$ref": "#/$defs/deleted_customer"
            }
          ],
          "description": "The ID of the customer associated with this discount.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              },
              {
                "$ref": "#/$defs/deleted_customer"
              }
            ]
          }
        },
        "end": {
          "description": "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "id": {
          "description": "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array.",
          "maxLength": 5000,
          "type": "string"
        },
        "invoice": {
          "description": "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "invoice_item": {
          "description": "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "discount"
          ],
          "type": "string"
        },
        "promotion_code": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/promotion_code"
            }
          ],
          "description": "The promotion code applied to create this discount.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/promotion_code"
              }
            ]
          }
        },
        "start": {
          "description": "Date that the coupon was applied.",
          "format": "unix-time",
          "type": "integer"
        },
        "subscription": {
          "description": "The subscription that this coupon is applied to, if it is applied to a particular subscription.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        }
      },
      "required": [
        "coupon",
        "id",
        "object",
        "start"
      ],
      "title": "Discount",
      "type": "object",
      "x-expandableFields": [
        "coupon",
        "customer",
        "promotion_code"
      ],
      "x-resourceId": "discount"
    },
    "payment_method": {
      "description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).",
      "properties": {
        "acss_debit": {
          "$ref": "#/$defs/payment_method_acss_debit"
        },
        "affirm": {
          "$ref": "#/$defs/payment_method_affirm"
        },
        "afterpay_clearpay": {
          "$ref": "#/$defs/payment_method_afterpay_clearpay"
        },
        "alipay": {
          "$ref": "#/$defs/payment_flows_private_payment_methods_alipay"
        },
        "au_becs_debit": {
          "$ref": "#/$defs/payment_method_au_becs_debit"
        },
        "bacs_debit": {
          "$ref": "#/$defs/payment_method_bacs_debit"
        },
        "bancontact": {
          "$ref": "#/$defs/payment_method_bancontact"
        },
        "billing_details": {
          "$ref": "#/$defs/billing_details"
        },
        "blik": {
          "$ref": "#/$defs/payment_method_blik"
        },
        "boleto": {
          "$ref": "#/$defs/payment_method_boleto"
        },
        "card": {
          "$ref": "#/$defs/payment_method_card"
        },
        "card_present": {
          "$ref": "#/$defs/payment_method_card_present"
        },
        "cashapp": {
          "$ref": "#/$defs/payment_method_cashapp"
        },
        "created": {
          "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": "integer"
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            }
          ],
          "description": "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              }
            ]
          }
        },
        "customer_balance": {
          "$ref": "#/$defs/payment_method_customer_balance"
        },
        "eps": {
          "$ref": "#/$defs/payment_method_eps"
        },
        "fpx": {
          "$ref": "#/$defs/payment_method_fpx"
        },
        "giropay": {
          "$ref": "#/$defs/payment_method_giropay"
        },
        "grabpay": {
          "$ref": "#/$defs/payment_method_grabpay"
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "ideal": {
          "$ref": "#/$defs/payment_method_ideal"
        },
        "interac_present": {
          "$ref": "#/$defs/payment_method_interac_present"
        },
        "klarna": {
          "$ref": "#/$defs/payment_method_klarna"
        },
        "konbini": {
          "$ref": "#/$defs/payment_method_konbini"
        },
        "link": {
          "$ref": "#/$defs/payment_method_link"
        },
        "livemode": {
          "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
          "type": "boolean"
        },
        "metadata": {
          "additionalProperties": {
            "maxLength": 500,
            "type": "string"
          },
          "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.",
          "type": [
            "object",
            "null"
          ]
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "payment_method"
          ],
          "type": "string"
        },
        "oxxo": {
          "$ref": "#/$defs/payment_method_oxxo"
        },
        "p24": {
          "$ref": "#/$defs/payment_method_p24"
        },
        "paynow": {
          "$ref": "#/$defs/payment_method_paynow"
        },
        "paypal": {
          "$ref": "#/$defs/payment_method_paypal"
        },
        "pix": {
          "$ref": "#/$defs/payment_method_pix"
        },
        "promptpay": {
          "$ref": "#/$defs/payment_method_promptpay"
        },
        "radar_options": {
          "$ref": "#/$defs/radar_radar_options"
        },
        "revolut_pay": {
          "$ref": "#/$defs/payment_method_revolut_pay"
        },
        "sepa_debit": {
          "$ref": "#/$defs/payment_method_sepa_debit"
        },
        "sofort": {
          "$ref": "#/$defs/payment_method_sofort"
        },
        "type": {
          "description": "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.",
          "enum": [
            "acss_debit",
            "affirm",
            "afterpay_clearpay",
            "alipay",
            "au_becs_debit",
            "bacs_debit",
            "bancontact",
            "blik",
            "boleto",
            "card",
            "card_present",
            "cashapp",
            "customer_balance",
            "eps",
            "fpx",
            "giropay",
            "grabpay",
            "ideal",
            "interac_present",
            "klarna",
            "konbini",
            "link",
            "oxxo",
            "p24",
            "paynow",
            "paypal",
            "pix",
            "promptpay",
            "revolut_pay",
            "sepa_debit",
            "sofort",
            "us_bank_account",
            "wechat_pay",
            "zip"
          ],
          "type": "string",
          "x-stripeBypassValidation": true
        },
        "us_bank_account": {
          "$ref": "#/$defs/payment_method_us_bank_account"
        },
        "wechat_pay": {
          "$ref": "#/$defs/payment_method_wechat_pay"
        },
        "zip": {
          "$ref": "#/$defs/payment_method_zip"
        }
      },
      "required": [
        "billing_details",
        "created",
        "id",
        "livemode",
        "object",
        "type"
      ],
      "title": "PaymentMethod",
      "type": "object",
      "x-expandableFields": [
        "acss_debit",
        "affirm",
        "afterpay_clearpay",
        "alipay",
        "au_becs_debit",
        "bacs_debit",
        "bancontact",
        "billing_details",
        "blik",
        "boleto",
        "card",
        "card_present",
        "cashapp",
        "customer",
        "customer_balance",
        "eps",
        "fpx",
        "giropay",
        "grabpay",
        "ideal",
        "interac_present",
        "klarna",
        "konbini",
        "link",
        "oxxo",
        "p24",
        "paynow",
        "paypal",
        "pix",
        "promptpay",
        "radar_options",
        "revolut_pay",
        "sepa_debit",
        "sofort",
        "us_bank_account",
        "wechat_pay",
        "zip"
      ],
      "x-resourceId": "payment_method"
    },
    "subscription": {
      "description": "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)",
      "properties": {
        "application": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/application"
            },
            {
              "$ref": "#/$defs/deleted_application"
            }
          ],
          "description": "ID of the Connect Application that created the subscription.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/application"
              },
              {
                "$ref": "#/$defs/deleted_application"
              }
            ]
          }
        },
        "application_fee_percent": {
          "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.",
          "type": [
            "number",
            "null"
          ]
        },
        "automatic_tax": {
          "$ref": "#/$defs/subscription_automatic_tax"
        },
        "billing_cycle_anchor": {
          "description": "Determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format.",
          "format": "unix-time",
          "type": "integer"
        },
        "billing_thresholds": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscription_billing_thresholds"
            }
          ],
          "description": "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"
        },
        "cancel_at": {
          "description": "A date in the future at which the subscription will automatically get canceled",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "cancel_at_period_end": {
          "description": "If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period.",
          "type": "boolean"
        },
        "canceled_at": {
          "description": "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "cancellation_details": {
          "anyOf": [
            {
              "$ref": "#/$defs/cancellation_details"
            }
          ],
          "description": "Details about why this subscription was cancelled"
        },
        "collection_method": {
          "description": "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`.",
          "enum": [
            "charge_automatically",
            "send_invoice"
          ],
          "type": "string"
        },
        "created": {
          "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": "integer"
        },
        "currency": {
          "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).",
          "type": "string"
        },
        "current_period_end": {
          "description": "End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.",
          "format": "unix-time",
          "type": "integer"
        },
        "current_period_start": {
          "description": "Start of the current period that the subscription has been invoiced for.",
          "format": "unix-time",
          "type": "integer"
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            },
            {
              "$ref": "#/$defs/deleted_customer"
            }
          ],
          "description": "ID of the customer who owns the subscription.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              },
              {
                "$ref": "#/$defs/deleted_customer"
              }
            ]
          }
        },
        "days_until_due": {
          "description": "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`.",
          "type": [
            "integer",
            "null"
          ]
        },
        "default_payment_method": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/payment_method"
            }
          ],
          "description": "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/payment_method"
              }
            ]
          }
        },
        "default_source": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/bank_account"
            },
            {
              "$ref": "#/$defs/card"
            },
            {
              "$ref": "#/$defs/source"
            }
          ],
          "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/bank_account"
              },
              {
                "$ref": "#/$defs/card"
              },
              {
                "$ref": "#/$defs/source"
              }
            ]
          },
          "x-stripeBypassValidation": true
        },
        "default_tax_rates": {
          "description": "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription.",
          "items": {
            "$ref": "#/$defs/tax_rate"
          },
          "type": [
            "array",
            "null"
          ]
        },
        "description": {
          "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
          "maxLength": 500,
          "type": [
            "string",
            "null"
          ]
        },
        "discount": {
          "anyOf": [
            {
              "$ref": "#/$defs/discount"
            }
          ],
          "description": "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis."
        },
        "ended_at": {
          "description": "If the subscription has ended, the date the subscription ended.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "items": {
          "description": "List of subscription items, each with an attached price.",
          "properties": {
            "data": {
              "description": "Details about each object.",
              "items": {
                "$ref": "#/$defs/subscription_item"
              },
              "type": "array"
            },
            "has_more": {
              "description": "True if this list has another page of items after this one that can be fetched.",
              "type": "boolean"
            },
            "object": {
              "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
              "enum": [
                "list"
              ],
              "type": "string"
            },
            "url": {
              "description": "The URL where this list can be accessed.",
              "maxLength": 5000,
              "type": "string"
            }
          },
          "required": [
            "data",
            "has_more",
            "object",
            "url"
          ],
          "title": "SubscriptionItemList",
          "type": "object",
          "x-expandableFields": [
            "data"
          ]
        },
        "latest_invoice": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/invoice"
            }
          ],
          "description": "The most recent invoice this subscription has generated.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/invoice"
              }
            ]
          }
        },
        "livemode": {
          "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
          "type": "boolean"
        },
        "metadata": {
          "additionalProperties": {
            "maxLength": 500,
            "type": "string"
          },
          "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.",
          "type": "object"
        },
        "next_pending_invoice_item_invoice": {
          "description": "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "subscription"
          ],
          "type": "string"
        },
        "on_behalf_of": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/account"
            }
          ],
          "description": "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/account"
              }
            ]
          }
        },
        "pause_collection": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscriptions_resource_pause_collection"
            }
          ],
          "description": "If specified, payment collection for this subscription will be paused."
        },
        "payment_settings": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscriptions_resource_payment_settings"
            }
          ],
          "description": "Payment settings passed on to invoices created by the subscription."
        },
        "pending_invoice_item_interval": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscription_pending_invoice_item_interval"
            }
          ],
          "description": "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."
        },
        "pending_setup_intent": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/setup_intent"
            }
          ],
          "description": "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2).",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/setup_intent"
              }
            ]
          }
        },
        "pending_update": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscriptions_resource_pending_update"
            }
          ],
          "description": "If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid."
        },
        "schedule": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/subscription_schedule"
            }
          ],
          "description": "The schedule attached to the subscription",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/subscription_schedule"
              }
            ]
          }
        },
        "start_date": {
          "description": "Date when the subscription was first created. The date might differ from the `created` date due to backdating.",
          "format": "unix-time",
          "type": "integer"
        },
        "status": {
          "description": "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, or `unpaid`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this state can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` state. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal state, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices.",
          "enum": [
            "active",
            "canceled",
            "incomplete",
            "incomplete_expired",
            "past_due",
            "paused",
            "trialing",
            "unpaid"
          ],
          "type": "string"
        },
        "test_clock": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/test_helpers.test_clock"
            }
          ],
          "description": "ID of the test clock this subscription belongs to.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/test_helpers.test_clock"
              }
            ]
          }
        },
        "transfer_data": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscription_transfer_data"
            }
          ],
          "description": "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."
        },
        "trial_end": {
          "description": "If the subscription has a trial, the end of that trial.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        },
        "trial_settings": {
          "anyOf": [
            {
              "$ref": "#/$defs/subscriptions_trials_resource_trial_settings"
            }
          ],
          "description": "Settings related to subscription trials."
        },
        "trial_start": {
          "description": "If the subscription has a trial, the beginning of that trial.",
          "format": "unix-time",
          "type": [
            "integer",
            "null"
          ]
        }
      },
      "required": [
        "automatic_tax",
        "billing_cycle_anchor",
        "cancel_at_period_end",
        "collection_method",
        "created",
        "currency",
        "current_period_end",
        "current_period_start",
        "customer",
        "id",
        "items",
        "livemode",
        "metadata",
        "object",
        "start_date",
        "status"
      ],
      "title": "Subscription",
      "type": "object",
      "x-expandableFields": [
        "application",
        "automatic_tax",
        "billing_thresholds",
        "cancellation_details",
        "customer",
        "default_payment_method",
        "default_source",
        "default_tax_rates",
        "discount",
        "items",
        "latest_invoice",
        "on_behalf_of",
        "pause_collection",
        "payment_settings",
        "pending_invoice_item_interval",
        "pending_setup_intent",
        "pending_update",
        "schedule",
        "test_clock",
        "transfer_data",
        "trial_settings"
      ],
      "x-resourceId": "subscription"
    },
    "tax_id": {
      "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)",
      "properties": {
        "country": {
          "description": "Two-letter ISO code representing the country of the tax ID.",
          "maxLength": 5000,
          "type": [
            "string",
            "null"
          ]
        },
        "created": {
          "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
          "format": "unix-time",
          "type": "integer"
        },
        "customer": {
          "anyOf": [
            {
              "maxLength": 5000,
              "type": "string"
            },
            {
              "$ref": "#/$defs/customer"
            }
          ],
          "description": "ID of the customer.",
          "x-expansionResources": {
            "oneOf": [
              {
                "$ref": "#/$defs/customer"
              }
            ]
          }
        },
        "id": {
          "description": "Unique identifier for the object.",
          "maxLength": 5000,
          "type": "string"
        },
        "livemode": {
          "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
          "type": "boolean"
        },
        "object": {
          "description": "String representing the object's type. Objects of the same type share the same value.",
          "enum": [
            "tax_id"
          ],
          "type": "string"
        },
        "type": {
          "description": "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `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`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`",
          "enum": [
            "ad_nrt",
            "ae_trn",
            "ar_cuit",
            "au_abn",
            "au_arn",
            "bg_uic",
            "bo_tin",
            "br_cnpj",
            "br_cpf",
            "ca_bn",
            "ca_gst_hst",
            "ca_pst_bc",
            "ca_pst_mb",
            "ca_pst_sk",
            "ca_qst",
            "ch_vat",
            "cl_tin",
            "cn_tin",
            "co_nit",
            "cr_tin",
            "do_rcn",
            "ec_ruc",
            "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",
            "pe_ruc",
            "ph_tin",
            "ro_tin",
            "rs_pib",
            "ru_inn",
            "ru_kpp",
            "sa_vat",
            "sg_gst",
            "sg_uen",
            "si_tin",
            "sv_nit",
            "th_vat",
            "tr_tin",
            "tw_vat",
            "ua_vat",
            "unknown",
            "us_ein",
            "uy_ruc",
            "ve_rif",
            "vn_tin",
            "za_vat"
          ],
          "type": "string"
        },
        "value": {
          "description": "Value of the tax ID.",
          "maxLength": 5000,
          "type": "string"
        },
        "verification": {
          "anyOf": [
            {
              "$ref": "#/$defs/tax_id_verification"
            }
          ],
          "description": "Tax ID verification information."
        }
      },
      "required": [
        "created",
        "id",
        "livemode",
        "object",
        "type",
        "value"
      ],
      "title": "tax_id",
      "type": "object",
      "x-expandableFields": [
        "customer",
        "verification"
      ],
      "x-resourceId": "tax_id"
    }
  }
}