UNPKG

openapi-to-graphql-lxwang2

Version:

Generates a GraphQL schema for a given OpenAPI Specification (OAS)

1,318 lines (1,317 loc) 2.63 MB
{ "components": { "schemas": { "account": { "properties": { "business_profile": { "anyOf": [ { "$ref": "#/components/schemas/account_business_profile" } ], "description": "Optional information related to the business.", "nullable": true }, "business_type": { "description": "The business type. Can be `individual` or `company`.", "maxLength": 5000, "nullable": true, "type": "string" }, "capabilities": { "$ref": "#/components/schemas/account_capabilities" }, "charges_enabled": { "description": "Whether the account can create live charges.", "type": "boolean" }, "company": { "$ref": "#/components/schemas/legal_entity_company" }, "country": { "description": "The account's country.", "maxLength": 5000, "type": "string" }, "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "default_currency": { "description": "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).", "maxLength": 5000, "type": "string" }, "details_submitted": { "description": "Whether account details have been submitted. Standard accounts cannot receive payouts before this is true.", "type": "boolean" }, "email": { "description": "The primary user's email address.", "maxLength": 5000, "nullable": true, "type": "string" }, "external_accounts": { "description": "External accounts (bank accounts and debit cards) currently attached to this account", "properties": { "data": { "description": "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards.", "items": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" } ], "title": "Polymorphic" }, "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": "ExternalAccountList", "type": "object", "x-expandableFields": ["data"] }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "individual": { "$ref": "#/components/schemas/person" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": ["account"], "type": "string" }, "payouts_enabled": { "description": "Whether Stripe can send payouts to this account.", "type": "boolean" }, "requirements": { "$ref": "#/components/schemas/account_requirements" }, "settings": { "anyOf": [ { "$ref": "#/components/schemas/account_settings" } ], "description": "Options for customizing how the account functions within Stripe.", "nullable": true }, "tos_acceptance": { "$ref": "#/components/schemas/account_tos_acceptance" }, "type": { "description": "The Stripe account type. Can be `standard`, `express`, or `custom`.", "enum": ["custom", "express", "standard"], "type": "string" } }, "required": ["id", "object"], "title": "Account", "type": "object", "x-expandableFields": [ "business_profile", "capabilities", "company", "external_accounts", "individual", "requirements", "settings", "tos_acceptance" ], "x-resourceId": "account" }, "account_branding_settings": { "properties": { "icon": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "logo": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/file" } ], "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/file" } ] } }, "primary_color": { "description": "A CSS hex color value representing the primary branding color for this account", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountBrandingSettings", "type": "object", "x-expandableFields": ["icon", "logo"] }, "account_business_profile": { "properties": { "mcc": { "description": "The merchant category code for the account. MCCs are used to classify businesses based on the goods or services they provide.", "maxLength": 5000, "nullable": true, "type": "string" }, "name": { "description": "The customer-facing business name.", "maxLength": 5000, "nullable": true, "type": "string" }, "product_description": { "description": "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes.", "maxLength": 40000, "nullable": true, "type": "string" }, "support_address": { "anyOf": [ { "$ref": "#/components/schemas/address" } ], "description": "A publicly available mailing address for sending support issues to.", "nullable": true }, "support_email": { "description": "A publicly available email address for sending support issues to.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_phone": { "description": "A publicly available phone number to call with support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "support_url": { "description": "A publicly available website for handling support issues.", "maxLength": 5000, "nullable": true, "type": "string" }, "url": { "description": "The business's publicly available website.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountBusinessProfile", "type": "object", "x-expandableFields": ["support_address"] }, "account_capabilities": { "properties": { "card_issuing": { "description": "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards", "enum": ["active", "inactive", "pending"], "type": "string" }, "card_payments": { "description": "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges.", "enum": ["active", "inactive", "pending"], "type": "string" }, "legacy_payments": { "description": "The status of the legacy payments capability of the account.", "enum": ["active", "inactive", "pending"], "type": "string" }, "transfers": { "description": "The status of the transfers capability of the account, or whether your platform can transfer funds to the account.", "enum": ["active", "inactive", "pending"], "type": "string" } }, "title": "AccountCapabilities", "type": "object", "x-expandableFields": [] }, "account_capability_requirements": { "properties": { "current_deadline": { "description": "The date the fields in `currently_due` must be collected by to keep the capability enabled for the account.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "The fields that need to be collected to keep the capability enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "disabled_reason": { "description": "If the capability is disabled, this string describes why. Possible values are `requirement.fields_needed`, `pending.onboarding`, `pending.review`, `rejected_fraud`, or `rejected.other`.", "maxLength": 5000, "nullable": true, "type": "string" }, "eventually_due": { "description": "The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "past_due": { "description": "The fields that weren't collected by the `current_deadline`. These fields need to be collected to enable the capability for the account.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" }, "pending_verification": { "description": "Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`.", "items": { "maxLength": 5000, "type": "string" }, "type": "array" } }, "required": [ "currently_due", "eventually_due", "past_due", "pending_verification" ], "title": "AccountCapabilityRequirements", "type": "object", "x-expandableFields": [] }, "account_card_payments_settings": { "properties": { "decline_on": { "$ref": "#/components/schemas/account_decline_charge_on" }, "statement_descriptor_prefix": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge. `statement_descriptor_prefix` is useful for maximizing descriptor space for the dynamic portion.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountCardPaymentsSettings", "type": "object", "x-expandableFields": ["decline_on"] }, "account_dashboard_settings": { "properties": { "display_name": { "description": "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts.", "maxLength": 5000, "nullable": true, "type": "string" }, "timezone": { "description": "The timezone used in the Stripe Dashboard for this account. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones).", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountDashboardSettings", "type": "object", "x-expandableFields": [] }, "account_decline_charge_on": { "properties": { "avs_failure": { "description": "Whether Stripe automatically declines charges with an incorrect ZIP or postal code. This setting only applies when a ZIP or postal code is provided and they fail bank verification.", "type": "boolean" }, "cvc_failure": { "description": "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification.", "type": "boolean" } }, "required": ["avs_failure", "cvc_failure"], "title": "AccountDeclineChargeOn", "type": "object", "x-expandableFields": [] }, "account_link": { "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "expires_at": { "description": "The timestamp at which this account link will expire.", "format": "unix-time", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": ["account_link"], "type": "string" }, "url": { "description": "The URL for the account link.", "maxLength": 5000, "type": "string" } }, "required": ["created", "expires_at", "object", "url"], "title": "AccountLink", "type": "object", "x-expandableFields": [], "x-resourceId": "account_link" }, "account_payments_settings": { "properties": { "statement_descriptor": { "description": "The default text that appears on credit card statements when a charge is made. This field prefixes any dynamic `statement_descriptor` specified on the charge.", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kana": { "description": "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only)", "maxLength": 5000, "nullable": true, "type": "string" }, "statement_descriptor_kanji": { "description": "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only)", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountPaymentsSettings", "type": "object", "x-expandableFields": [] }, "account_payout_settings": { "properties": { "debit_negative_balances": { "description": "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See our [Understanding Connect Account Balances](https://stripe.com/docs/connect/account-balances) documentation for details. Default value is `true` for Express accounts and `false` for Custom accounts.", "type": "boolean" }, "schedule": { "$ref": "#/components/schemas/transfer_schedule" }, "statement_descriptor": { "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.", "maxLength": 5000, "nullable": true, "type": "string" } }, "required": ["debit_negative_balances", "schedule"], "title": "AccountPayoutSettings", "type": "object", "x-expandableFields": ["schedule"] }, "account_requirements": { "properties": { "current_deadline": { "description": "The date the fields in `currently_due` must be collected by to keep payouts enabled for the account. These fields might block payouts sooner if the next threshold is reached before these fields are collected.", "format": "unix-time", "nullable": true, "type": "integer" }, "currently_due": { "description": "The fields that need to be collected to keep the account enabled. If not collected by the `current_deadline`, these fields appear in `past_due` as well, and the account is disabled.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "disabled_reason": { "description": "If the account is disabled, this string describes why the account can’t create charges or receive payouts. Can be `requirements.past_due`, `requirements.pending_verification`, `rejected.fraud`, `rejected.terms_of_service`, `rejected.listed`, `rejected.other`, `listed`, `under_review`, or `other`.", "maxLength": 5000, "nullable": true, "type": "string" }, "eventually_due": { "description": "The fields that need to be collected assuming all volume thresholds are reached. As they become required, these fields appear in `currently_due` as well, and the `current_deadline` is set.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "past_due": { "description": "The fields that weren't collected by the `current_deadline`. These fields need to be collected to re-enable the account.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" }, "pending_verification": { "description": "Fields that may become required depending on the results of verification or review. An empty array unless an asynchronous verification is pending. If verification fails, the fields in this array become required and move to `currently_due` or `past_due`.", "items": { "maxLength": 5000, "type": "string" }, "nullable": true, "type": "array" } }, "title": "AccountRequirements", "type": "object", "x-expandableFields": [] }, "account_settings": { "properties": { "branding": { "$ref": "#/components/schemas/account_branding_settings" }, "card_payments": { "$ref": "#/components/schemas/account_card_payments_settings" }, "dashboard": { "$ref": "#/components/schemas/account_dashboard_settings" }, "payments": { "$ref": "#/components/schemas/account_payments_settings" }, "payouts": { "$ref": "#/components/schemas/account_payout_settings" } }, "required": ["branding", "card_payments", "dashboard", "payments"], "title": "AccountSettings", "type": "object", "x-expandableFields": [ "branding", "card_payments", "dashboard", "payments", "payouts" ] }, "account_tos_acceptance": { "properties": { "date": { "description": "The Unix timestamp marking when the Stripe Services Agreement was accepted by the account representative", "format": "unix-time", "nullable": true, "type": "integer" }, "ip": { "description": "The IP address from which the Stripe Services Agreement was accepted by the account representative", "maxLength": 5000, "nullable": true, "type": "string" }, "user_agent": { "description": "The user agent of the browser from which the Stripe Services Agreement was accepted by the account representative", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "AccountTOSAcceptance", "type": "object", "x-expandableFields": [] }, "address": { "properties": { "city": { "description": "City/District/Suburb/Town/Village.", "maxLength": 5000, "nullable": true, "type": "string" }, "country": { "description": "2-letter country code.", "maxLength": 5000, "nullable": true, "type": "string" }, "line1": { "description": "Address line 1 (Street address/PO Box/Company name).", "maxLength": 5000, "nullable": true, "type": "string" }, "line2": { "description": "Address line 2 (Apartment/Suite/Unit/Building).", "maxLength": 5000, "nullable": true, "type": "string" }, "postal_code": { "description": "ZIP or postal code.", "maxLength": 5000, "nullable": true, "type": "string" }, "state": { "description": "State/County/Province/Region.", "maxLength": 5000, "nullable": true, "type": "string" } }, "title": "Address", "type": "object", "x-expandableFields": [] }, "alipay_account": { "properties": { "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": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ], "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/customer" }, { "$ref": "#/components/schemas/deleted_customer" } ] } }, "fingerprint": { "description": "Uniquely identifies the account and will be the same across all Alipay account objects that are linked to the same Alipay account.", "maxLength": 5000, "type": "string" }, "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" }, "metadata": { "additionalProperties": { "maxLength": 500, "type": "string" }, "description": "Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.", "type": "object" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": ["alipay_account"], "type": "string" }, "payment_amount": { "description": "If the Alipay account object is not reusable, the exact amount that you can create a charge for.", "nullable": true, "type": "integer" }, "payment_currency": { "description": "If the Alipay account object is not reusable, the exact currency that you can create a charge for.", "nullable": true, "type": "string" }, "reusable": { "description": "True if you can create multiple payments using this account. If the account is reusable, then you can freely choose the amount of each payment.", "type": "boolean" }, "used": { "description": "Whether this Alipay account object has ever been used for a payment.", "type": "boolean" }, "username": { "description": "The username for the Alipay account.", "maxLength": 5000, "type": "string" } }, "required": [ "created", "fingerprint", "id", "livemode", "object", "reusable", "used", "username" ], "title": "AlipayAccount", "type": "object", "x-expandableFields": ["customer"], "x-resourceId": "alipay_account" }, "api_errors": { "properties": { "charge": { "description": "For card errors, the ID of the failed charge.", "maxLength": 5000, "type": "string" }, "code": { "description": "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported.", "maxLength": 5000, "type": "string" }, "decline_code": { "description": "For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://stripe.com/docs/declines#issuer-declines) if they provide one.", "maxLength": 5000, "type": "string" }, "doc_url": { "description": "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported.", "maxLength": 5000, "type": "string" }, "message": { "description": "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.", "maxLength": 40000, "type": "string" }, "param": { "description": "If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.", "maxLength": 5000, "type": "string" }, "payment_intent": { "$ref": "#/components/schemas/payment_intent" }, "payment_method": { "$ref": "#/components/schemas/payment_method" }, "setup_intent": { "$ref": "#/components/schemas/setup_intent" }, "source": { "anyOf": [ { "$ref": "#/components/schemas/bank_account" }, { "$ref": "#/components/schemas/card" }, { "$ref": "#/components/schemas/source" } ], "description": "The source object for errors returned on a request involving a source." }, "type": { "description": "The type of error returned. One of `api_connection_error`, `api_error`, `authentication_error`, `card_error`, `idempotency_error`, `invalid_request_error`, or `rate_limit_error`", "enum": [ "api_connection_error", "api_error", "authentication_error", "card_error", "idempotency_error", "invalid_request_error", "rate_limit_error" ], "type": "string" } }, "required": ["type"], "title": "APIErrors", "type": "object", "x-expandableFields": [ "payment_intent", "payment_method", "setup_intent", "source" ] }, "apple_pay_domain": { "properties": { "created": { "description": "Time at which the object was created. Measured in seconds since the Unix epoch.", "format": "unix-time", "type": "integer" }, "domain_name": { "maxLength": 5000, "type": "string" }, "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": ["apple_pay_domain"], "type": "string" } }, "required": ["created", "domain_name", "id", "livemode", "object"], "title": "ApplePayDomain", "type": "object", "x-expandableFields": [], "x-resourceId": "apple_pay_domain" }, "application": { "properties": { "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "name": { "description": "The name of the application.", "maxLength": 5000, "nullable": true, "type": "string" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": ["application"], "type": "string" } }, "required": ["id", "object"], "title": "Application", "type": "object", "x-expandableFields": [] }, "application_fee": { "properties": { "account": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/account" } ], "description": "ID of the Stripe account this fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/account" } ] } }, "amount": { "description": "Amount earned, in %s.", "type": "integer" }, "amount_refunded": { "description": "Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)", "type": "integer" }, "application": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application" } ], "description": "ID of the Connect application that earned the fee.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application" } ] } }, "balance_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/balance_transaction" } ], "description": "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds).", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/balance_transaction" } ] } }, "charge": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the charge that the application fee was taken from.", "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "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" }, "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": ["application_fee"], "type": "string" }, "originating_transaction": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/charge" } ], "description": "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/charge" } ] } }, "refunded": { "description": "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false.", "type": "boolean" }, "refunds": { "description": "A list of refunds that have been applied to the fee.", "properties": { "data": { "items": { "$ref": "#/components/schemas/fee_refund" }, "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": "FeeRefundList", "type": "object", "x-expandableFields": ["data"] } }, "required": [ "account", "amount", "amount_refunded", "application", "charge", "created", "currency", "id", "livemode", "object", "refunded", "refunds" ], "title": "PlatformFee", "type": "object", "x-expandableFields": [ "account", "application", "balance_transaction", "charge", "originating_transaction", "refunds" ], "x-resourceId": "application_fee" }, "balance": { "properties": { "available": { "description": "Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](#transfers) or [Payouts API](#payouts). The available balance for each currency and payment type can be found in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "connect_reserved": { "description": "Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" }, "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": ["balance"], "type": "string" }, "pending": { "description": "Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property.", "items": { "$ref": "#/components/schemas/balance_amount" }, "type": "array" } }, "required": ["available", "livemode", "object", "pending"], "title": "Balance", "type": "object", "x-expandableFields": ["available", "connect_reserved", "pending"], "x-resourceId": "balance" }, "balance_amount": { "properties": { "amount": { "description": "Balance amount.", "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" }, "source_types": { "$ref": "#/components/schemas/balance_amount_by_source_type" } }, "required": ["amount", "currency"], "title": "BalanceAmount", "type": "object", "x-expandableFields": ["source_types"] }, "balance_amount_by_source_type": { "properties": { "bank_account": { "description": "Amount for bank account.", "type": "integer" }, "card": { "description": "Amount for card.", "type": "integer" } }, "title": "BalanceAmountBySourceType", "type": "object", "x-expandableFields": [] }, "balance_transaction": { "properties": { "amount": { "description": "Gross amount of the transaction, in %s.", "type": "integer" }, "available_on": { "description": "The date the transaction's net funds will become available in the Stripe balance.", "format": "unix-time", "type": "integer" }, "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" }, "description": { "description": "An arbitrary string attached to the object. Often useful for displaying to users.", "maxLength": 5000, "nullable": true, "type": "string" }, "exchange_rate": { "nullable": true, "type": "number" }, "fee": { "description": "Fees (in %s) paid for this transaction.", "type": "integer" }, "fee_details": { "description": "Detailed breakdown of fees (in %s) paid for this transaction.", "items": { "$ref": "#/components/schemas/fee" }, "type": "array" }, "id": { "description": "Unique identifier for the object.", "maxLength": 5000, "type": "string" }, "net": { "description": "Net amount of the transaction, in %s.", "type": "integer" }, "object": { "description": "String representing the object's type. Objects of the same type share the same value.", "enum": ["balance_transaction"], "type": "string" }, "source": { "anyOf": [ { "maxLength": 5000, "type": "string" }, { "$ref": "#/components/schemas/application_fee" }, { "$ref": "#/components/schemas/charge" }, { "$ref": "#/components/schemas/connect_collection_transfer" }, { "$ref": "#/components/schemas/dispute" }, { "$ref": "#/components/schemas/fee_refund" }, { "$ref": "#/components/schemas/issuing.authorization" }, { "$ref": "#/components/schemas/issuing.transaction" }, { "$ref": "#/components/schemas/payout" }, { "$ref": "#/components/schemas/platform_tax_fee" }, { "$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" } ], "description": "The Stripe object to which this transaction is related.", "nullable": true, "x-expansionResources": { "oneOf": [ { "$ref": "#/components/schemas/application_fee" }, { "$ref": "#/components/schemas/charge" }, { "$ref": "#/components/schemas/connect_collection_transfer" }, { "$ref": "#/components/schemas/dispute" }, { "$ref": "#/components/schemas/fee_refund" }, { "$ref": "#/components/schemas/issuing.authorization" }, { "$ref": "#/components/schemas/issuing.transaction" }, { "$ref": "#/components/schemas/payout" }, { "$ref": "#/components/schemas/platform_tax_fee" }, { "$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" } ] } }, "status": { "description": "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.", "maxLength": 5000, "type": "string" }, "type": { "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent.", "enum": [ "adjustment", "advance", "advance_funding", "application_fee", "application_fee_refund", "charge", "connect_collection_transfer", "issuing_authorization_hold", "issuing_authorization_release", "issuing_transaction", "payment", "payment_failure_refund", "payment_refund", "payout", "payout_cancel", "payout_failure", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel",