object balance_settings_resource_payout_schedule
{
  "type": "object",
  "title": "BalanceSettingsResourcePayoutSchedule",
  "properties": {
    "interval": {
      "enum": [
        "daily",
        "manual",
        "monthly",
        "weekly"
      ],
      "type": "string",
      "nullable": true,
      "description": "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`."
    },
    "weekly_payout_days": {
      "type": "array",
      "items": {
        "enum": [
          "friday",
          "monday",
          "thursday",
          "tuesday",
          "wednesday"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The days of the week when available funds are paid out, specified as an array, for example, [`monday`, `tuesday`]. Only shown if `interval` is weekly."
    },
    "monthly_payout_days": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "The day of the month funds will be paid out. Only shown if `interval` is monthly. Payouts scheduled between the 29th and 31st of the month are sent on the last day of shorter months."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object balance_settings_resource_payouts
{
  "type": "object",
  "title": "BalanceSettingsResourcePayouts",
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "disabled",
        "enabled"
      ],
      "type": "string",
      "description": "Whether the funds in this account can be paid out."
    },
    "schedule": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/balance_settings_resource_payout_schedule"
        }
      ],
      "nullable": true,
      "description": "Details on when funds from charges are available, and when they are paid out to an external account. See our [Setting Bank and Debit Card Payouts](https://docs.stripe.com/connect/bank-transfers#payout-information) documentation for details."
    },
    "statement_descriptor": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard."
    },
    "minimum_balance_by_currency": {
      "type": "object",
      "nullable": true,
      "description": "The minimum balance amount to retain per currency after automatic payouts. Only funds that exceed these amounts are paid out. Learn more about the [minimum balances for automatic payouts](/payouts/minimum-balances-for-automatic-payouts).",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "schedule"
  ]
}
object balance_settings_resource_settlement_timing
{
  "type": "object",
  "title": "BalanceSettingsResourceSettlementTiming",
  "required": [
    "delay_days"
  ],
  "properties": {
    "delay_days": {
      "type": "integer",
      "description": "The number of days charge funds are held before becoming available."
    },
    "delay_days_override": {
      "type": "integer",
      "description": "The number of days charge funds are held before becoming available. If present, overrides the default, or minimum available, for the account."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object balance_transaction
{
  "type": "object",
  "title": "BalanceTransaction",
  "required": [
    "amount",
    "available_on",
    "balance_type",
    "created",
    "currency",
    "fee",
    "fee_details",
    "id",
    "net",
    "object",
    "reporting_category",
    "status",
    "type"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "fee": {
      "type": "integer",
      "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed."
    },
    "net": {
      "type": "integer",
      "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`"
    },
    "type": {
      "enum": [
        "adjustment",
        "advance",
        "advance_funding",
        "anticipation_repayment",
        "application_fee",
        "application_fee_refund",
        "charge",
        "climate_order_purchase",
        "climate_order_refund",
        "connect_collection_transfer",
        "contribution",
        "fee_credit_funding",
        "inbound_transfer",
        "inbound_transfer_reversal",
        "issuing_authorization_hold",
        "issuing_authorization_release",
        "issuing_dispute",
        "issuing_transaction",
        "obligation_outbound",
        "obligation_reversal_inbound",
        "payment",
        "payment_failure_refund",
        "payment_network_reserve_hold",
        "payment_network_reserve_release",
        "payment_refund",
        "payment_reversal",
        "payment_unreconciled",
        "payout",
        "payout_cancel",
        "payout_failure",
        "payout_minimum_balance_hold",
        "payout_minimum_balance_release",
        "refund",
        "refund_failure",
        "reserve_hold",
        "reserve_release",
        "reserve_transaction",
        "reserved_funds",
        "stripe_balance_payment_debit",
        "stripe_balance_payment_debit_reversal",
        "stripe_fee",
        "stripe_fx_fee",
        "tax_fee",
        "topup",
        "topup_reversal",
        "transfer",
        "transfer_cancel",
        "transfer_failure",
        "transfer_refund"
      ],
      "type": "string",
      "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `inbound_transfer`, `inbound_transfer_reversal`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `reserve_hold`, `reserve_release`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, `transfer_refund`, or `fee_credit_funding`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead."
    },
    "amount": {
      "type": "integer",
      "description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party."
    },
    "object": {
      "enum": [
        "balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "source": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/application_fee"
        },
        {
          "$ref": "#/components/schemas/charge"
        },
        {
          "$ref": "#/components/schemas/connect_collection_transfer"
        },
        {
          "$ref": "#/components/schemas/customer_cash_balance_transaction"
        },
        {
          "$ref": "#/components/schemas/dispute"
        },
        {
          "$ref": "#/components/schemas/fee_refund"
        },
        {
          "$ref": "#/components/schemas/issuing.authorization"
        },
        {
          "$ref": "#/components/schemas/issuing.dispute"
        },
        {
          "$ref": "#/components/schemas/issuing.transaction"
        },
        {
          "$ref": "#/components/schemas/payout"
        },
        {
          "$ref": "#/components/schemas/refund"
        },
        {
          "$ref": "#/components/schemas/reserve_transaction"
        },
        {
          "$ref": "#/components/schemas/tax_deducted_at_source"
        },
        {
          "$ref": "#/components/schemas/topup"
        },
        {
          "$ref": "#/components/schemas/transfer"
        },
        {
          "$ref": "#/components/schemas/transfer_reversal"
        }
      ],
      "nullable": true,
      "description": "This transaction relates to the Stripe object.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/application_fee"
          },
          {
            "$ref": "#/components/schemas/charge"
          },
          {
            "$ref": "#/components/schemas/connect_collection_transfer"
          },
          {
            "$ref": "#/components/schemas/customer_cash_balance_transaction"
          },
          {
            "$ref": "#/components/schemas/dispute"
          },
          {
            "$ref": "#/components/schemas/fee_refund"
          },
          {
            "$ref": "#/components/schemas/issuing.authorization"
          },
          {
            "$ref": "#/components/schemas/issuing.dispute"
          },
          {
            "$ref": "#/components/schemas/issuing.transaction"
          },
          {
            "$ref": "#/components/schemas/payout"
          },
          {
            "$ref": "#/components/schemas/refund"
          },
          {
            "$ref": "#/components/schemas/reserve_transaction"
          },
          {
            "$ref": "#/components/schemas/tax_deducted_at_source"
          },
          {
            "$ref": "#/components/schemas/topup"
          },
          {
            "$ref": "#/components/schemas/transfer"
          },
          {
            "$ref": "#/components/schemas/transfer_reversal"
          }
        ]
      },
      "x-stripeBypassValidation": true
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "currency": {
      "type": "string",
      "format": "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)."
    },
    "description": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "An arbitrary string attached to the object. Often useful for displaying to users."
    },
    "fee_details": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/fee"
      },
      "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction."
    },
    "available_on": {
      "type": "integer",
      "format": "unix-time",
      "description": "The date that the transaction's net funds become available in the Stripe balance."
    },
    "balance_type": {
      "enum": [
        "issuing",
        "payments",
        "refund_and_dispute_prefunding",
        "risk_reserved"
      ],
      "type": "string",
      "description": "The balance that this transaction impacts.",
      "x-stripeBypassValidation": true
    },
    "exchange_rate": {
      "type": "number",
      "nullable": true,
      "description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`."
    },
    "reporting_category": {
      "type": "string",
      "maxLength": 5000,
      "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective."
    }
  },
  "description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)",
  "x-resourceId": "balance_transaction",
  "x-expandableFields": [
    "fee_details",
    "source"
  ]
}
object bank_account
{
  "type": "object",
  "title": "BankAccount",
  "required": [
    "country",
    "currency",
    "id",
    "last4",
    "object",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "last4": {
      "type": "string",
      "maxLength": 5000,
      "description": "The last four digits of the bank account number."
    },
    "object": {
      "enum": [
        "bank_account"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "type": "string",
      "maxLength": 5000,
      "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, `tokenized_account_number_deactivated` 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 the status is `tokenized_account_number_deactivated`, the account utilizes a tokenized account number which has been deactivated due to expiration or revocation. This account will need to be reverified to continue using it for money movement. 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`, `verification_failed`, and `tokenized_account_number_deactivated`. If a payout fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In the US and 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."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "nullable": true,
      "description": "The account this bank account belongs to. Only applicable on Accounts (not customers or recipients) This property is only available when returned as an [External Account](/api/external_account_bank_accounts/object) where [controller.is_controller](/api/accounts/object#account_object-controller-is_controller) is `true`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "country": {
      "type": "string",
      "maxLength": 5000,
      "description": "Two-letter ISO code representing the country the bank account is located in."
    },
    "currency": {
      "type": "string",
      "format": "currency",
      "description": "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "nullable": true,
      "description": "The ID of the customer that the bank account is associated with.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "bank_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Name of the bank associated with the routing number (e.g., `WELLS FARGO`)."
    },
    "fingerprint": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."
    },
    "account_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`."
    },
    "requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/external_account_requirements"
        }
      ],
      "nullable": true,
      "description": "Information about the requirements for the bank account, including what information needs to be collected."
    },
    "routing_number": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The routing transit number for the bank account."
    },
    "account_holder_name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The name of the person or business that owns the bank account."
    },
    "account_holder_type": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The type of entity that holds the account. This can be either `individual` or `company`."
    },
    "future_requirements": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/external_account_requirements"
        }
      ],
      "nullable": true,
      "description": "Information about the [upcoming new requirements for the bank account](https://docs.stripe.com/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when."
    },
    "default_for_currency": {
      "type": "boolean",
      "nullable": true,
      "description": "Whether this bank account is the default external account for its currency."
    },
    "available_payout_methods": {
      "type": "array",
      "items": {
        "enum": [
          "instant",
          "standard"
        ],
        "type": "string"
      },
      "nullable": true,
      "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."
    }
  },
  "description": "These bank accounts are payment methods on `Customer` objects.\n\nOn the other hand [External Accounts](/api#external_accounts) are transfer\ndestinations on `Account` objects for connected 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](/payments/bank-debits-transfers)",
  "x-resourceId": "bank_account",
  "x-expandableFields": [
    "account",
    "customer",
    "future_requirements",
    "requirements"
  ]
}
object bank_connections_resource_account_number_details
{
  "type": "object",
  "title": "BankConnectionsResourceAccountNumberDetails",
  "required": [
    "identifier_type",
    "status",
    "supported_networks"
  ],
  "properties": {
    "status": {
      "enum": [
        "deactivated",
        "transactable"
      ],
      "type": "string",
      "description": "Whether the account number is currently active and usable for transactions."
    },
    "identifier_type": {
      "enum": [
        "account_number",
        "tokenized_account_number"
      ],
      "type": "string",
      "description": "The type of account number associated with the account."
    },
    "supported_networks": {
      "type": "array",
      "items": {
        "enum": [
          "ach"
        ],
        "type": "string",
        "x-stripeBypassValidation": true
      },
      "description": "The payment networks that the account number can be used for."
    },
    "expected_expiry_date": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "When the account number is expected to expire, if applicable."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_accountholder
{
  "type": "object",
  "title": "BankConnectionsResourceAccountholder",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "account",
        "customer"
      ],
      "type": "string",
      "description": "Type of account holder that this account belongs to."
    },
    "account": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/account"
        }
      ],
      "description": "The ID of the Stripe account that this account belongs to. Only available when `account_holder.type` is `account`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/account"
          }
        ]
      }
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        }
      ],
      "description": "The ID for an Account representing a customer that this account belongs to. Only available when `account_holder.type` is `customer`.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          }
        ]
      }
    },
    "customer_account": {
      "type": "string",
      "maxLength": 5000
    }
  },
  "description": "",
  "x-expandableFields": [
    "account",
    "customer"
  ]
}
object bank_connections_resource_balance
{
  "type": "object",
  "title": "BankConnectionsResourceBalance",
  "required": [
    "as_of",
    "current",
    "type"
  ],
  "properties": {
    "cash": {
      "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance"
    },
    "type": {
      "enum": [
        "cash",
        "credit"
      ],
      "type": "string",
      "description": "The `type` of the balance. An additional hash is included on the balance with a name matching this value."
    },
    "as_of": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch."
    },
    "credit": {
      "$ref": "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance"
    },
    "current": {
      "type": "object",
      "description": "The balances owed to (or by) the account holder, before subtracting any outbound pending transactions or adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "cash",
    "credit"
  ]
}
object bank_connections_resource_balance_api_resource_cash_balance
{
  "type": "object",
  "title": "BankConnectionsResourceBalanceAPIResourceCashBalance",
  "properties": {
    "available": {
      "type": "object",
      "nullable": true,
      "description": "The funds available to the account holder. Typically this is the current balance after subtracting any outbound pending transactions and adding any inbound pending transactions.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_balance_api_resource_credit_balance
{
  "type": "object",
  "title": "BankConnectionsResourceBalanceAPIResourceCreditBalance",
  "properties": {
    "used": {
      "type": "object",
      "nullable": true,
      "description": "The credit that has been used by the account holder.\n\nEach key is a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.\n\nEach value is a integer amount. A positive amount indicates money owed to the account holder. A negative amount indicates money owed by the account holder.",
      "additionalProperties": {
        "type": "integer"
      }
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_balance_refresh
{
  "type": "object",
  "title": "BankConnectionsResourceBalanceRefresh",
  "required": [
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_link_account_session_filters
{
  "type": "object",
  "title": "BankConnectionsResourceLinkAccountSessionFilters",
  "properties": {
    "countries": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "nullable": true,
      "description": "List of countries from which to filter accounts."
    },
    "account_subcategories": {
      "type": "array",
      "items": {
        "enum": [
          "checking",
          "credit_card",
          "line_of_credit",
          "mortgage",
          "savings"
        ],
        "type": "string"
      },
      "nullable": true,
      "description": "Restricts the Session to subcategories of accounts that can be linked. Valid subcategories are: `checking`, `savings`, `mortgage`, `line_of_credit`, `credit_card`."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_ownership_refresh
{
  "type": "object",
  "title": "BankConnectionsResourceOwnershipRefresh",
  "required": [
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next ownership refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_transaction_refresh
{
  "type": "object",
  "title": "BankConnectionsResourceTransactionRefresh",
  "required": [
    "id",
    "last_attempted_at",
    "status"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "status": {
      "enum": [
        "failed",
        "pending",
        "succeeded"
      ],
      "type": "string",
      "description": "The status of the last refresh attempt."
    },
    "last_attempted_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."
    },
    "next_refresh_available_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which the next transaction refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object bank_connections_resource_transaction_resource_status_transitions
{
  "type": "object",
  "title": "BankConnectionsResourceTransactionResourceStatusTransitions",
  "properties": {
    "void_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which this transaction was voided. Measured in seconds since the Unix epoch."
    },
    "posted_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "Time at which this transaction posted. Measured in seconds since the Unix epoch."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing.alert
{
  "type": "object",
  "title": "ThresholdsResourceAlert",
  "required": [
    "alert_type",
    "id",
    "livemode",
    "object",
    "title"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "title": {
      "type": "string",
      "maxLength": 5000,
      "description": "Title of the alert."
    },
    "object": {
      "enum": [
        "billing.alert"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "archived",
        "inactive"
      ],
      "type": "string",
      "nullable": true,
      "description": "Status of the alert. This can be active, inactive or archived."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "alert_type": {
      "enum": [
        "usage_threshold"
      ],
      "type": "string",
      "description": "Defines the type of the alert.",
      "x-stripeBypassValidation": true
    },
    "usage_threshold": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/thresholds_resource_usage_threshold_config"
        }
      ],
      "nullable": true,
      "description": "Encapsulates configuration of the alert to monitor usage on a specific [Billing Meter](https://docs.stripe.com/api/billing/meter)."
    }
  },
  "description": "A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.",
  "x-resourceId": "billing.alert",
  "x-expandableFields": [
    "usage_threshold"
  ]
}
object billing.credit_balance_summary
{
  "type": "object",
  "title": "CreditBalanceSummary",
  "required": [
    "balances",
    "customer",
    "livemode",
    "object"
  ],
  "properties": {
    "object": {
      "enum": [
        "billing.credit_balance_summary"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "balances": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/credit_balance"
      },
      "description": "The billing credit balances. One entry per credit grant currency. If a customer only has credit grants in a single currency, then this will have a single balance entry."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "The customer the balance is for.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The account the balance is for."
    }
  },
  "description": "Indicates the billing credit balance for billing credits granted to a customer.",
  "x-resourceId": "billing.credit_balance_summary",
  "x-expandableFields": [
    "balances",
    "customer"
  ]
}
object billing.credit_balance_transaction
{
  "type": "object",
  "title": "CreditBalanceTransaction",
  "required": [
    "created",
    "credit_grant",
    "effective_at",
    "id",
    "livemode",
    "object"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "type": {
      "enum": [
        "credit",
        "debit"
      ],
      "type": "string",
      "nullable": true,
      "description": "The type of credit balance transaction (credit or debit)."
    },
    "debit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_debit"
        }
      ],
      "nullable": true,
      "description": "Debit details for this credit balance transaction. Only present if type is `debit`."
    },
    "credit": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credit"
        }
      ],
      "nullable": true,
      "description": "Credit details for this credit balance transaction. Only present if type is `credit`."
    },
    "object": {
      "enum": [
        "billing.credit_balance_transaction"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this credit balance transaction belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "credit_grant": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/billing.credit_grant"
        }
      ],
      "description": "The credit grant associated with this credit balance transaction.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/billing.credit_grant"
          }
        ]
      }
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "description": "The effective time of this credit balance transaction."
    }
  },
  "description": "A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.",
  "x-resourceId": "billing.credit_balance_transaction",
  "x-expandableFields": [
    "credit",
    "credit_grant",
    "debit",
    "test_clock"
  ]
}
object billing.credit_grant
{
  "type": "object",
  "title": "CreditGrant",
  "required": [
    "amount",
    "applicability_config",
    "category",
    "created",
    "customer",
    "id",
    "livemode",
    "metadata",
    "object",
    "updated"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "A descriptive name shown in dashboard."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "object": {
      "enum": [
        "billing.credit_grant"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "category": {
      "enum": [
        "paid",
        "promotional"
      ],
      "type": "string",
      "description": "The category of this credit grant. This is for tracking purposes and isn't displayed to the customer."
    },
    "customer": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/customer"
        },
        {
          "$ref": "#/components/schemas/deleted_customer"
        }
      ],
      "description": "ID of the customer receiving the billing credits.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/customer"
          },
          {
            "$ref": "#/components/schemas/deleted_customer"
          }
        ]
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "metadata": {
      "type": "object",
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "priority": {
      "type": "integer",
      "nullable": true,
      "description": "The priority for applying this credit grant. The highest priority is 0 and the lowest is 100."
    },
    "voided_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when this credit grant was voided. If not present, the credit grant hasn't been voided."
    },
    "expires_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when the billing credits expire. If not present, the billing credits don't expire."
    },
    "test_clock": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/test_helpers.test_clock"
        }
      ],
      "nullable": true,
      "description": "ID of the test clock this credit grant belongs to.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/test_helpers.test_clock"
          }
        ]
      }
    },
    "effective_at": {
      "type": "integer",
      "format": "unix-time",
      "nullable": true,
      "description": "The time when the billing credits become effective-when they're eligible for use."
    },
    "customer_account": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "ID of the account representing the customer receiving the billing credits"
    },
    "applicability_config": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_applicability_config"
    }
  },
  "description": "A credit grant is an API resource that documents the allocation of some billing credits to a customer.\n\nRelated guide: [Billing credits](https://docs.stripe.com/billing/subscriptions/usage-based/billing-credits)",
  "x-resourceId": "billing.credit_grant",
  "x-expandableFields": [
    "amount",
    "applicability_config",
    "customer",
    "test_clock"
  ]
}
object billing.meter
{
  "type": "object",
  "title": "BillingMeter",
  "required": [
    "created",
    "customer_mapping",
    "default_aggregation",
    "display_name",
    "event_name",
    "id",
    "livemode",
    "object",
    "status",
    "status_transitions",
    "updated",
    "value_settings"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "object": {
      "enum": [
        "billing.meter"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "active",
        "inactive"
      ],
      "type": "string",
      "description": "The meter's status."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "updated": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was last updated. Measured in seconds since the Unix epoch."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "event_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events."
    },
    "display_name": {
      "type": "string",
      "maxLength": 5000,
      "description": "The meter's name."
    },
    "value_settings": {
      "$ref": "#/components/schemas/billing_meter_resource_billing_meter_value"
    },
    "customer_mapping": {
      "$ref": "#/components/schemas/billing_meter_resource_customer_mapping_settings"
    },
    "event_time_window": {
      "enum": [
        "day",
        "hour"
      ],
      "type": "string",
      "nullable": true,
      "description": "The time window which meter events have been pre-aggregated for, if any."
    },
    "status_transitions": {
      "$ref": "#/components/schemas/billing_meter_resource_billing_meter_status_transitions"
    },
    "default_aggregation": {
      "$ref": "#/components/schemas/billing_meter_resource_aggregation_settings"
    }
  },
  "description": "Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.\n\nRelated guide: [Usage based billing](https://docs.stripe.com/billing/subscriptions/usage-based)",
  "x-resourceId": "billing.meter",
  "x-expandableFields": [
    "customer_mapping",
    "default_aggregation",
    "status_transitions",
    "value_settings"
  ]
}
object billing.meter_event
{
  "type": "object",
  "title": "BillingMeterEvent",
  "required": [
    "created",
    "event_name",
    "identifier",
    "livemode",
    "object",
    "payload",
    "timestamp"
  ],
  "properties": {
    "object": {
      "enum": [
        "billing.meter_event"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "created": {
      "type": "integer",
      "format": "unix-time",
      "description": "Time at which the object was created. Measured in seconds since the Unix epoch."
    },
    "payload": {
      "type": "object",
      "description": "The payload of the event. This contains the fields corresponding to a meter's `customer_mapping.event_payload_key` (default is `stripe_customer_id`) and `value_settings.event_payload_key` (default is `value`). Read more about the [payload](https://docs.stripe.com/billing/subscriptions/usage-based/meters/configure#meter-configuration-attributes).",
      "additionalProperties": {
        "type": "string",
        "maxLength": 100
      }
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "timestamp": {
      "type": "integer",
      "format": "unix-time",
      "description": "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch."
    },
    "event_name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name of the meter event. Corresponds with the `event_name` field on a meter."
    },
    "identifier": {
      "type": "string",
      "maxLength": 5000,
      "description": "A unique identifier for the event."
    }
  },
  "description": "Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.",
  "x-resourceId": "billing.meter_event",
  "x-expandableFields": []
}
object billing.meter_event_adjustment
{
  "type": "object",
  "title": "BillingMeterEventAdjustment",
  "required": [
    "event_name",
    "livemode",
    "object",
    "status",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "cancel"
      ],
      "type": "string",
      "description": "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet."
    },
    "cancel": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel"
        }
      ],
      "nullable": true,
      "description": "Specifies which event to cancel."
    },
    "object": {
      "enum": [
        "billing.meter_event_adjustment"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "status": {
      "enum": [
        "complete",
        "pending"
      ],
      "type": "string",
      "description": "The meter event adjustment's status."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "event_name": {
      "type": "string",
      "maxLength": 100,
      "description": "The name of the meter event. Corresponds with the `event_name` field on a meter."
    }
  },
  "description": "A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.",
  "x-resourceId": "billing.meter_event_adjustment",
  "x-expandableFields": [
    "cancel"
  ]
}
object billing.meter_event_summary
{
  "type": "object",
  "title": "BillingMeterEventSummary",
  "required": [
    "aggregated_value",
    "end_time",
    "id",
    "livemode",
    "meter",
    "object",
    "start_time"
  ],
  "properties": {
    "id": {
      "type": "string",
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    },
    "meter": {
      "type": "string",
      "maxLength": 5000,
      "description": "The meter associated with this event summary."
    },
    "object": {
      "enum": [
        "billing.meter_event_summary"
      ],
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value."
    },
    "end_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "End timestamp for this event summary (exclusive). Must be aligned with minute boundaries."
    },
    "livemode": {
      "type": "boolean",
      "description": "If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`."
    },
    "start_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "Start timestamp for this event summary (inclusive). Must be aligned with minute boundaries."
    },
    "aggregated_value": {
      "type": "number",
      "description": "Aggregated value of all the events within `start_time` (inclusive) and `end_time` (inclusive). The aggregation strategy is defined on meter via `default_aggregation`."
    }
  },
  "description": "A billing meter event summary represents an aggregated view of a customer's billing meter events within a specified timeframe. It indicates how much\nusage was accrued by a customer for that period.\n\nNote: Meters events are aggregated asynchronously so the meter event summaries provide an eventually consistent view of the reported usage.",
  "x-resourceId": "billing.meter_event_summary",
  "x-expandableFields": []
}
object billing_bill_resource_invoice_item_parents_invoice_item_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoiceItemParentsInvoiceItemParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "subscription_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this invoice item",
      "x-stripeBypassValidation": true
    },
    "subscription_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription that generated this invoice item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "subscription_details"
  ]
}
object billing_bill_resource_invoice_item_parents_invoice_item_subscription_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoiceItemParentsInvoiceItemSubscriptionParent",
  "required": [
    "subscription"
  ],
  "properties": {
    "subscription": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription that generated this invoice item"
    },
    "subscription_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription item that generated this invoice item"
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing_bill_resource_invoicing_lines_common_credited_items
{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesCommonCreditedItems",
  "required": [
    "invoice",
    "invoice_line_items"
  ],
  "properties": {
    "invoice": {
      "type": "string",
      "maxLength": 5000,
      "description": "Invoice containing the credited invoice line items"
    },
    "invoice_line_items": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 5000
      },
      "description": "Credited invoice line items"
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing_bill_resource_invoicing_lines_common_proration_details
{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesCommonProrationDetails",
  "properties": {
    "credited_items": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_credited_items"
        }
      ],
      "nullable": true,
      "description": "For a credit proration `line_item`, the original debit line_items to which the credit proration applies."
    }
  },
  "description": "",
  "x-expandableFields": [
    "credited_items"
  ]
}
object billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemInvoiceItemParent",
  "required": [
    "invoice_item",
    "proration"
  ],
  "properties": {
    "proration": {
      "type": "boolean",
      "description": "Whether this is a proration"
    },
    "invoice_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice item that generated this line item"
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that the invoice item belongs to"
    },
    "proration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details"
        }
      ],
      "nullable": true,
      "description": "Additional details for proration line items"
    }
  },
  "description": "",
  "x-expandableFields": [
    "proration_details"
  ]
}
object billing_bill_resource_invoicing_lines_parents_invoice_line_item_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "invoice_item_details",
        "subscription_item_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this line item",
      "x-stripeBypassValidation": true
    },
    "invoice_item_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_invoice_item_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the invoice item that generated this line item"
    },
    "subscription_item_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription item that generated this line item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice_item_details",
    "subscription_item_details"
  ]
}
object billing_bill_resource_invoicing_lines_parents_invoice_line_item_subscription_item_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingLinesParentsInvoiceLineItemSubscriptionItemParent",
  "required": [
    "proration",
    "subscription_item"
  ],
  "properties": {
    "proration": {
      "type": "boolean",
      "description": "Whether this is a proration"
    },
    "invoice_item": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The invoice item that generated this line item"
    },
    "subscription": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "The subscription that the subscription item belongs to"
    },
    "proration_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_lines_common_proration_details"
        }
      ],
      "nullable": true,
      "description": "Additional details for proration line items"
    },
    "subscription_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The subscription item that generated this line item"
    }
  },
  "description": "",
  "x-expandableFields": [
    "proration_details"
  ]
}
object billing_bill_resource_invoicing_parents_invoice_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceParent",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "quote_details",
        "subscription_details"
      ],
      "type": "string",
      "description": "The type of parent that generated this invoice",
      "x-stripeBypassValidation": true
    },
    "quote_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_quote_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the quote that generated this invoice"
    },
    "subscription_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_parents_invoice_subscription_parent"
        }
      ],
      "nullable": true,
      "description": "Details about the subscription that generated this invoice"
    }
  },
  "description": "",
  "x-expandableFields": [
    "quote_details",
    "subscription_details"
  ]
}
object billing_bill_resource_invoicing_parents_invoice_quote_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceQuoteParent",
  "required": [
    "quote"
  ],
  "properties": {
    "quote": {
      "type": "string",
      "maxLength": 5000,
      "description": "The quote that generated this invoice"
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing_bill_resource_invoicing_parents_invoice_subscription_parent
{
  "type": "object",
  "title": "BillingBillResourceInvoicingParentsInvoiceSubscriptionParent",
  "required": [
    "subscription"
  ],
  "properties": {
    "metadata": {
      "type": "object",
      "nullable": true,
      "description": "Set of [key-value pairs](https://docs.stripe.com/api/metadata) defined as subscription metadata when an invoice is created. Becomes an immutable snapshot of the subscription metadata at the time of invoice finalization.\n *Note: This attribute is populated only for invoices created on or after June 29, 2023.*",
      "additionalProperties": {
        "type": "string",
        "maxLength": 500
      }
    },
    "subscription": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/subscription"
        }
      ],
      "description": "The subscription that generated this invoice",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/subscription"
          }
        ]
      }
    },
    "subscription_proration_date": {
      "type": "integer",
      "format": "unix-time",
      "description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations."
    }
  },
  "description": "",
  "x-expandableFields": [
    "subscription"
  ]
}
object billing_bill_resource_invoicing_pricing_pricing
{
  "type": "object",
  "title": "BillingBillResourceInvoicingPricingPricing",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "price_details"
      ],
      "type": "string",
      "description": "The type of the pricing details.",
      "x-stripeBypassValidation": true
    },
    "price_details": {
      "$ref": "#/components/schemas/billing_bill_resource_invoicing_pricing_pricing_price_details"
    },
    "unit_amount_decimal": {
      "type": "string",
      "format": "decimal",
      "nullable": true,
      "description": "The unit amount (in the `currency` specified) of the item which contains a decimal value with at most 12 decimal places."
    }
  },
  "description": "",
  "x-expandableFields": [
    "price_details"
  ]
}
object billing_bill_resource_invoicing_pricing_pricing_price_details
{
  "type": "object",
  "title": "BillingBillResourceInvoicingPricingPricingPriceDetails",
  "required": [
    "price",
    "product"
  ],
  "properties": {
    "price": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/price"
        }
      ],
      "description": "The ID of the price this item is associated with.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/price"
          }
        ]
      }
    },
    "product": {
      "type": "string",
      "maxLength": 5000,
      "description": "The ID of the product this item is associated with."
    }
  },
  "description": "",
  "x-expandableFields": [
    "price"
  ]
}
object billing_bill_resource_invoicing_taxes_tax
{
  "type": "object",
  "title": "BillingBillResourceInvoicingTaxesTax",
  "required": [
    "amount",
    "tax_behavior",
    "taxability_reason",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "tax_rate_details"
      ],
      "type": "string",
      "description": "The type of tax information."
    },
    "amount": {
      "type": "integer",
      "description": "The amount of the tax, in cents (or local equivalent)."
    },
    "tax_behavior": {
      "enum": [
        "exclusive",
        "inclusive"
      ],
      "type": "string",
      "description": "Whether this tax is inclusive or exclusive."
    },
    "taxable_amount": {
      "type": "integer",
      "nullable": true,
      "description": "The amount on which tax is calculated, in cents (or local equivalent)."
    },
    "tax_rate_details": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_bill_resource_invoicing_taxes_tax_rate_details"
        }
      ],
      "nullable": true,
      "description": "Additional details about the tax rate. Only present when `type` is `tax_rate_details`."
    },
    "taxability_reason": {
      "enum": [
        "customer_exempt",
        "not_available",
        "not_collecting",
        "not_subject_to_tax",
        "not_supported",
        "portion_product_exempt",
        "portion_reduced_rated",
        "portion_standard_rated",
        "product_exempt",
        "product_exempt_holiday",
        "proportionally_rated",
        "reduced_rated",
        "reverse_charge",
        "standard_rated",
        "taxable_basis_reduced",
        "zero_rated"
      ],
      "type": "string",
      "description": "The reasoning behind this tax, for example, if the product is tax exempt. The possible values for this field may be extended as new tax rules are supported.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax_rate_details"
  ]
}
object billing_bill_resource_invoicing_taxes_tax_rate_details
{
  "type": "object",
  "title": "BillingBillResourceInvoicingTaxesTaxRateDetails",
  "required": [
    "tax_rate"
  ],
  "properties": {
    "tax_rate": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/tax_rate"
        }
      ],
      "description": "ID of the tax rate",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/tax_rate"
          }
        ]
      }
    }
  },
  "description": "",
  "x-expandableFields": [
    "tax_rate"
  ]
}
object billing_clocks_resource_status_details_advancing_status_details
{
  "type": "object",
  "title": "BillingClocksResourceStatusDetailsAdvancingStatusDetails",
  "required": [
    "target_frozen_time"
  ],
  "properties": {
    "target_frozen_time": {
      "type": "integer",
      "format": "unix-time",
      "description": "The `frozen_time` that the Test Clock is advancing towards."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing_clocks_resource_status_details_status_details
{
  "type": "object",
  "title": "BillingClocksResourceStatusDetailsStatusDetails",
  "properties": {
    "advancing": {
      "$ref": "#/components/schemas/billing_clocks_resource_status_details_advancing_status_details"
    }
  },
  "description": "",
  "x-expandableFields": [
    "advancing"
  ]
}
object billing_credit_grants_resource_amount
{
  "type": "object",
  "title": "BillingCreditGrantsResourceAmount",
  "required": [
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "monetary"
      ],
      "type": "string",
      "description": "The type of this amount. We currently only support `monetary` billing credits.",
      "x-stripeBypassValidation": true
    },
    "monetary": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_monetary_amount"
        }
      ],
      "nullable": true,
      "description": "The monetary amount."
    }
  },
  "description": "",
  "x-expandableFields": [
    "monetary"
  ]
}
object billing_credit_grants_resource_applicability_config
{
  "type": "object",
  "title": "BillingCreditGrantsResourceApplicabilityConfig",
  "required": [
    "scope"
  ],
  "properties": {
    "scope": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_scope"
    }
  },
  "description": "",
  "x-expandableFields": [
    "scope"
  ]
}
object billing_credit_grants_resource_applicable_price
{
  "type": "object",
  "title": "BillingCreditGrantsResourceApplicablePrice",
  "properties": {
    "id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Unique identifier for the object."
    }
  },
  "description": "",
  "x-expandableFields": []
}
object billing_credit_grants_resource_balance_credit
{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCredit",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credits_application_invoice_voided",
        "credits_granted"
      ],
      "type": "string",
      "description": "The type of credit transaction."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "credits_application_invoice_voided": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_application_invoice_voided"
        }
      ],
      "nullable": true,
      "description": "Details of the invoice to which the reinstated credits were originally applied. Only present if `type` is `credits_application_invoice_voided`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount",
    "credits_application_invoice_voided"
  ]
}
object billing_credit_grants_resource_balance_credits_application_invoice_voided
{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCreditsApplicationInvoiceVoided",
  "required": [
    "invoice",
    "invoice_line_item"
  ],
  "properties": {
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "The invoice to which the reinstated billing credits were originally applied.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "invoice_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice line item to which the reinstated billing credits were originally applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice"
  ]
}
object billing_credit_grants_resource_balance_credits_applied
{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceCreditsApplied",
  "required": [
    "invoice",
    "invoice_line_item"
  ],
  "properties": {
    "invoice": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "$ref": "#/components/schemas/invoice"
        }
      ],
      "description": "The invoice to which the billing credits were applied.",
      "x-expansionResources": {
        "oneOf": [
          {
            "$ref": "#/components/schemas/invoice"
          }
        ]
      }
    },
    "invoice_line_item": {
      "type": "string",
      "maxLength": 5000,
      "description": "The invoice line item to which the billing credits were applied."
    }
  },
  "description": "",
  "x-expandableFields": [
    "invoice"
  ]
}
object billing_credit_grants_resource_balance_debit
{
  "type": "object",
  "title": "BillingCreditGrantsResourceBalanceDebit",
  "required": [
    "amount",
    "type"
  ],
  "properties": {
    "type": {
      "enum": [
        "credits_applied",
        "credits_expired",
        "credits_voided"
      ],
      "type": "string",
      "description": "The type of debit transaction."
    },
    "amount": {
      "$ref": "#/components/schemas/billing_credit_grants_resource_amount"
    },
    "credits_applied": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/billing_credit_grants_resource_balance_credits_applied"
        }
      ],
      "nullable": true,
      "description": "Details of how the billing credits were applied to an invoice. Only present if `type` is `credits_applied`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "amount",
    "credits_applied"
  ]
}
object billing_credit_grants_resource_monetary_amount
{
  "type": "object",
  "title": "BillingCreditGrantsResourceMonetaryAmount",
  "required": [
    "currency",
    "value"
  ],
  "properties": {
    "value": {
      "type": "integer",
      "description": "A positive integer representing the amount."
    },
    "currency": {
      "type": "string",
      "maxLength": 5000,
      "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": "",
  "x-expandableFields": []
}
object billing_credit_grants_resource_scope
{
  "type": "object",
  "title": "BillingCreditGrantsResourceScope",
  "properties": {
    "prices": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/billing_credit_grants_resource_applicable_price"
      },
      "description": "The prices that credit grants can apply to. We currently only support `metered` prices. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `price_type`."
    },
    "price_type": {
      "enum": [
        "metered"
      ],
      "type": "string",
      "description": "The price type that credit grants can apply to. We currently only support the `metered` price type. This refers to prices that have a [Billing Meter](https://docs.stripe.com/api/billing/meter) attached to them. Cannot be used in combination with `prices`."
    }
  },
  "description": "",
  "x-expandableFields": [
    "prices"
  ]
}
object billing_details
{
  "type": "object",
  "title": "billing_details",
  "properties": {
    "name": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Full name."
    },
    "email": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Billing phone number (including extension)."
    },
    "tax_id": {
      "type": "string",
      "nullable": true,
      "maxLength": 5000,
      "description": "Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers."
    },
    "address": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/address"
        }
      ],
      "nullable": true,
      "description": "Billing address."
    }
  },
  "description": "",
  "x-expandableFields": [
    "address"
  ]
}
object billing_meter_resource_aggregation_settings
{
  "type": "object",
  "title": "BillingMeterResourceAggregationSettings",
  "required": [
    "formula"
  ],
  "properties": {
    "formula": {
      "enum": [
        "count",
        "last",
        "sum"
      ],
      "type": "string",
      "description": "Specifies how events are aggregated.",
      "x-stripeBypassValidation": true
    }
  },
  "description": "",
  "x-expandableFields": []
}
Load more schemas