export declare const accountSchema: { readonly description: "This is an object representing a Stripe account. You can retrieve it to see\nproperties on the account like its current requirements or if the account is\nenabled to make live charges or receive payouts.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `application`, which includes Custom accounts, the properties below are always\nreturned.\n\nFor accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection)\nis `stripe`, which includes Standard and Express accounts, some properties are only returned\nuntil you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions)\nto start Connect Onboarding. Learn about the [differences between accounts](/connect/accounts)."; readonly properties: { readonly business_profile: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/account_business_profile"; }]; readonly description: "Business information about the account."; readonly nullable: true; }; readonly business_type: { readonly description: "The business type. After you create an [Account Link](/api/account_links) or [Account Session](/api/account_sessions), this property is only returned for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts."; readonly enum: readonly ["company", "government_entity", "individual", "non_profit"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly capabilities: { readonly $ref: "#/components/schemas/account_capabilities"; }; readonly charges_enabled: { readonly description: "Whether the account can create live charges."; readonly type: "boolean"; }; readonly company: { readonly $ref: "#/components/schemas/legal_entity_company"; }; readonly controller: { readonly $ref: "#/components/schemas/account_unification_account_controller"; }; readonly country: { readonly description: "The account's country."; readonly maxLength: 5000; readonly type: "string"; }; readonly created: { readonly description: "Time at which the account was connected. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly default_currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly details_submitted: { readonly description: "Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to [an onboarding flow](/connect/onboarding) to finish submitting account details."; readonly type: "boolean"; }; readonly email: { readonly description: "An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly external_accounts: { readonly description: "External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where `controller[is_controller]` is true."; readonly properties: { readonly data: { readonly description: "The list contains all external accounts that have been attached to the Stripe account. These may be bank accounts or cards."; readonly items: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }]; readonly title: "Polymorphic"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "ExternalAccountList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly future_requirements: { readonly $ref: "#/components/schemas/account_future_requirements"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly individual: { readonly $ref: "#/components/schemas/person"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["account"]; readonly type: "string"; }; readonly payouts_enabled: { readonly description: "Whether Stripe can send payouts to this account."; readonly type: "boolean"; }; readonly requirements: { readonly $ref: "#/components/schemas/account_requirements"; }; readonly settings: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/account_settings"; }]; readonly description: "Options for customizing how the account functions within Stripe."; readonly nullable: true; }; readonly tos_acceptance: { readonly $ref: "#/components/schemas/account_tos_acceptance"; }; readonly type: { readonly description: "The Stripe account type. Can be `standard`, `express`, `custom`, or `none`."; readonly enum: readonly ["custom", "express", "none", "standard"]; readonly type: "string"; }; }; readonly required: readonly ["id", "object"]; readonly title: "Account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["business_profile", "capabilities", "company", "controller", "external_accounts", "future_requirements", "individual", "requirements", "settings", "tos_acceptance"]; readonly 'x-resourceId': "account"; }; export declare const account_annual_revenueSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "A non-negative integer representing the amount in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."; readonly nullable: true; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly nullable: true; readonly type: "string"; }; readonly fiscal_year_end: { readonly description: "The close-out date of the preceding fiscal year in ISO 8601 format. E.g. 2023-12-31 for the 31st of December, 2023."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountAnnualRevenue"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_bacs_debit_payments_settingsSchema: { readonly description: ""; readonly properties: { readonly display_name: { readonly description: "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly service_user_number: { readonly description: "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountBacsDebitPaymentsSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_branding_settingsSchema: { readonly description: ""; readonly properties: { readonly icon: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly 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."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly logo: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly 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."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly primary_color: { readonly description: "A CSS hex color value representing the primary branding color for this account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly secondary_color: { readonly description: "A CSS hex color value representing the secondary branding color for this account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountBrandingSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["icon", "logo"]; }; export declare const account_business_profileSchema: { readonly description: ""; readonly properties: { readonly annual_revenue: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/account_annual_revenue"; }]; readonly description: "The applicant's gross annual revenue for its preceding fiscal year."; readonly nullable: true; }; readonly estimated_worker_count: { readonly description: "An estimated upper bound of employees, contractors, vendors, etc. currently working for the business."; readonly nullable: true; readonly type: "integer"; }; readonly mcc: { readonly description: "[The merchant category code for the account](https://stripe.com/docs/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly monthly_estimated_revenue: { readonly $ref: "#/components/schemas/account_monthly_estimated_revenue"; }; readonly name: { readonly description: "The customer-facing business name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_description: { readonly description: "Internal-only description of the product sold or service provided by the business. It's used by Stripe for risk and underwriting purposes."; readonly maxLength: 40000; readonly nullable: true; readonly type: "string"; }; readonly support_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "A publicly available mailing address for sending support issues to."; readonly nullable: true; }; readonly support_email: { readonly description: "A publicly available email address for sending support issues to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly support_phone: { readonly description: "A publicly available phone number to call with support issues."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly support_url: { readonly description: "A publicly available website for handling support issues."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The business's publicly available website."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountBusinessProfile"; readonly type: "object"; readonly 'x-expandableFields': readonly ["annual_revenue", "monthly_estimated_revenue", "support_address"]; }; export declare const account_capabilitiesSchema: { readonly description: ""; readonly properties: { readonly acss_debit_payments: { readonly description: "The status of the Canadian pre-authorized debits payments capability of the account, or whether the account can directly process Canadian pre-authorized debits charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly affirm_payments: { readonly description: "The status of the Affirm capability of the account, or whether the account can directly process Affirm charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly afterpay_clearpay_payments: { readonly description: "The status of the Afterpay Clearpay capability of the account, or whether the account can directly process Afterpay Clearpay charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly amazon_pay_payments: { readonly description: "The status of the AmazonPay capability of the account, or whether the account can directly process AmazonPay payments."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly au_becs_debit_payments: { readonly description: "The status of the BECS Direct Debit (AU) payments capability of the account, or whether the account can directly process BECS Direct Debit (AU) charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly bacs_debit_payments: { readonly description: "The status of the Bacs Direct Debits payments capability of the account, or whether the account can directly process Bacs Direct Debits charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly bancontact_payments: { readonly description: "The status of the Bancontact payments capability of the account, or whether the account can directly process Bancontact charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly bank_transfer_payments: { readonly description: "The status of the customer_balance payments capability of the account, or whether the account can directly process customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly blik_payments: { readonly description: "The status of the blik payments capability of the account, or whether the account can directly process blik charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly boleto_payments: { readonly description: "The status of the boleto payments capability of the account, or whether the account can directly process boleto charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly card_issuing: { readonly description: "The status of the card issuing capability of the account, or whether you can use Issuing to distribute funds on cards"; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly card_payments: { readonly description: "The status of the card payments capability of the account, or whether the account can directly process credit and debit card charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly cartes_bancaires_payments: { readonly description: "The status of the Cartes Bancaires payments capability of the account, or whether the account can directly process Cartes Bancaires card charges in EUR currency."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly cashapp_payments: { readonly description: "The status of the Cash App Pay capability of the account, or whether the account can directly process Cash App Pay payments."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly eps_payments: { readonly description: "The status of the EPS payments capability of the account, or whether the account can directly process EPS charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly fpx_payments: { readonly description: "The status of the FPX payments capability of the account, or whether the account can directly process FPX charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly gb_bank_transfer_payments: { readonly description: "The status of the GB customer_balance payments (GBP currency) capability of the account, or whether the account can directly process GB customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly giropay_payments: { readonly description: "The status of the giropay payments capability of the account, or whether the account can directly process giropay charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly grabpay_payments: { readonly description: "The status of the GrabPay payments capability of the account, or whether the account can directly process GrabPay charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly ideal_payments: { readonly description: "The status of the iDEAL payments capability of the account, or whether the account can directly process iDEAL charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly india_international_payments: { readonly description: "The status of the india_international_payments capability of the account, or whether the account can process international charges (non INR) in India."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly jcb_payments: { readonly description: "The status of the JCB payments capability of the account, or whether the account (Japan only) can directly process JCB credit card charges in JPY currency."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly jp_bank_transfer_payments: { readonly description: "The status of the Japanese customer_balance payments (JPY currency) capability of the account, or whether the account can directly process Japanese customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly klarna_payments: { readonly description: "The status of the Klarna payments capability of the account, or whether the account can directly process Klarna charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly konbini_payments: { readonly description: "The status of the konbini payments capability of the account, or whether the account can directly process konbini charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly legacy_payments: { readonly description: "The status of the legacy payments capability of the account."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly link_payments: { readonly description: "The status of the link_payments capability of the account, or whether the account can directly process Link charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly mobilepay_payments: { readonly description: "The status of the MobilePay capability of the account, or whether the account can directly process MobilePay charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly multibanco_payments: { readonly description: "The status of the Multibanco payments capability of the account, or whether the account can directly process Multibanco charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly mx_bank_transfer_payments: { readonly description: "The status of the Mexican customer_balance payments (MXN currency) capability of the account, or whether the account can directly process Mexican customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly oxxo_payments: { readonly description: "The status of the OXXO payments capability of the account, or whether the account can directly process OXXO charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly p24_payments: { readonly description: "The status of the P24 payments capability of the account, or whether the account can directly process P24 charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly paynow_payments: { readonly description: "The status of the paynow payments capability of the account, or whether the account can directly process paynow charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly promptpay_payments: { readonly description: "The status of the promptpay payments capability of the account, or whether the account can directly process promptpay charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly revolut_pay_payments: { readonly description: "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly sepa_bank_transfer_payments: { readonly description: "The status of the SEPA customer_balance payments (EUR currency) capability of the account, or whether the account can directly process SEPA customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly sepa_debit_payments: { readonly description: "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly sofort_payments: { readonly description: "The status of the Sofort payments capability of the account, or whether the account can directly process Sofort charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly swish_payments: { readonly description: "The status of the Swish capability of the account, or whether the account can directly process Swish payments."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly tax_reporting_us_1099_k: { readonly description: "The status of the tax reporting 1099-K (US) capability of the account."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly tax_reporting_us_1099_misc: { readonly description: "The status of the tax reporting 1099-MISC (US) capability of the account."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly transfers: { readonly description: "The status of the transfers capability of the account, or whether your platform can transfer funds to the account."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly treasury: { readonly description: "The status of the banking capability, or whether the account can have bank accounts."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly twint_payments: { readonly description: "The status of the TWINT capability of the account, or whether the account can directly process TWINT charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly us_bank_account_ach_payments: { readonly description: "The status of the US bank account ACH payments capability of the account, or whether the account can directly process US bank account charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly us_bank_transfer_payments: { readonly description: "The status of the US customer_balance payments (USD currency) capability of the account, or whether the account can directly process US customer_balance charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly zip_payments: { readonly description: "The status of the Zip capability of the account, or whether the account can directly process Zip charges."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; }; readonly title: "AccountCapabilities"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_capability_future_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly current_deadline: { readonly description: "Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on the capability's enablement state prior to transitioning."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the capability enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly disabled_reason: { readonly description: "This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["currently_due", "errors", "eventually_due", "past_due", "pending_verification"]; readonly title: "AccountCapabilityFutureRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const account_capability_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly current_deadline: { readonly description: "Date by which the fields in `currently_due` must be collected to keep the capability enabled for the account. These fields may disable the capability sooner if the next threshold is reached before they are collected."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the capability enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the capability is disabled."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly disabled_reason: { readonly description: "If the capability is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `requirements.fields_needed`, `pending.onboarding`, `pending.review`, `rejected.other`, `platform_paused`, `rejected.inactivty`, or `rejected.unsupported_business`.\n\n`rejected.unsupported_business` means that the account's business is not supported by the capability. For example, payment methods may restrict the businesses they support in their terms of service, such as in [Afterpay Clearpay's terms of service](/afterpay-clearpay/legal#restricted-businesses).\n\n`rejected.inactivity` means that the capability has been paused for inactivity. This disabled reason currently only applies to the Issuing capability. See [Issuing: Managing Inactive Connects](https://support.stripe.com/questions/issuing-managing-inactive-connect-accounts) for more details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the capability on the account."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["currently_due", "errors", "eventually_due", "past_due", "pending_verification"]; readonly title: "AccountCapabilityRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const account_card_issuing_settingsSchema: { readonly description: ""; readonly properties: { readonly tos_acceptance: { readonly $ref: "#/components/schemas/card_issuing_account_terms_of_service"; }; }; readonly title: "AccountCardIssuingSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tos_acceptance"]; }; export declare const account_card_payments_settingsSchema: { readonly description: ""; readonly properties: { readonly decline_on: { readonly $ref: "#/components/schemas/account_decline_charge_on"; }; readonly statement_descriptor_prefix: { readonly 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."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_prefix_kana: { readonly description: "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_prefix_kanji: { readonly description: "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountCardPaymentsSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["decline_on"]; }; export declare const account_dashboard_settingsSchema: { readonly description: ""; readonly properties: { readonly display_name: { readonly description: "The display name for this account. This is used on the Stripe Dashboard to differentiate between accounts."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly timezone: { readonly 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)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountDashboardSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_decline_charge_onSchema: { readonly description: ""; readonly properties: { readonly avs_failure: { readonly 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."; readonly type: "boolean"; }; readonly cvc_failure: { readonly description: "Whether Stripe automatically declines charges with an incorrect CVC. This setting only applies when a CVC is provided and it fails bank verification."; readonly type: "boolean"; }; }; readonly required: readonly ["avs_failure", "cvc_failure"]; readonly title: "AccountDeclineChargeOn"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_future_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly current_deadline: { readonly description: "Date on which `future_requirements` merges with the main `requirements` hash and `future_requirements` becomes empty. After the transition, `currently_due` requirements may immediately become `past_due`, but the account may also be given a grace period depending on its enablement state prior to transitioning."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the account enabled. If not collected by `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly disabled_reason: { readonly description: "This is typed as a string for consistency with `requirements.disabled_reason`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly nullable: true; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by `requirements.current_deadline`. These fields need to be collected to enable the capability on the account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "AccountFutureRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const account_invoices_settingsSchema: { readonly description: ""; readonly properties: { readonly default_account_tax_ids: { readonly description: "The list of default Account Tax IDs to automatically include on invoices. Account Tax IDs get added when an invoice is finalized."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "AccountInvoicesSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["default_account_tax_ids"]; }; export declare const account_linkSchema: { readonly description: "Account Links are the means by which a Connect platform grants a connected account permission to access\nStripe-hosted applications, such as Connect Onboarding.\n\nRelated guide: [Connect Onboarding](https://stripe.com/docs/connect/custom/hosted-onboarding)"; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expires_at: { readonly description: "The timestamp at which this account link will expire."; readonly format: "unix-time"; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["account_link"]; readonly type: "string"; }; readonly url: { readonly description: "The URL for the account link."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "expires_at", "object", "url"]; readonly title: "AccountLink"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "account_link"; }; export declare const account_monthly_estimated_revenueSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal)."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "AccountMonthlyEstimatedRevenue"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_payments_settingsSchema: { readonly description: ""; readonly properties: { readonly statement_descriptor: { readonly 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."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_kana: { readonly description: "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only)"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_kanji: { readonly description: "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only)"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_prefix_kana: { readonly description: "The Kana variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kana` specified on the charge. `statement_descriptor_prefix_kana` is useful for maximizing descriptor space for the dynamic portion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_prefix_kanji: { readonly description: "The Kanji variation of the default text that appears on credit card statements when a charge is made (Japan only). This field prefixes any dynamic `statement_descriptor_suffix_kanji` specified on the charge. `statement_descriptor_prefix_kanji` is useful for maximizing descriptor space for the dynamic portion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountPaymentsSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_payout_settingsSchema: { readonly description: ""; readonly properties: { readonly debit_negative_balances: { readonly description: "A Boolean indicating if Stripe should try to reclaim negative balances from an attached bank account. See [Understanding Connect account balances](/connect/account-balances) for details. The default value is `false` when [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts, otherwise `true`."; readonly type: "boolean"; }; readonly schedule: { readonly $ref: "#/components/schemas/transfer_schedule"; }; readonly statement_descriptor: { readonly 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."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["debit_negative_balances", "schedule"]; readonly title: "AccountPayoutSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["schedule"]; }; export declare const account_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly current_deadline: { readonly description: "Date by which the fields in `currently_due` must be collected to keep the account enabled. These fields may disable the account sooner if the next threshold is reached before they are collected."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly disabled_reason: { readonly description: "If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly nullable: true; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and `current_deadline` becomes set."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the account."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "AccountRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const account_requirements_alternativeSchema: { readonly description: ""; readonly properties: { readonly alternative_fields_due: { readonly description: "Fields that can be provided to satisfy all fields in `original_fields_due`."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly original_fields_due: { readonly description: "Fields that are due and can be satisfied by providing all fields in `alternative_fields_due`."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["alternative_fields_due", "original_fields_due"]; readonly title: "AccountRequirementsAlternative"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_requirements_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "The code for the type of error."; readonly enum: readonly ["invalid_address_city_state_postal_code", "invalid_address_highway_contract_box", "invalid_address_private_mailbox", "invalid_business_profile_name", "invalid_business_profile_name_denylisted", "invalid_company_name_denylisted", "invalid_dob_age_over_maximum", "invalid_dob_age_under_18", "invalid_dob_age_under_minimum", "invalid_product_description_length", "invalid_product_description_url_match", "invalid_representative_country", "invalid_statement_descriptor_business_mismatch", "invalid_statement_descriptor_denylisted", "invalid_statement_descriptor_length", "invalid_statement_descriptor_prefix_denylisted", "invalid_statement_descriptor_prefix_mismatch", "invalid_street_address", "invalid_tax_id", "invalid_tax_id_format", "invalid_tos_acceptance", "invalid_url_denylisted", "invalid_url_format", "invalid_url_web_presence_detected", "invalid_url_website_business_information_mismatch", "invalid_url_website_empty", "invalid_url_website_inaccessible", "invalid_url_website_inaccessible_geoblocked", "invalid_url_website_inaccessible_password_protected", "invalid_url_website_incomplete", "invalid_url_website_incomplete_cancellation_policy", "invalid_url_website_incomplete_customer_service_details", "invalid_url_website_incomplete_legal_restrictions", "invalid_url_website_incomplete_refund_policy", "invalid_url_website_incomplete_return_policy", "invalid_url_website_incomplete_terms_and_conditions", "invalid_url_website_incomplete_under_construction", "invalid_url_website_other", "invalid_value_other", "verification_directors_mismatch", "verification_document_address_mismatch", "verification_document_address_missing", "verification_document_corrupt", "verification_document_country_not_supported", "verification_document_directors_mismatch", "verification_document_dob_mismatch", "verification_document_duplicate_type", "verification_document_expired", "verification_document_failed_copy", "verification_document_failed_greyscale", "verification_document_failed_other", "verification_document_failed_test_mode", "verification_document_fraudulent", "verification_document_id_number_mismatch", "verification_document_id_number_missing", "verification_document_incomplete", "verification_document_invalid", "verification_document_issue_or_expiry_date_missing", "verification_document_manipulated", "verification_document_missing_back", "verification_document_missing_front", "verification_document_name_mismatch", "verification_document_name_missing", "verification_document_nationality_mismatch", "verification_document_not_readable", "verification_document_not_signed", "verification_document_not_uploaded", "verification_document_photo_mismatch", "verification_document_too_large", "verification_document_type_not_supported", "verification_extraneous_directors", "verification_failed_address_match", "verification_failed_business_iec_number", "verification_failed_document_match", "verification_failed_id_number_match", "verification_failed_keyed_identity", "verification_failed_keyed_match", "verification_failed_name_match", "verification_failed_other", "verification_failed_representative_authority", "verification_failed_residential_address", "verification_failed_tax_id_match", "verification_failed_tax_id_not_issued", "verification_missing_directors", "verification_missing_executives", "verification_missing_owners", "verification_requires_additional_memorandum_of_associations", "verification_requires_additional_proof_of_registration"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly reason: { readonly description: "An informative message that indicates the error type and provides additional details about the error."; readonly maxLength: 5000; readonly type: "string"; }; readonly requirement: { readonly description: "The specific user onboarding requirement field (in the requirements hash) that needs to be resolved."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["code", "reason", "requirement"]; readonly title: "AccountRequirementsError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_sepa_debit_payments_settingsSchema: { readonly description: ""; readonly properties: { readonly creditor_id: { readonly description: "SEPA creditor identifier that identifies the company making the payment."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "AccountSepaDebitPaymentsSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_sessionSchema: { readonly description: "An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.\n\nWe recommend that you create an AccountSession each time you need to display an embedded component\nto your user. Do not save AccountSessions to your database as they expire relatively\nquickly, and cannot be used more than once.\n\nRelated guide: [Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components)"; readonly properties: { readonly account: { readonly description: "The ID of the account the AccountSession was created for"; readonly maxLength: 5000; readonly type: "string"; }; readonly client_secret: { readonly description: "The client secret of this AccountSession. Used on the client to set up secure access to the given `account`.\n\nThe client secret can be used to provide access to `account` from your frontend. It should not be stored, logged, or exposed to anyone other than the connected account. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [setup Connect embedded components](https://stripe.com/docs/connect/get-started-connect-embedded-components) and learn about how `client_secret` should be handled."; readonly maxLength: 5000; readonly type: "string"; }; readonly components: { readonly $ref: "#/components/schemas/connect_embedded_account_session_create_components"; }; readonly expires_at: { readonly description: "The timestamp at which this AccountSession will expire."; readonly format: "unix-time"; readonly type: "integer"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["account_session"]; readonly type: "string"; }; }; readonly required: readonly ["account", "client_secret", "components", "expires_at", "livemode", "object"]; readonly title: "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession"; readonly type: "object"; readonly 'x-expandableFields': readonly ["components"]; readonly 'x-resourceId': "account_session"; }; export declare const account_settingsSchema: { readonly description: ""; readonly properties: { readonly bacs_debit_payments: { readonly $ref: "#/components/schemas/account_bacs_debit_payments_settings"; }; readonly branding: { readonly $ref: "#/components/schemas/account_branding_settings"; }; readonly card_issuing: { readonly $ref: "#/components/schemas/account_card_issuing_settings"; }; readonly card_payments: { readonly $ref: "#/components/schemas/account_card_payments_settings"; }; readonly dashboard: { readonly $ref: "#/components/schemas/account_dashboard_settings"; }; readonly invoices: { readonly $ref: "#/components/schemas/account_invoices_settings"; }; readonly payments: { readonly $ref: "#/components/schemas/account_payments_settings"; }; readonly payouts: { readonly $ref: "#/components/schemas/account_payout_settings"; }; readonly sepa_debit_payments: { readonly $ref: "#/components/schemas/account_sepa_debit_payments_settings"; }; readonly treasury: { readonly $ref: "#/components/schemas/account_treasury_settings"; }; }; readonly required: readonly ["branding", "card_payments", "dashboard", "payments"]; readonly title: "AccountSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bacs_debit_payments", "branding", "card_issuing", "card_payments", "dashboard", "invoices", "payments", "payouts", "sepa_debit_payments", "treasury"]; }; export declare const account_terms_of_serviceSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the account representative accepted the service agreement."; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the account representative accepted the service agreement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the account representative accepted the service agreement."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "AccountTermsOfService"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_tos_acceptanceSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the account representative accepted their service agreement"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the account representative accepted their service agreement"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly service_agreement: { readonly description: "The user's service agreement type"; readonly maxLength: 5000; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the account representative accepted their service agreement"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "AccountTOSAcceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_treasury_settingsSchema: { readonly description: ""; readonly properties: { readonly tos_acceptance: { readonly $ref: "#/components/schemas/account_terms_of_service"; }; }; readonly title: "AccountTreasurySettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tos_acceptance"]; }; export declare const account_unification_account_controllerSchema: { readonly description: ""; readonly properties: { readonly fees: { readonly $ref: "#/components/schemas/account_unification_account_controller_fees"; }; readonly is_controller: { readonly description: "`true` if the Connect application retrieving the resource controls the account and can therefore exercise [platform controls](https://stripe.com/docs/connect/platform-controls-for-standard-accounts). Otherwise, this field is null."; readonly type: "boolean"; }; readonly losses: { readonly $ref: "#/components/schemas/account_unification_account_controller_losses"; }; readonly requirement_collection: { readonly description: "A value indicating responsibility for collecting requirements on this account. Only returned when the Connect application retrieving the resource controls the account."; readonly enum: readonly ["application", "stripe"]; readonly type: "string"; }; readonly stripe_dashboard: { readonly $ref: "#/components/schemas/account_unification_account_controller_stripe_dashboard"; }; readonly type: { readonly description: "The controller type. Can be `application`, if a Connect application controls the account, or `account`, if the account controls itself."; readonly enum: readonly ["account", "application"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "AccountUnificationAccountController"; readonly type: "object"; readonly 'x-expandableFields': readonly ["fees", "losses", "stripe_dashboard"]; }; export declare const account_unification_account_controller_feesSchema: { readonly description: ""; readonly properties: { readonly payer: { readonly description: "A value indicating the responsible payer of a bundle of Stripe fees for pricing-control eligible products on this account. Learn more about [fee behavior on connected accounts](https://docs.stripe.com/connect/direct-charges-fee-payer-behavior)."; readonly enum: readonly ["account", "application", "application_custom", "application_express"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["payer"]; readonly title: "AccountUnificationAccountControllerFees"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_unification_account_controller_lossesSchema: { readonly description: ""; readonly properties: { readonly payments: { readonly description: "A value indicating who is liable when this account can't pay back negative balances from payments."; readonly enum: readonly ["application", "stripe"]; readonly type: "string"; }; }; readonly required: readonly ["payments"]; readonly title: "AccountUnificationAccountControllerLosses"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const account_unification_account_controller_stripe_dashboardSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "A value indicating the Stripe dashboard this account has access to independent of the Connect application."; readonly enum: readonly ["express", "full", "none"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "AccountUnificationAccountControllerStripeDashboard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const addressSchema: { readonly description: ""; readonly properties: { readonly city: { readonly description: "City, district, suburb, town, or village."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line1: { readonly description: "Address line 1 (e.g., street, PO Box, or company name)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line2: { readonly description: "Address line 2 (e.g., apartment, suite, unit, or building)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly postal_code: { readonly description: "ZIP or postal code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly state: { readonly description: "State, county, province, or region."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "Address"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const api_errorsSchema: { readonly description: ""; readonly properties: { readonly charge: { readonly description: "For card errors, the ID of the failed charge."; readonly maxLength: 5000; readonly type: "string"; }; readonly code: { readonly description: "For some errors that could be handled programmatically, a short string indicating the [error code](https://stripe.com/docs/error-codes) reported."; readonly maxLength: 5000; readonly type: "string"; }; readonly decline_code: { readonly 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."; readonly maxLength: 5000; readonly type: "string"; }; readonly doc_url: { readonly description: "A URL to more information about the [error code](https://stripe.com/docs/error-codes) reported."; readonly maxLength: 5000; readonly type: "string"; }; readonly message: { readonly description: "A human-readable message providing more details about the error. For card errors, these messages can be shown to your users."; readonly maxLength: 40000; readonly type: "string"; }; readonly param: { readonly 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."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_intent: { readonly $ref: "#/components/schemas/payment_intent"; }; readonly payment_method: { readonly $ref: "#/components/schemas/payment_method"; }; readonly payment_method_type: { readonly description: "If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors."; readonly maxLength: 5000; readonly type: "string"; }; readonly request_log_url: { readonly description: "A URL to the request log entry in your dashboard."; readonly maxLength: 5000; readonly type: "string"; }; readonly setup_intent: { readonly $ref: "#/components/schemas/setup_intent"; }; readonly source: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly description: "The [source object](https://stripe.com/docs/api/sources/object) for errors returned on a request involving a source."; }; readonly type: { readonly description: "The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`"; readonly enum: readonly ["api_error", "card_error", "idempotency_error", "invalid_request_error"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "APIErrors"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_intent", "payment_method", "setup_intent", "source"]; }; export declare const apple_pay_domainSchema: { readonly description: ""; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly domain_name: { readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["apple_pay_domain"]; readonly type: "string"; }; }; readonly required: readonly ["created", "domain_name", "id", "livemode", "object"]; readonly title: "ApplePayDomain"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "apple_pay_domain"; }; export declare const applicationSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "The name of the application."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["application"]; readonly type: "string"; }; }; readonly required: readonly ["id", "object"]; readonly title: "Application"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const application_feeSchema: { readonly description: ""; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "ID of the Stripe account this fee was taken from."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly amount: { readonly description: "Amount earned, in cents (or local equivalent)."; readonly type: "integer"; }; readonly amount_refunded: { readonly description: "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)"; readonly type: "integer"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "ID of the Connect application that earned the fee."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "Balance transaction that describes the impact of this collected application fee on your account balance (not including refunds)."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the charge that the application fee was taken from."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly fee_source: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/platform_earning_fee_source"; }]; readonly description: "Polymorphic source of the application fee. Includes the ID of the object the application fee was created from."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["application_fee"]; readonly type: "string"; }; readonly originating_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the corresponding charge on the platform account, if this fee was the result of a charge using the `destination` parameter."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly refunded: { readonly description: "Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will still be false."; readonly type: "boolean"; }; readonly refunds: { readonly description: "A list of refunds that have been applied to the fee."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/fee_refund"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "FeeRefundList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; }; readonly required: readonly ["account", "amount", "amount_refunded", "application", "charge", "created", "currency", "id", "livemode", "object", "refunded", "refunds"]; readonly title: "PlatformFee"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "application", "balance_transaction", "charge", "fee_source", "originating_transaction", "refunds"]; readonly 'x-resourceId': "application_fee"; }; export declare const apps_secretSchema: { readonly description: "Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.\n\nThe primary resource in Secret Store is a `secret`. Other apps can't view secrets created by an app. Additionally, secrets are scoped to provide further permission control.\n\nAll Dashboard users and the app backend share `account` scoped secrets. Use the `account` scope for secrets that don't change per-user, like a third-party API key.\n\nA `user` scoped secret is accessible by the app backend and one specific Dashboard user. Use the `user` scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.\n\nRelated guide: [Store data between page reloads](https://stripe.com/docs/stripe-apps/store-auth-data-custom-objects)"; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly deleted: { readonly description: "If true, indicates that this secret has been deleted"; readonly type: "boolean"; }; readonly expires_at: { readonly description: "The Unix timestamp for the expiry time of the secret, after which the secret deletes."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly name: { readonly description: "A name for the secret that's unique within the scope."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["apps.secret"]; readonly type: "string"; }; readonly payload: { readonly description: "The plaintext secret value to be stored."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly scope: { readonly $ref: "#/components/schemas/secret_service_resource_scope"; }; }; readonly required: readonly ["created", "id", "livemode", "name", "object", "scope"]; readonly title: "SecretServiceResourceSecret"; readonly type: "object"; readonly 'x-expandableFields': readonly ["scope"]; readonly 'x-resourceId': "apps.secret"; }; export declare const automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether Stripe automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://stripe.com/docs/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices."; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; readonly status: { readonly description: "The status of the most recent automated tax calculation for this invoice."; readonly enum: readonly ["complete", "failed", "requires_location_inputs"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["enabled"]; readonly title: "AutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const balanceSchema: { readonly description: "This is an object representing your Stripe balance. You can retrieve it to see\nthe balance currently on your Stripe account.\n\nYou can also retrieve the balance history, which contains a list of\n[transactions](https://stripe.com/docs/reporting/balance-transaction-types) that contributed to the balance\n(charges, payouts, and so forth).\n\nThe available and pending amounts for each currency are broken down further by\npayment source types.\n\nRelated guide: [Understanding Connect account balances](https://stripe.com/docs/connect/account-balances)"; readonly properties: { readonly available: { readonly description: "Available funds that you can transfer or pay out automatically by Stripe or explicitly through the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). You can find the available balance for each currency and payment type in the `source_types` property."; readonly items: { readonly $ref: "#/components/schemas/balance_amount"; }; readonly type: "array"; }; readonly connect_reserved: { readonly description: "Funds held due to negative balances on connected accounts where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property."; readonly items: { readonly $ref: "#/components/schemas/balance_amount"; }; readonly type: "array"; }; readonly instant_available: { readonly description: "Funds that you can pay out using Instant Payouts."; readonly items: { readonly $ref: "#/components/schemas/balance_amount_net"; }; readonly type: "array"; }; readonly issuing: { readonly $ref: "#/components/schemas/balance_detail"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["balance"]; readonly type: "string"; }; readonly pending: { readonly description: "Funds that aren't available in the balance yet. You can find the pending balance for each currency and each payment type in the `source_types` property."; readonly items: { readonly $ref: "#/components/schemas/balance_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["available", "livemode", "object", "pending"]; readonly title: "Balance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["available", "connect_reserved", "instant_available", "issuing", "pending"]; readonly 'x-resourceId': "balance"; }; export declare const balance_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Balance amount."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly source_types: { readonly $ref: "#/components/schemas/balance_amount_by_source_type"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "BalanceAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["source_types"]; }; export declare const balance_amount_by_source_typeSchema: { readonly description: ""; readonly properties: { readonly bank_account: { readonly description: "Amount for bank account."; readonly type: "integer"; }; readonly card: { readonly description: "Amount for card."; readonly type: "integer"; }; readonly fpx: { readonly description: "Amount for FPX."; readonly type: "integer"; }; }; readonly title: "BalanceAmountBySourceType"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const balance_amount_netSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Balance amount."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly net_available: { readonly description: "Breakdown of balance by destination."; readonly items: { readonly $ref: "#/components/schemas/balance_net_available"; }; readonly type: "array"; }; readonly source_types: { readonly $ref: "#/components/schemas/balance_amount_by_source_type"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "BalanceAmountNet"; readonly type: "object"; readonly 'x-expandableFields': readonly ["net_available", "source_types"]; }; export declare const balance_detailSchema: { readonly description: ""; readonly properties: { readonly available: { readonly description: "Funds that are available for use."; readonly items: { readonly $ref: "#/components/schemas/balance_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["available"]; readonly title: "BalanceDetail"; readonly type: "object"; readonly 'x-expandableFields': readonly ["available"]; }; export declare const balance_net_availableSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Net balance amount, subtracting fees from platform-set pricing."; readonly type: "integer"; }; readonly destination: { readonly description: "ID of the external account for this net balance (not expandable)."; readonly maxLength: 5000; readonly type: "string"; }; readonly source_types: { readonly $ref: "#/components/schemas/balance_amount_by_source_type"; }; }; readonly required: readonly ["amount", "destination"]; readonly title: "BalanceNetAvailable"; readonly type: "object"; readonly 'x-expandableFields': readonly ["source_types"]; }; export declare const balance_transactionSchema: { readonly 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://stripe.com/docs/reports/balance-transaction-types)"; readonly properties: { readonly amount: { readonly 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."; readonly type: "integer"; }; readonly available_on: { readonly description: "The date that the transaction's net funds become available in the Stripe balance."; readonly format: "unix-time"; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exchange_rate: { readonly 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`."; readonly nullable: true; readonly type: "number"; }; readonly fee: { readonly description: "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed."; readonly type: "integer"; }; readonly fee_details: { readonly description: "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction."; readonly items: { readonly $ref: "#/components/schemas/fee"; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly net: { readonly 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`"; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["balance_transaction"]; readonly type: "string"; }; readonly reporting_category: { readonly description: "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective."; readonly maxLength: 5000; readonly type: "string"; }; readonly source: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application_fee"; }, { readonly $ref: "#/components/schemas/charge"; }, { readonly $ref: "#/components/schemas/connect_collection_transfer"; }, { readonly $ref: "#/components/schemas/customer_cash_balance_transaction"; }, { readonly $ref: "#/components/schemas/dispute"; }, { readonly $ref: "#/components/schemas/fee_refund"; }, { readonly $ref: "#/components/schemas/issuing.authorization"; }, { readonly $ref: "#/components/schemas/issuing.dispute"; }, { readonly $ref: "#/components/schemas/issuing.transaction"; }, { readonly $ref: "#/components/schemas/payout"; }, { readonly $ref: "#/components/schemas/refund"; }, { readonly $ref: "#/components/schemas/reserve_transaction"; }, { readonly $ref: "#/components/schemas/tax_deducted_at_source"; }, { readonly $ref: "#/components/schemas/topup"; }, { readonly $ref: "#/components/schemas/transfer"; }, { readonly $ref: "#/components/schemas/transfer_reversal"; }]; readonly description: "This transaction relates to the Stripe object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application_fee"; }, { readonly $ref: "#/components/schemas/charge"; }, { readonly $ref: "#/components/schemas/connect_collection_transfer"; }, { readonly $ref: "#/components/schemas/customer_cash_balance_transaction"; }, { readonly $ref: "#/components/schemas/dispute"; }, { readonly $ref: "#/components/schemas/fee_refund"; }, { readonly $ref: "#/components/schemas/issuing.authorization"; }, { readonly $ref: "#/components/schemas/issuing.dispute"; }, { readonly $ref: "#/components/schemas/issuing.transaction"; }, { readonly $ref: "#/components/schemas/payout"; }, { readonly $ref: "#/components/schemas/refund"; }, { readonly $ref: "#/components/schemas/reserve_transaction"; }, { readonly $ref: "#/components/schemas/tax_deducted_at_source"; }, { readonly $ref: "#/components/schemas/topup"; }, { readonly $ref: "#/components/schemas/transfer"; }, { readonly $ref: "#/components/schemas/transfer_reversal"; }]; }; readonly 'x-stripeBypassValidation': true; }; readonly status: { readonly description: "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly 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`, `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`, `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 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."; readonly enum: readonly ["adjustment", "advance", "advance_funding", "anticipation_repayment", "application_fee", "application_fee_refund", "charge", "climate_order_purchase", "climate_order_refund", "connect_collection_transfer", "contribution", "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", "refund", "refund_failure", "reserve_transaction", "reserved_funds", "stripe_fee", "stripe_fx_fee", "tax_fee", "topup", "topup_reversal", "transfer", "transfer_cancel", "transfer_failure", "transfer_refund"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "available_on", "created", "currency", "fee", "fee_details", "id", "net", "object", "reporting_category", "status", "type"]; readonly title: "BalanceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["fee_details", "source"]; readonly 'x-resourceId': "balance_transaction"; }; export declare const bank_accountSchema: { readonly 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)"; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The ID of the account that the bank account is associated with."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly account_holder_name: { readonly description: "The name of the person or business that owns the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_holder_type: { readonly description: "The type of entity that holds the account. This can be either `individual` or `company`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "The bank account type. This can only be `checking` or `savings` in most countries. In Japan, this can only be `futsu` or `toza`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly available_payout_methods: { readonly 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."; readonly items: { readonly enum: readonly ["instant", "standard"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly bank_name: { readonly description: "Name of the bank associated with the routing number (e.g., `WELLS FARGO`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly type: "string"; }; readonly currency: { readonly description: "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer that the bank account is associated with."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly default_for_currency: { readonly description: "Whether this bank account is the default external account for its currency."; readonly nullable: true; readonly type: "boolean"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly future_requirements: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/external_account_requirements"; }]; readonly description: "Information about the [upcoming new requirements for the bank account](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the bank account number."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["bank_account"]; readonly type: "string"; }; readonly requirements: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/external_account_requirements"; }]; readonly description: "Information about the requirements for the bank account, including what information needs to be collected."; readonly nullable: true; }; readonly routing_number: { readonly description: "The routing transit number for the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a 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."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["country", "currency", "id", "last4", "object", "status"]; readonly title: "BankAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "customer", "future_requirements", "requirements"]; readonly 'x-resourceId': "bank_account"; }; export declare const bank_connections_resource_accountholderSchema: { readonly description: ""; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The ID of the Stripe account this account belongs to. Should only be present if `account_holder.type` is `account`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "ID of the Stripe customer this account belongs to. Present if and only if `account_holder.type` is `customer`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly type: { readonly description: "Type of account holder that this account belongs to."; readonly enum: readonly ["account", "customer"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "BankConnectionsResourceAccountholder"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "customer"]; }; export declare const bank_connections_resource_balanceSchema: { readonly description: ""; readonly properties: { readonly as_of: { readonly description: "The time that the external institution calculated this balance. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly cash: { readonly $ref: "#/components/schemas/bank_connections_resource_balance_api_resource_cash_balance"; }; readonly credit: { readonly $ref: "#/components/schemas/bank_connections_resource_balance_api_resource_credit_balance"; }; readonly current: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "The balances owed to (or 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."; readonly type: "object"; }; readonly type: { readonly description: "The `type` of the balance. An additional hash is included on the balance with a name matching this value."; readonly enum: readonly ["cash", "credit"]; readonly type: "string"; }; }; readonly required: readonly ["as_of", "current", "type"]; readonly title: "BankConnectionsResourceBalance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cash", "credit"]; }; export declare const bank_connections_resource_balance_api_resource_cash_balanceSchema: { readonly description: ""; readonly properties: { readonly available: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "The funds available to the account holder. Typically this is the current balance less any holds.\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."; readonly nullable: true; readonly type: "object"; }; }; readonly title: "BankConnectionsResourceBalanceAPIResourceCashBalance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_balance_api_resource_credit_balanceSchema: { readonly description: ""; readonly properties: { readonly used: { readonly additionalProperties: { readonly type: "integer"; }; readonly 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."; readonly nullable: true; readonly type: "object"; }; }; readonly title: "BankConnectionsResourceBalanceAPIResourceCreditBalance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_balance_refreshSchema: { readonly description: ""; readonly properties: { readonly last_attempted_at: { readonly description: "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly next_refresh_available_at: { readonly 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."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly status: { readonly description: "The status of the last refresh attempt."; readonly enum: readonly ["failed", "pending", "succeeded"]; readonly type: "string"; }; }; readonly required: readonly ["last_attempted_at", "status"]; readonly title: "BankConnectionsResourceBalanceRefresh"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_link_account_session_filtersSchema: { readonly description: ""; readonly properties: { readonly countries: { readonly description: "List of countries from which to filter accounts."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "BankConnectionsResourceLinkAccountSessionFilters"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_ownership_refreshSchema: { readonly description: ""; readonly properties: { readonly last_attempted_at: { readonly description: "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly next_refresh_available_at: { readonly 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."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly status: { readonly description: "The status of the last refresh attempt."; readonly enum: readonly ["failed", "pending", "succeeded"]; readonly type: "string"; }; }; readonly required: readonly ["last_attempted_at", "status"]; readonly title: "BankConnectionsResourceOwnershipRefresh"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_transaction_refreshSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last_attempted_at: { readonly description: "The time at which the last refresh attempt was initiated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly next_refresh_available_at: { readonly 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."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly status: { readonly description: "The status of the last refresh attempt."; readonly enum: readonly ["failed", "pending", "succeeded"]; readonly type: "string"; }; }; readonly required: readonly ["id", "last_attempted_at", "status"]; readonly title: "BankConnectionsResourceTransactionRefresh"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const bank_connections_resource_transaction_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly posted_at: { readonly description: "Time at which this transaction posted. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly void_at: { readonly description: "Time at which this transaction was voided. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "BankConnectionsResourceTransactionResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_meterSchema: { readonly description: "A billing meter is a resource that allows you to track usage of a particular event. For example, you might create a billing meter to track the number of API calls made by a particular user. You can then attach the billing meter to a price and attach the price to a subscription to charge the user for the number of API calls they make."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer_mapping: { readonly $ref: "#/components/schemas/billing_meter_resource_customer_mapping_settings"; }; readonly default_aggregation: { readonly $ref: "#/components/schemas/billing_meter_resource_aggregation_settings"; }; readonly display_name: { readonly description: "The meter's name."; readonly maxLength: 5000; readonly type: "string"; }; readonly event_name: { readonly description: "The name of the meter event to record usage for. Corresponds with the `event_name` field on meter events."; readonly maxLength: 5000; readonly type: "string"; }; readonly event_time_window: { readonly description: "The time window to pre-aggregate meter events for, if any."; readonly enum: readonly ["day", "hour"]; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing.meter"]; readonly type: "string"; }; readonly status: { readonly description: "The meter's status."; readonly enum: readonly ["active", "inactive"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/billing_meter_resource_billing_meter_status_transitions"; }; readonly updated: { readonly description: "Time at which the object was last updated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly value_settings: { readonly $ref: "#/components/schemas/billing_meter_resource_billing_meter_value"; }; }; readonly required: readonly ["created", "customer_mapping", "default_aggregation", "display_name", "event_name", "id", "livemode", "object", "status", "status_transitions", "updated", "value_settings"]; readonly title: "BillingMeter"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_mapping", "default_aggregation", "status_transitions", "value_settings"]; readonly 'x-resourceId': "billing.meter"; }; export declare const billing_meter_eventSchema: { readonly description: "A billing meter event represents a customer's usage of a product. Meter events are used to bill a customer based on their usage.\nMeter events are associated with billing meters, which define the shape of the event's payload and how those events are aggregated for billing."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly event_name: { readonly description: "The name of the meter event. Corresponds with the `event_name` field on a meter."; readonly maxLength: 100; readonly type: "string"; }; readonly identifier: { readonly description: "A unique identifier for the event."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing.meter_event"]; readonly type: "string"; }; readonly payload: { readonly additionalProperties: { readonly maxLength: 100; readonly type: "string"; }; readonly 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://stripe.com/docs/billing/subscriptions/usage-based/recording-usage#payload-key-overrides)."; readonly type: "object"; }; readonly timestamp: { readonly description: "The timestamp passed in when creating the event. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["created", "event_name", "identifier", "livemode", "object", "payload", "timestamp"]; readonly title: "BillingMeterEvent"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "billing.meter_event"; }; export declare const billing_meter_event_adjustmentSchema: { readonly 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."; readonly properties: { readonly cancel: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/billing_meter_resource_billing_meter_event_adjustment_cancel"; }]; readonly description: "Specifies which event to cancel."; readonly nullable: true; }; readonly event_name: { readonly description: "The name of the meter event. Corresponds with the `event_name` field on a meter."; readonly maxLength: 100; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing.meter_event_adjustment"]; readonly type: "string"; }; readonly status: { readonly description: "The meter event adjustment's status."; readonly enum: readonly ["complete", "pending"]; readonly type: "string"; }; readonly type: { readonly description: "Specifies whether to cancel a single event or a range of events for a time period. Time period cancellation is not supported yet."; readonly enum: readonly ["cancel"]; readonly type: "string"; }; }; readonly required: readonly ["event_name", "livemode", "object", "status", "type"]; readonly title: "BillingMeterEventAdjustment"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cancel"]; readonly 'x-resourceId': "billing.meter_event_adjustment"; }; export declare const billing_meter_event_summarySchema: { readonly 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."; readonly properties: { readonly aggregated_value: { readonly 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`."; readonly type: "number"; }; readonly end_time: { readonly description: "End timestamp for this event summary (inclusive)."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly meter: { readonly description: "The meter associated with this event summary."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing.meter_event_summary"]; readonly type: "string"; }; readonly start_time: { readonly description: "Start timestamp for this event summary (inclusive)."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["aggregated_value", "end_time", "id", "livemode", "meter", "object", "start_time"]; readonly title: "BillingMeterEventSummary"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "billing.meter_event_summary"; }; export declare const billing_detailsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Billing address."; readonly nullable: true; }; readonly email: { readonly description: "Email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Full name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly phone: { readonly description: "Billing phone number (including extension)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "billing_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const billing_meter_resource_aggregation_settingsSchema: { readonly description: ""; readonly properties: { readonly formula: { readonly description: "Specifies how events are aggregated."; readonly enum: readonly ["count", "sum"]; readonly type: "string"; }; }; readonly required: readonly ["formula"]; readonly title: "BillingMeterResourceAggregationSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_meter_resource_billing_meter_event_adjustment_cancelSchema: { readonly description: ""; readonly properties: { readonly identifier: { readonly description: "Unique identifier for the event."; readonly maxLength: 100; readonly nullable: true; readonly type: "string"; }; }; readonly title: "BillingMeterResourceBillingMeterEventAdjustmentCancel"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_meter_resource_billing_meter_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly deactivated_at: { readonly description: "The time the meter was deactivated, if any. Measured in seconds since Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "BillingMeterResourceBillingMeterStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_meter_resource_billing_meter_valueSchema: { readonly description: ""; readonly properties: { readonly event_payload_key: { readonly description: "The key in the meter event payload to use as the value for this meter."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["event_payload_key"]; readonly title: "BillingMeterResourceBillingMeterValue"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_meter_resource_customer_mapping_settingsSchema: { readonly description: ""; readonly properties: { readonly event_payload_key: { readonly description: "The key in the meter event payload to use for mapping the event to a customer."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "The method for mapping a meter event to a customer."; readonly enum: readonly ["by_id"]; readonly type: "string"; }; }; readonly required: readonly ["event_payload_key", "type"]; readonly title: "BillingMeterResourceCustomerMappingSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const billing_portal_configurationSchema: { readonly description: "A portal configuration describes the functionality and behavior of a portal session."; readonly properties: { readonly active: { readonly description: "Whether the configuration is active and can be used to create portal sessions."; readonly type: "boolean"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "ID of the Connect Application that created the configuration."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly business_profile: { readonly $ref: "#/components/schemas/portal_business_profile"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly default_return_url: { readonly description: "The default URL to redirect customers to when they click on the portal's link to return to your website. This can be [overriden](https://stripe.com/docs/api/customer_portal/sessions/create#create_portal_session-return_url) when creating the session."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly features: { readonly $ref: "#/components/schemas/portal_features"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly is_default: { readonly description: "Whether the configuration is the default. If `true`, this configuration can be managed in the Dashboard and portal sessions will use this configuration unless it is overriden when creating the session."; readonly type: "boolean"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly login_page: { readonly $ref: "#/components/schemas/portal_login_page"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing_portal.configuration"]; readonly type: "string"; }; readonly updated: { readonly description: "Time at which the object was last updated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["active", "business_profile", "created", "features", "id", "is_default", "livemode", "login_page", "object", "updated"]; readonly title: "PortalConfiguration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "business_profile", "features", "login_page"]; readonly 'x-resourceId': "billing_portal.configuration"; }; export declare const billing_portal_sessionSchema: { readonly description: "The Billing customer portal is a Stripe-hosted UI for subscription and\nbilling management.\n\nA portal configuration describes the functionality and features that you\nwant to provide to your customers through the portal.\n\nA portal session describes the instantiation of the customer portal for\na particular customer. By visiting the session's URL, the customer\ncan manage their subscriptions and billing details. For security reasons,\nsessions are short-lived and will expire if the customer does not visit the URL.\nCreate sessions on-demand when customers intend to manage their subscriptions\nand billing details.\n\nLearn more in the [integration guide](https://stripe.com/docs/billing/subscriptions/integrating-customer-portal)."; readonly properties: { readonly configuration: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/billing_portal.configuration"; }]; readonly description: "The configuration used by this session, describing the features available."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/billing_portal.configuration"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly description: "The ID of the customer for this session."; readonly maxLength: 5000; readonly type: "string"; }; readonly flow: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_flow"; }]; readonly description: "Information about a specific flow for the customer to go through. See the [docs](https://stripe.com/docs/customer-management/portal-deep-links) to learn more about using customer portal deep links and flows."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly locale: { readonly description: "The IETF language tag of the locale Customer Portal is displayed in. If blank or auto, the customer’s `preferred_locales` or browser’s locale is used."; readonly enum: readonly ["auto", "bg", "cs", "da", "de", "el", "en", "en-AU", "en-CA", "en-GB", "en-IE", "en-IN", "en-NZ", "en-SG", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW"]; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["billing_portal.session"]; readonly type: "string"; }; readonly on_behalf_of: { readonly description: "The account for which the session was created on behalf of. When specified, only subscriptions and invoices with this `on_behalf_of` account appear in the portal. For more information, see the [docs](https://stripe.com/docs/connect/separate-charges-and-transfers#settlement-merchant). Use the [Accounts API](https://stripe.com/docs/api/accounts/object#account_object-settings-branding) to modify the `on_behalf_of` account's branding settings, which the portal displays."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly return_url: { readonly description: "The URL to redirect customers to when they click on the portal's link to return to your website."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The short-lived URL of the session that gives customers access to the customer portal."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["configuration", "created", "customer", "id", "livemode", "object", "url"]; readonly title: "PortalSession"; readonly type: "object"; readonly 'x-expandableFields': readonly ["configuration", "flow"]; readonly 'x-resourceId': "billing_portal.session"; }; export declare const cancellation_detailsSchema: { readonly description: ""; readonly properties: { readonly comment: { readonly description: "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly feedback: { readonly description: "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user."; readonly enum: readonly ["customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "Why this subscription was canceled."; readonly enum: readonly ["cancellation_requested", "payment_disputed", "payment_failed"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CancellationDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const capabilitySchema: { readonly description: "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)"; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account for which the capability enables functionality."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly future_requirements: { readonly $ref: "#/components/schemas/account_capability_future_requirements"; }; readonly id: { readonly description: "The identifier for the capability."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["capability"]; readonly type: "string"; }; readonly requested: { readonly description: "Whether the capability has been requested."; readonly type: "boolean"; }; readonly requested_at: { readonly description: "Time at which the capability was requested. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly requirements: { readonly $ref: "#/components/schemas/account_capability_requirements"; }; readonly status: { readonly description: "The status of the capability. Can be `active`, `inactive`, `pending`, or `unrequested`."; readonly enum: readonly ["active", "disabled", "inactive", "pending", "unrequested"]; readonly type: "string"; }; }; readonly required: readonly ["account", "id", "object", "requested", "status"]; readonly title: "AccountCapability"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "future_requirements", "requirements"]; readonly 'x-resourceId': "capability"; }; export declare const cardSchema: { readonly description: "You can store multiple cards on a customer in order to charge the customer\nlater. You can also store multiple debit cards on a recipient in order to\ntransfer to those cards later.\n\nRelated guide: [Card payments with Sources](https://stripe.com/docs/sources/cards)"; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account this card belongs to. This attribute will not be in the card object if the card belongs to a customer or recipient instead. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly address_city: { readonly description: "City/District/Suburb/Town/Village."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_country: { readonly description: "Billing address country, if provided when creating card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_line1: { readonly description: "Address line 1 (Street address/PO Box/Company name)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_line1_check: { readonly description: "If `address_line1` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_line2: { readonly description: "Address line 2 (Apartment/Suite/Unit/Building)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_state: { readonly description: "State/County/Province/Region."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_zip: { readonly description: "ZIP or postal code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_zip_check: { readonly description: "If `address_zip` was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly available_payout_methods: { readonly description: "A set of available payout methods for this card. Only values from this set should be passed as the `method` when creating a payout."; readonly items: { readonly enum: readonly ["instant", "standard"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly brand: { readonly description: "Card brand. Can be `American Express`, `Diners Club`, `Discover`, `Eftpos Australia`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly currency: { readonly description: "Three-letter [ISO code for currency](https://stripe.com/docs/payouts). Only applicable on accounts (not customers or recipients). The card can be used as a transfer destination for funds in this currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts."; readonly nullable: true; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The customer that this card belongs to. This attribute will not be in the card object if the card belongs to an account or recipient instead."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly cvc_check: { readonly description: "If a CVC was provided, results of the check: `pass`, `fail`, `unavailable`, or `unchecked`. A result of unchecked indicates that CVC was provided but hasn't been checked yet. Checks are typically performed when attaching a card to a Customer object, or when creating a charge. For more details, see [Check if a card is valid without a charge](https://support.stripe.com/questions/check-if-a-card-is-valid-without-a-charge)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly default_for_currency: { readonly description: "Whether this card is the default external account for its currency. This property is only available for accounts where [controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `application`, which includes Custom accounts."; readonly nullable: true; readonly type: "boolean"; }; readonly dynamic_last4: { readonly description: "(For tokenized numbers only.) The last four digits of the device account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly name: { readonly description: "Cardholder name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly networks: { readonly $ref: "#/components/schemas/token_card_networks"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["card"]; readonly type: "string"; }; readonly status: { readonly description: "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tokenization_method: { readonly description: "If the card number is tokenized, this is the method that was used. Can be `android_pay` (includes Google Pay), `apple_pay`, `masterpass`, `visa_checkout`, or null."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["brand", "exp_month", "exp_year", "funding", "id", "last4", "object"]; readonly title: "Card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "customer", "networks"]; readonly 'x-resourceId': "card"; }; export declare const card_generated_from_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly card_present: { readonly $ref: "#/components/schemas/payment_method_details_card_present"; }; readonly type: { readonly description: "The type of payment method transaction-specific details from the transaction that generated this `card` payment method. Always `card_present`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "card_generated_from_payment_method_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card_present"]; }; export declare const card_issuing_account_terms_of_serviceSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the account representative accepted the service agreement."; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the account representative accepted the service agreement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the account representative accepted the service agreement."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "CardIssuingAccountTermsOfService"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const card_mandate_payment_method_detailsSchema: { readonly description: ""; readonly properties: {}; readonly title: "card_mandate_payment_method_details"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const cash_balanceSchema: { readonly description: "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account."; readonly properties: { readonly available: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "A hash of all cash balances available to this customer. You cannot delete a customer with any cash balances, even if the balance is 0. Amounts are represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; readonly type: "object"; }; readonly customer: { readonly description: "The ID of the customer whose cash balance this object represents."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["cash_balance"]; readonly type: "string"; }; readonly settings: { readonly $ref: "#/components/schemas/customer_balance_customer_balance_settings"; }; }; readonly required: readonly ["customer", "livemode", "object", "settings"]; readonly title: "cash_balance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["settings"]; readonly 'x-resourceId': "cash_balance"; }; export declare const chargeSchema: { readonly description: "The `Charge` object represents a single attempt to move money into your Stripe account.\nPaymentIntent confirmation is the most common way to create Charges, but transferring\nmoney to a different Stripe account through Connect also creates Charges.\nSome legacy payment flows create Charges directly, which is not recommended for new integrations."; readonly properties: { readonly amount: { readonly description: "Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."; readonly type: "integer"; }; readonly amount_captured: { readonly description: "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made)."; readonly type: "integer"; }; readonly amount_refunded: { readonly description: "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued)."; readonly type: "integer"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "ID of the Connect application that created the charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly application_fee: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application_fee"; }]; readonly description: "The application fee (if any) for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application_fee"; }]; }; }; readonly application_fee_amount: { readonly description: "The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://stripe.com/docs/connect/direct-charges#collect-fees) for details."; readonly nullable: true; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes)."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly billing_details: { readonly $ref: "#/components/schemas/billing_details"; }; readonly calculated_statement_descriptor: { readonly description: "The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly captured: { readonly description: "If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the customer this charge is for if one exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 40000; readonly nullable: true; readonly type: "string"; }; readonly disputed: { readonly description: "Whether the charge has been disputed."; readonly type: "boolean"; }; readonly failure_balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "ID of the balance transaction that describes the reversal of the balance on your account due to payment failure."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly failure_code: { readonly description: "Error code explaining reason for charge failure if available (see [the errors section](https://stripe.com/docs/error-codes) for a list of codes)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly failure_message: { readonly description: "Message to user further explaining reason for charge failure if available."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fraud_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/charge_fraud_details"; }]; readonly description: "Information on fraud assessments for the charge."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "ID of the invoice this charge is for if one exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["charge"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly outcome: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/charge_outcome"; }]; readonly description: "Details about whether the payment was accepted, and why. See [understanding declines](https://stripe.com/docs/declines) for details."; readonly nullable: true; }; readonly paid: { readonly description: "`true` if the charge succeeded, or was successfully authorized for later capture."; readonly type: "boolean"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "ID of the PaymentIntent associated with this charge, if one exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly payment_method: { readonly description: "ID of the payment method used in this charge."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_method_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details"; }]; readonly description: "Details about the payment method at the time of the transaction."; readonly nullable: true; }; readonly radar_options: { readonly $ref: "#/components/schemas/radar_radar_options"; }; readonly receipt_email: { readonly description: "This is the email address that the receipt for this charge was sent to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly receipt_number: { readonly description: "This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly receipt_url: { readonly description: "This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly refunded: { readonly description: "Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false."; readonly type: "boolean"; }; readonly refunds: { readonly description: "A list of refunds that have been applied to the charge."; readonly nullable: true; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/refund"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "RefundList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly review: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/review"; }]; readonly description: "ID of the review associated with this charge if one exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/review"; }]; }; }; readonly shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "Shipping information for the charge."; readonly nullable: true; }; readonly source_transfer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/transfer"; }]; readonly description: "The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/transfer"; }]; }; }; readonly statement_descriptor: { readonly description: "For card charges, use `statement_descriptor_suffix` instead. Otherwise, you can use this value as the complete description of a charge on your customers’ statements. Must contain at least one letter, maximum 22 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_suffix: { readonly description: "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "The status of the payment is either `succeeded`, `pending`, or `failed`."; readonly enum: readonly ["failed", "pending", "succeeded"]; readonly type: "string"; }; readonly transfer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/transfer"; }]; readonly description: "ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter)."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/transfer"; }]; }; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/charge_transfer_data"; }]; readonly description: "An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://stripe.com/docs/connect/destination-charges) for details."; readonly nullable: true; }; readonly transfer_group: { readonly description: "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_captured", "amount_refunded", "billing_details", "captured", "created", "currency", "disputed", "id", "livemode", "metadata", "object", "paid", "refunded", "status"]; readonly title: "Charge"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "application_fee", "balance_transaction", "billing_details", "customer", "failure_balance_transaction", "fraud_details", "invoice", "on_behalf_of", "outcome", "payment_intent", "payment_method_details", "radar_options", "refunds", "review", "shipping", "source_transfer", "transfer", "transfer_data"]; readonly 'x-resourceId': "charge"; }; export declare const charge_fraud_detailsSchema: { readonly description: ""; readonly properties: { readonly stripe_report: { readonly description: "Assessments from Stripe. If set, the value is `fraudulent`."; readonly maxLength: 5000; readonly type: "string"; }; readonly user_report: { readonly description: "Assessments reported by you. If set, possible values of are `safe` and `fraudulent`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "ChargeFraudDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const charge_outcomeSchema: { readonly description: ""; readonly properties: { readonly network_status: { readonly description: "Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://stripe.com/docs/declines#blocked-payments) after bank authorization, and may temporarily appear as \"pending\" on a cardholder's statement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://stripe.com/docs/declines) for more details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly risk_level: { readonly description: "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar."; readonly maxLength: 5000; readonly type: "string"; }; readonly risk_score: { readonly description: "Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams."; readonly type: "integer"; }; readonly rule: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/rule"; }]; readonly description: "The ID of the Radar rule that matched the payment, if applicable."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/rule"; }]; }; }; readonly seller_message: { readonly description: "A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://stripe.com/docs/declines) and [Radar reviews](https://stripe.com/docs/radar/reviews) for details."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "ChargeOutcome"; readonly type: "object"; readonly 'x-expandableFields': readonly ["rule"]; }; export declare const charge_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount transferred to the destination account, if specified. By default, the entire charge amount is transferred to the destination account."; readonly nullable: true; readonly type: "integer"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "ChargeTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const checkout_sessionSchema: { readonly description: "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)"; readonly properties: { readonly after_expiration: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_after_expiration"; }]; readonly description: "When set, provides configuration for actions to take if this Checkout Session expires."; readonly nullable: true; }; readonly allow_promotion_codes: { readonly description: "Enables user redeemable promotion codes."; readonly nullable: true; readonly type: "boolean"; }; readonly amount_subtotal: { readonly description: "Total of all items before discounts or taxes are applied."; readonly nullable: true; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total of all items after discounts and taxes are applied."; readonly nullable: true; readonly type: "integer"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_automatic_tax"; }; readonly billing_address_collection: { readonly description: "Describes whether Checkout should collect the customer's billing address. Defaults to `auto`."; readonly enum: readonly ["auto", "required"]; readonly nullable: true; readonly type: "string"; }; readonly cancel_url: { readonly description: "If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly client_reference_id: { readonly description: "A unique string to reference the Checkout Session. This can be a\ncustomer ID, a cart ID, or similar, and can be used to reconcile the\nSession with your internal systems."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly client_secret: { readonly description: "Client secret to be used when initializing Stripe.js embedded checkout."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly consent: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_consent"; }]; readonly description: "Results of `consent_collection` for this session."; readonly nullable: true; }; readonly consent_collection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_consent_collection"; }]; readonly description: "When set, provides configuration for the Checkout Session to gather active consent from customers."; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly nullable: true; readonly type: "string"; }; readonly currency_conversion: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_currency_conversion"; }]; readonly description: "Currency conversion details for automatic currency conversion sessions"; readonly nullable: true; }; readonly custom_fields: { readonly description: "Collect additional information from your customer using custom fields. Up to 3 fields are supported."; readonly items: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields"; }; readonly type: "array"; }; readonly custom_text: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_text"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer for this Session.\nFor Checkout Sessions in `subscription` mode or Checkout Sessions with `customer_creation` set as `always` in `payment` mode, Checkout\nwill create a new customer object based on information provided\nduring the payment flow unless an existing customer was provided when\nthe Session was created."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly customer_creation: { readonly description: "Configure whether a Checkout Session creates a Customer when the Checkout Session completes."; readonly enum: readonly ["always", "if_required"]; readonly nullable: true; readonly type: "string"; }; readonly customer_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_customer_details"; }]; readonly description: "The customer details including the customer's tax exempt status and the customer's tax IDs. Customer's address details are not present on Sessions in `setup` mode."; readonly nullable: true; }; readonly customer_email: { readonly description: "If provided, this value will be used when the Customer object is created.\nIf not provided, customers will be asked to enter their email address.\nUse this parameter to prefill customer data if you already have an email\non file. To access information about the customer once the payment flow is\ncomplete, use the `customer` attribute."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly expires_at: { readonly description: "The timestamp at which the Checkout Session will expire."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "ID of the invoice created by the Checkout Session, if it exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly invoice_creation: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_invoice_creation"; }]; readonly description: "Details on the state of invoice creation for the Checkout Session."; readonly nullable: true; }; readonly line_items: { readonly description: "The line items purchased by the customer."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "PaymentPagesCheckoutSessionListLineItems"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly locale: { readonly description: "The IETF language tag of the locale Checkout is displayed in. If blank or `auto`, the browser's locale is used."; readonly enum: readonly ["auto", "bg", "cs", "da", "de", "el", "en", "en-GB", "es", "es-419", "et", "fi", "fil", "fr", "fr-CA", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "mt", "nb", "nl", "pl", "pt", "pt-BR", "ro", "ru", "sk", "sl", "sv", "th", "tr", "vi", "zh", "zh-HK", "zh-TW"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly mode: { readonly description: "The mode of the Checkout Session."; readonly enum: readonly ["payment", "setup", "subscription"]; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["checkout.session"]; readonly type: "string"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "The ID of the PaymentIntent for Checkout Sessions in `payment` mode. You can't confirm or cancel the PaymentIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly payment_link: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_link"; }]; readonly description: "The ID of the Payment Link that created this Session."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_link"; }]; }; }; readonly payment_method_collection: { readonly description: "Configure whether a Checkout Session should collect a payment method. Defaults to `always`."; readonly enum: readonly ["always", "if_required"]; readonly nullable: true; readonly type: "string"; }; readonly payment_method_configuration_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"; }]; readonly description: "Information about the payment method configuration used for this Checkout session if using dynamic payment methods."; readonly nullable: true; }; readonly payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/checkout_session_payment_method_options"; }]; readonly description: "Payment-method-specific configuration for the PaymentIntent or SetupIntent of this CheckoutSession."; readonly nullable: true; }; readonly payment_method_types: { readonly description: "A list of the types of payment methods (e.g. card) this Checkout\nSession is allowed to accept."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly payment_status: { readonly description: "The payment status of the Checkout Session, one of `paid`, `unpaid`, or `no_payment_required`.\nYou can use this value to decide when to fulfill your customer's order."; readonly enum: readonly ["no_payment_required", "paid", "unpaid"]; readonly type: "string"; }; readonly phone_number_collection: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_phone_number_collection"; }; readonly recovered_from: { readonly description: "The ID of the original expired Checkout Session that triggered the recovery flow."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly redirect_on_completion: { readonly description: "This parameter applies to `ui_mode: embedded`. Learn more about the [redirect behavior](https://stripe.com/docs/payments/checkout/custom-redirect-behavior) of embedded sessions. Defaults to `always`."; readonly enum: readonly ["always", "if_required", "never"]; readonly type: "string"; }; readonly return_url: { readonly description: "Applies to Checkout Sessions with `ui_mode: embedded`. The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site."; readonly maxLength: 5000; readonly type: "string"; }; readonly saved_payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_saved_payment_method_options"; }]; readonly description: "Controls saved payment method settings for the session. Only available in `payment` and `subscription` mode."; readonly nullable: true; }; readonly setup_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_intent"; }]; readonly description: "The ID of the SetupIntent for Checkout Sessions in `setup` mode. You can't confirm or cancel the SetupIntent for a Checkout Session. To cancel, [expire the Checkout Session](https://stripe.com/docs/api/checkout/sessions/expire) instead."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent"; }]; }; }; readonly shipping_address_collection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_shipping_address_collection"; }]; readonly description: "When set, provides configuration for Checkout to collect a shipping address from a customer."; readonly nullable: true; }; readonly shipping_cost: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_shipping_cost"; }]; readonly description: "The details of the customer cost of shipping, including the customer chosen ShippingRate."; readonly nullable: true; }; readonly shipping_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "Shipping information for this Checkout Session."; readonly nullable: true; }; readonly shipping_options: { readonly description: "The shipping rate options applied to this Session."; readonly items: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_shipping_option"; }; readonly type: "array"; }; readonly status: { readonly description: "The status of the Checkout Session, one of `open`, `complete`, or `expired`."; readonly enum: readonly ["complete", "expired", "open"]; readonly nullable: true; readonly type: "string"; }; readonly submit_type: { readonly description: "Describes the type of transaction being performed by Checkout in order to customize\nrelevant text on the page, such as the submit button. `submit_type` can only be\nspecified on Checkout Sessions in `payment` mode. If blank or `auto`, `pay` is used."; readonly enum: readonly ["auto", "book", "donate", "pay"]; readonly nullable: true; readonly type: "string"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "The ID of the subscription for Checkout Sessions in `subscription` mode."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly success_url: { readonly description: "The URL the customer will be directed to after the payment or\nsubscription creation is successful."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_id_collection: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_tax_id_collection"; }; readonly total_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_total_details"; }]; readonly description: "Tax and discount details for the computed total amount."; readonly nullable: true; }; readonly ui_mode: { readonly description: "The UI mode of the Session. Defaults to `hosted`."; readonly enum: readonly ["embedded", "hosted"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly url: { readonly description: "The URL to the Checkout Session. Redirect customers to this URL to take them to Checkout. If you’re using [Custom Domains](https://stripe.com/docs/payments/checkout/custom-domains), the URL will use your subdomain. Otherwise, it’ll use `checkout.stripe.com.`\nThis value is only present when the session is active."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["automatic_tax", "created", "custom_fields", "custom_text", "expires_at", "id", "livemode", "mode", "object", "payment_method_types", "payment_status", "shipping_options"]; readonly title: "Session"; readonly type: "object"; readonly 'x-expandableFields': readonly ["after_expiration", "automatic_tax", "consent", "consent_collection", "currency_conversion", "custom_fields", "custom_text", "customer", "customer_details", "invoice", "invoice_creation", "line_items", "payment_intent", "payment_link", "payment_method_configuration_details", "payment_method_options", "phone_number_collection", "saved_payment_method_options", "setup_intent", "shipping_address_collection", "shipping_cost", "shipping_details", "shipping_options", "subscription", "tax_id_collection", "total_details"]; readonly 'x-resourceId': "checkout.session"; }; export declare const checkout_acss_debit_mandate_optionsSchema: { readonly description: ""; readonly properties: { readonly custom_mandate_url: { readonly description: "A URL for custom mandate text"; readonly maxLength: 5000; readonly type: "string"; }; readonly default_for: { readonly description: "List of Stripe products where this mandate can be selected automatically. Returned when the Session is in `setup` mode."; readonly items: { readonly enum: readonly ["invoice", "subscription"]; readonly type: "string"; }; readonly type: "array"; }; readonly interval_description: { readonly description: "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_schedule: { readonly description: "Payment schedule for the mandate."; readonly enum: readonly ["combined", "interval", "sporadic"]; readonly nullable: true; readonly type: "string"; }; readonly transaction_type: { readonly description: "Transaction type of the mandate."; readonly enum: readonly ["business", "personal"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CheckoutAcssDebitMandateOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_acss_debit_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly currency: { readonly description: "Currency supported by the bank account. Returned when the Session is in `setup` mode."; readonly enum: readonly ["cad", "usd"]; readonly type: "string"; }; readonly mandate_options: { readonly $ref: "#/components/schemas/checkout_acss_debit_mandate_options"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "CheckoutAcssDebitPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const checkout_affirm_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutAffirmPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_afterpay_clearpay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutAfterpayClearpayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_alipay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutAlipayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_amazon_pay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "CheckoutAmazonPayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_au_becs_debit_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutAuBecsDebitPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_bacs_debit_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "CheckoutBacsDebitPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_bancontact_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutBancontactPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_boleto_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly expires_after_days: { readonly description: "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly required: readonly ["expires_after_days"]; readonly title: "CheckoutBoletoPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_card_installments_optionsSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates if installments are enabled"; readonly type: "boolean"; }; }; readonly title: "CheckoutCardInstallmentsOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_card_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly installments: { readonly $ref: "#/components/schemas/checkout_card_installments_options"; }; readonly request_three_d_secure: { readonly description: "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."; readonly enum: readonly ["any", "automatic", "challenge"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly statement_descriptor_suffix_kana: { readonly description: "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly statement_descriptor_suffix_kanji: { readonly description: "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["request_three_d_secure"]; readonly title: "CheckoutCardPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["installments"]; }; export declare const checkout_cashapp_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutCashappPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_customer_balance_bank_transfer_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly eu_bank_transfer: { readonly $ref: "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"; }; readonly requested_address_types: { readonly description: "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`."; readonly items: { readonly enum: readonly ["aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly type: { readonly description: "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."; readonly enum: readonly ["eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "CheckoutCustomerBalanceBankTransferPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["eu_bank_transfer"]; }; export declare const checkout_customer_balance_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly bank_transfer: { readonly $ref: "#/components/schemas/checkout_customer_balance_bank_transfer_payment_method_options"; }; readonly funding_type: { readonly description: "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."; readonly enum: readonly ["bank_transfer"]; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutCustomerBalancePaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_transfer"]; }; export declare const checkout_eps_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutEpsPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_fpx_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutFpxPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_giropay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutGiropayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_grab_pay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutGrabPayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_ideal_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutIdealPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_klarna_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "CheckoutKlarnaPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_konbini_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly expires_after_days: { readonly description: "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."; readonly nullable: true; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutKonbiniPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_link_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "CheckoutLinkPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_mobilepay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutMobilepayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_multibanco_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutMultibancoPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_oxxo_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly expires_after_days: { readonly description: "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly required: readonly ["expires_after_days"]; readonly title: "CheckoutOxxoPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_p24_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutP24PaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_paynow_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutPaynowPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_paypal_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly preferred_locale: { readonly description: "Preferred locale of the PayPal checkout page that the customer is redirected to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "CheckoutPaypalPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_pix_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly expires_after_seconds: { readonly description: "The number of seconds after which Pix payment will expire."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "CheckoutPixPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_revolut_pay_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "CheckoutRevolutPayPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_sepa_debit_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "CheckoutSepaDebitPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_session_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/checkout_acss_debit_payment_method_options"; }; readonly affirm: { readonly $ref: "#/components/schemas/checkout_affirm_payment_method_options"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/checkout_afterpay_clearpay_payment_method_options"; }; readonly alipay: { readonly $ref: "#/components/schemas/checkout_alipay_payment_method_options"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/checkout_amazon_pay_payment_method_options"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/checkout_au_becs_debit_payment_method_options"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/checkout_bacs_debit_payment_method_options"; }; readonly bancontact: { readonly $ref: "#/components/schemas/checkout_bancontact_payment_method_options"; }; readonly boleto: { readonly $ref: "#/components/schemas/checkout_boleto_payment_method_options"; }; readonly card: { readonly $ref: "#/components/schemas/checkout_card_payment_method_options"; }; readonly cashapp: { readonly $ref: "#/components/schemas/checkout_cashapp_payment_method_options"; }; readonly customer_balance: { readonly $ref: "#/components/schemas/checkout_customer_balance_payment_method_options"; }; readonly eps: { readonly $ref: "#/components/schemas/checkout_eps_payment_method_options"; }; readonly fpx: { readonly $ref: "#/components/schemas/checkout_fpx_payment_method_options"; }; readonly giropay: { readonly $ref: "#/components/schemas/checkout_giropay_payment_method_options"; }; readonly grabpay: { readonly $ref: "#/components/schemas/checkout_grab_pay_payment_method_options"; }; readonly ideal: { readonly $ref: "#/components/schemas/checkout_ideal_payment_method_options"; }; readonly klarna: { readonly $ref: "#/components/schemas/checkout_klarna_payment_method_options"; }; readonly konbini: { readonly $ref: "#/components/schemas/checkout_konbini_payment_method_options"; }; readonly link: { readonly $ref: "#/components/schemas/checkout_link_payment_method_options"; }; readonly mobilepay: { readonly $ref: "#/components/schemas/checkout_mobilepay_payment_method_options"; }; readonly multibanco: { readonly $ref: "#/components/schemas/checkout_multibanco_payment_method_options"; }; readonly oxxo: { readonly $ref: "#/components/schemas/checkout_oxxo_payment_method_options"; }; readonly p24: { readonly $ref: "#/components/schemas/checkout_p24_payment_method_options"; }; readonly paynow: { readonly $ref: "#/components/schemas/checkout_paynow_payment_method_options"; }; readonly paypal: { readonly $ref: "#/components/schemas/checkout_paypal_payment_method_options"; }; readonly pix: { readonly $ref: "#/components/schemas/checkout_pix_payment_method_options"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/checkout_revolut_pay_payment_method_options"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/checkout_sepa_debit_payment_method_options"; }; readonly sofort: { readonly $ref: "#/components/schemas/checkout_sofort_payment_method_options"; }; readonly swish: { readonly $ref: "#/components/schemas/checkout_swish_payment_method_options"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/checkout_us_bank_account_payment_method_options"; }; }; readonly title: "CheckoutSessionPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "revolut_pay", "sepa_debit", "sofort", "swish", "us_bank_account"]; }; export declare const checkout_sofort_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "CheckoutSofortPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_swish_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "The order reference that will be displayed to customers in the Swish application. Defaults to the `id` of the Payment Intent."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CheckoutSwishPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const checkout_us_bank_account_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly financial_connections: { readonly $ref: "#/components/schemas/linked_account_options_us_bank_account"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "CheckoutUsBankAccountPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_connections"]; }; export declare const climate_orderSchema: { readonly description: "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance."; readonly properties: { readonly amount_fees: { readonly description: "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit."; readonly type: "integer"; }; readonly amount_subtotal: { readonly description: "Total amount of the carbon removal in the currency's smallest unit."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total amount of the order including fees in the currency's smallest unit."; readonly type: "integer"; }; readonly beneficiary: { readonly $ref: "#/components/schemas/climate_removals_beneficiary"; }; readonly canceled_at: { readonly description: "Time at which the order was canceled. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancellation_reason: { readonly description: "Reason for the cancellation of this order."; readonly enum: readonly ["expired", "product_unavailable", "requested"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly certificate: { readonly description: "For delivered orders, a URL to a delivery certificate for the order."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly confirmed_at: { readonly description: "Time at which the order was confirmed. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order."; readonly maxLength: 5000; readonly type: "string"; }; readonly delayed_at: { readonly description: "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly delivered_at: { readonly description: "Time at which the order was delivered. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly delivery_details: { readonly description: "Details about the delivery of carbon removal for this order."; readonly items: { readonly $ref: "#/components/schemas/climate_removals_order_deliveries"; }; readonly type: "array"; }; readonly expected_delivery_year: { readonly description: "The year this order is expected to be delivered."; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly metric_tons: { readonly description: "Quantity of carbon removal that is included in this order."; readonly format: "decimal"; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["climate.order"]; readonly type: "string"; }; readonly product: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/climate.product"; }]; readonly description: "Unique ID for the Climate `Product` this order is purchasing."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/climate.product"; }]; }; }; readonly product_substituted_at: { readonly description: "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly status: { readonly description: "The current status of this order."; readonly enum: readonly ["awaiting_funds", "canceled", "confirmed", "delivered", "open"]; readonly type: "string"; }; }; readonly required: readonly ["amount_fees", "amount_subtotal", "amount_total", "created", "currency", "delivery_details", "expected_delivery_year", "id", "livemode", "metadata", "metric_tons", "object", "product", "status"]; readonly title: "ClimateRemovalsOrders"; readonly type: "object"; readonly 'x-expandableFields': readonly ["beneficiary", "delivery_details", "product"]; readonly 'x-resourceId': "climate.order"; }; export declare const climate_productSchema: { readonly description: "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly current_prices_per_metric_ton: { readonly additionalProperties: { readonly $ref: "#/components/schemas/climate_removals_products_price"; }; readonly description: "Current prices for a metric ton of carbon removal in a currency's smallest unit."; readonly type: "object"; }; readonly delivery_year: { readonly description: "The year in which the carbon removal is expected to be delivered."; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metric_tons_available: { readonly description: "The quantity of metric tons available for reservation."; readonly format: "decimal"; readonly type: "string"; }; readonly name: { readonly description: "The Climate product's name."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["climate.product"]; readonly type: "string"; }; readonly suppliers: { readonly description: "The carbon removal suppliers that fulfill orders for this Climate product."; readonly items: { readonly $ref: "#/components/schemas/climate.supplier"; }; readonly type: "array"; }; }; readonly required: readonly ["created", "current_prices_per_metric_ton", "id", "livemode", "metric_tons_available", "name", "object", "suppliers"]; readonly title: "ClimateRemovalsProducts"; readonly type: "object"; readonly 'x-expandableFields': readonly ["current_prices_per_metric_ton", "suppliers"]; readonly 'x-resourceId': "climate.product"; }; export declare const climate_supplierSchema: { readonly description: "A supplier of carbon removal."; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly info_url: { readonly description: "Link to a webpage to learn more about the supplier."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly locations: { readonly description: "The locations in which this supplier operates."; readonly items: { readonly $ref: "#/components/schemas/climate_removals_location"; }; readonly type: "array"; }; readonly name: { readonly description: "Name of this carbon removal supplier."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object’s type. Objects of the same type share the same value."; readonly enum: readonly ["climate.supplier"]; readonly type: "string"; }; readonly removal_pathway: { readonly description: "The scientific pathway used for carbon removal."; readonly enum: readonly ["biomass_carbon_removal_and_storage", "direct_air_capture", "enhanced_weathering"]; readonly type: "string"; }; }; readonly required: readonly ["id", "info_url", "livemode", "locations", "name", "object", "removal_pathway"]; readonly title: "ClimateRemovalsSuppliers"; readonly type: "object"; readonly 'x-expandableFields': readonly ["locations"]; readonly 'x-resourceId': "climate.supplier"; }; export declare const climate_removals_beneficiarySchema: { readonly description: ""; readonly properties: { readonly public_name: { readonly description: "Publicly displayable name for the end beneficiary of carbon removal."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["public_name"]; readonly title: "ClimateRemovalsBeneficiary"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const climate_removals_locationSchema: { readonly description: ""; readonly properties: { readonly city: { readonly description: "The city where the supplier is located."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country where the supplier is located."; readonly maxLength: 5000; readonly type: "string"; }; readonly latitude: { readonly description: "The geographic latitude where the supplier is located."; readonly nullable: true; readonly type: "number"; }; readonly longitude: { readonly description: "The geographic longitude where the supplier is located."; readonly nullable: true; readonly type: "number"; }; readonly region: { readonly description: "The state/county/province/region where the supplier is located."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["country"]; readonly title: "ClimateRemovalsLocation"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const climate_removals_order_deliveriesSchema: { readonly description: "The delivery of a specified quantity of carbon for an order."; readonly properties: { readonly delivered_at: { readonly description: "Time at which the delivery occurred. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly location: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/climate_removals_location"; }]; readonly description: "Specific location of this delivery."; readonly nullable: true; }; readonly metric_tons: { readonly description: "Quantity of carbon removal supplied by this delivery."; readonly maxLength: 5000; readonly type: "string"; }; readonly registry_url: { readonly description: "Once retired, a URL to the registry entry for the tons from this delivery."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly supplier: { readonly $ref: "#/components/schemas/climate.supplier"; }; }; readonly required: readonly ["delivered_at", "metric_tons", "supplier"]; readonly title: "ClimateRemovalsOrderDeliveries"; readonly type: "object"; readonly 'x-expandableFields': readonly ["location", "supplier"]; }; export declare const climate_removals_products_priceSchema: { readonly description: ""; readonly properties: { readonly amount_fees: { readonly description: "Fees for one metric ton of carbon removal in the currency's smallest unit."; readonly type: "integer"; }; readonly amount_subtotal: { readonly description: "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit."; readonly type: "integer"; }; }; readonly required: readonly ["amount_fees", "amount_subtotal", "amount_total"]; readonly title: "ClimateRemovalsProductsPrice"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const confirmation_tokenSchema: { readonly description: "ConfirmationTokens help transport client side data collected by Stripe JS over\nto your server for confirming a PaymentIntent or SetupIntent. If the confirmation\nis successful, values present on the ConfirmationToken are written onto the Intent.\n\nTo learn more about how to use ConfirmationToken, visit the related guides:\n- [Finalize payments on the server](https://stripe.com/docs/payments/finalize-payments-on-the-server)\n- [Build two-step confirmation](https://stripe.com/docs/payments/build-a-two-step-confirmation)."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expires_at: { readonly description: "Time at which this ConfirmationToken expires and can no longer be used to confirm a PaymentIntent or SetupIntent."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly mandate_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/confirmation_tokens_resource_mandate_data"; }]; readonly description: "Data used for generating a Mandate."; readonly nullable: true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["confirmation_token"]; readonly type: "string"; }; readonly payment_intent: { readonly description: "ID of the PaymentIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_method_preview: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/confirmation_tokens_resource_payment_method_preview"; }]; readonly description: "Payment details collected by the Payment Element, used to create a PaymentMethod when a PaymentIntent or SetupIntent is confirmed with this ConfirmationToken."; readonly nullable: true; }; readonly return_url: { readonly description: "Return URL used to confirm the Intent."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this ConfirmationToken's payment method.\n\nThe presence of this property will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete."; readonly enum: readonly ["off_session", "on_session"]; readonly nullable: true; readonly type: "string"; }; readonly setup_intent: { readonly description: "ID of the SetupIntent that this ConfirmationToken was used to confirm, or null if this ConfirmationToken has not yet been used."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/confirmation_tokens_resource_shipping"; }]; readonly description: "Shipping information collected on this ConfirmationToken."; readonly nullable: true; }; readonly use_stripe_sdk: { readonly description: "Indicates whether the Stripe SDK is used to handle confirmation flow. Defaults to `true` on ConfirmationToken."; readonly type: "boolean"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "use_stripe_sdk"]; readonly title: "ConfirmationTokensResourceConfirmationToken"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_data", "payment_method_preview", "shipping"]; readonly 'x-resourceId': "confirmation_token"; }; export declare const confirmation_tokens_resource_mandate_dataSchema: { readonly description: "Data used for generating a Mandate."; readonly properties: { readonly customer_acceptance: { readonly $ref: "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance"; }; }; readonly required: readonly ["customer_acceptance"]; readonly title: "ConfirmationTokensResourceMandateData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_acceptance"]; }; export declare const confirmation_tokens_resource_mandate_data_resource_customer_acceptanceSchema: { readonly description: "This hash contains details about the customer acceptance of the Mandate."; readonly properties: { readonly online: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_online"; }]; readonly description: "If this is a Mandate accepted online, this hash contains details about the online acceptance."; readonly nullable: true; }; readonly type: { readonly description: "The type of customer acceptance information included with the Mandate."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "ConfirmationTokensResourceMandateDataResourceCustomerAcceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["online"]; }; export declare const confirmation_tokens_resource_mandate_data_resource_customer_acceptance_resource_onlineSchema: { readonly description: "This hash contains details about the online acceptance."; readonly properties: { readonly ip_address: { readonly description: "The IP address from which the Mandate was accepted by the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the Mandate was accepted by the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "ConfirmationTokensResourceMandateDataResourceCustomerAcceptanceResourceOnline"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const confirmation_tokens_resource_payment_method_previewSchema: { readonly description: "Details of the PaymentMethod collected by Payment Element"; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/payment_method_acss_debit"; }; readonly affirm: { readonly $ref: "#/components/schemas/payment_method_affirm"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/payment_method_afterpay_clearpay"; }; readonly alipay: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_alipay"; }; readonly allow_redisplay: { readonly description: "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."; readonly enum: readonly ["always", "limited", "unspecified"]; readonly type: "string"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/payment_method_amazon_pay"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/payment_method_au_becs_debit"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/payment_method_bacs_debit"; }; readonly bancontact: { readonly $ref: "#/components/schemas/payment_method_bancontact"; }; readonly billing_details: { readonly $ref: "#/components/schemas/billing_details"; }; readonly blik: { readonly $ref: "#/components/schemas/payment_method_blik"; }; readonly boleto: { readonly $ref: "#/components/schemas/payment_method_boleto"; }; readonly card: { readonly $ref: "#/components/schemas/payment_method_card"; }; readonly card_present: { readonly $ref: "#/components/schemas/payment_method_card_present"; }; readonly cashapp: { readonly $ref: "#/components/schemas/payment_method_cashapp"; }; readonly customer_balance: { readonly $ref: "#/components/schemas/payment_method_customer_balance"; }; readonly eps: { readonly $ref: "#/components/schemas/payment_method_eps"; }; readonly fpx: { readonly $ref: "#/components/schemas/payment_method_fpx"; }; readonly giropay: { readonly $ref: "#/components/schemas/payment_method_giropay"; }; readonly grabpay: { readonly $ref: "#/components/schemas/payment_method_grabpay"; }; readonly ideal: { readonly $ref: "#/components/schemas/payment_method_ideal"; }; readonly interac_present: { readonly $ref: "#/components/schemas/payment_method_interac_present"; }; readonly klarna: { readonly $ref: "#/components/schemas/payment_method_klarna"; }; readonly konbini: { readonly $ref: "#/components/schemas/payment_method_konbini"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_link"; }; readonly mobilepay: { readonly $ref: "#/components/schemas/payment_method_mobilepay"; }; readonly multibanco: { readonly $ref: "#/components/schemas/payment_method_multibanco"; }; readonly oxxo: { readonly $ref: "#/components/schemas/payment_method_oxxo"; }; readonly p24: { readonly $ref: "#/components/schemas/payment_method_p24"; }; readonly paynow: { readonly $ref: "#/components/schemas/payment_method_paynow"; }; readonly paypal: { readonly $ref: "#/components/schemas/payment_method_paypal"; }; readonly pix: { readonly $ref: "#/components/schemas/payment_method_pix"; }; readonly promptpay: { readonly $ref: "#/components/schemas/payment_method_promptpay"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/payment_method_revolut_pay"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/payment_method_sepa_debit"; }; readonly sofort: { readonly $ref: "#/components/schemas/payment_method_sofort"; }; readonly swish: { readonly $ref: "#/components/schemas/payment_method_swish"; }; readonly twint: { readonly $ref: "#/components/schemas/payment_method_twint"; }; readonly type: { readonly description: "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type."; readonly enum: readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/payment_method_us_bank_account"; }; readonly wechat_pay: { readonly $ref: "#/components/schemas/payment_method_wechat_pay"; }; readonly zip: { readonly $ref: "#/components/schemas/payment_method_zip"; }; }; readonly required: readonly ["billing_details", "type"]; readonly title: "ConfirmationTokensResourcePaymentMethodPreview"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip"]; }; export declare const confirmation_tokens_resource_shippingSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly name: { readonly description: "Recipient name."; readonly maxLength: 5000; readonly type: "string"; }; readonly phone: { readonly description: "Recipient phone (including extension)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["address", "name"]; readonly title: "ConfirmationTokensResourceShipping"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const connect_account_referenceSchema: { readonly description: ""; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The connected account being referenced when `type` is `account`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly type: { readonly description: "Type of the account referenced."; readonly enum: readonly ["account", "self"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "ConnectAccountReference"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account"]; }; export declare const connect_collection_transferSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount transferred, in cents (or local equivalent)."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "ID of the account that funds are being collected for."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["connect_collection_transfer"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency", "destination", "id", "livemode", "object"]; readonly title: "ConnectCollectionTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const connect_embedded_account_config_claimSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the embedded component is enabled."; readonly type: "boolean"; }; readonly features: { readonly $ref: "#/components/schemas/connect_embedded_account_features_claim"; }; }; readonly required: readonly ["enabled", "features"]; readonly title: "ConnectEmbeddedAccountConfigClaim"; readonly type: "object"; readonly 'x-expandableFields': readonly ["features"]; }; export declare const connect_embedded_account_features_claimSchema: { readonly description: ""; readonly properties: { readonly external_account_collection: { readonly description: "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements."; readonly type: "boolean"; }; }; readonly required: readonly ["external_account_collection"]; readonly title: "ConnectEmbeddedAccountFeaturesClaim"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const connect_embedded_account_session_create_componentsSchema: { readonly description: ""; readonly properties: { readonly account_management: { readonly $ref: "#/components/schemas/connect_embedded_account_config_claim"; }; readonly account_onboarding: { readonly $ref: "#/components/schemas/connect_embedded_account_config_claim"; }; readonly balances: { readonly $ref: "#/components/schemas/connect_embedded_payouts_config_claim"; }; readonly documents: { readonly $ref: "#/components/schemas/connect_embedded_base_config_claim"; }; readonly notification_banner: { readonly $ref: "#/components/schemas/connect_embedded_account_config_claim"; }; readonly payment_details: { readonly $ref: "#/components/schemas/connect_embedded_payments_config_claim"; }; readonly payments: { readonly $ref: "#/components/schemas/connect_embedded_payments_config_claim"; }; readonly payouts: { readonly $ref: "#/components/schemas/connect_embedded_payouts_config_claim"; }; readonly payouts_list: { readonly $ref: "#/components/schemas/connect_embedded_base_config_claim"; }; }; readonly required: readonly ["account_management", "account_onboarding", "balances", "documents", "notification_banner", "payment_details", "payments", "payouts", "payouts_list"]; readonly title: "ConnectEmbeddedAccountSessionCreateComponents"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_management", "account_onboarding", "balances", "documents", "notification_banner", "payment_details", "payments", "payouts", "payouts_list"]; }; export declare const connect_embedded_base_config_claimSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the embedded component is enabled."; readonly type: "boolean"; }; readonly features: { readonly $ref: "#/components/schemas/connect_embedded_base_features"; }; }; readonly required: readonly ["enabled", "features"]; readonly title: "ConnectEmbeddedBaseConfigClaim"; readonly type: "object"; readonly 'x-expandableFields': readonly ["features"]; }; export declare const connect_embedded_base_featuresSchema: { readonly description: ""; readonly properties: {}; readonly title: "ConnectEmbeddedBaseFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const connect_embedded_payments_config_claimSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the embedded component is enabled."; readonly type: "boolean"; }; readonly features: { readonly $ref: "#/components/schemas/connect_embedded_payments_features"; }; }; readonly required: readonly ["enabled", "features"]; readonly title: "ConnectEmbeddedPaymentsConfigClaim"; readonly type: "object"; readonly 'x-expandableFields': readonly ["features"]; }; export declare const connect_embedded_payments_featuresSchema: { readonly description: ""; readonly properties: { readonly capture_payments: { readonly description: "Whether to allow capturing and cancelling payment intents. This is `true` by default."; readonly type: "boolean"; }; readonly destination_on_behalf_of_charge_management: { readonly description: "Whether to allow connected accounts to manage destination charges that are created on behalf of them. This is `false` by default."; readonly type: "boolean"; }; readonly dispute_management: { readonly description: "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default."; readonly type: "boolean"; }; readonly refund_management: { readonly description: "Whether to allow sending refunds. This is `true` by default."; readonly type: "boolean"; }; }; readonly required: readonly ["capture_payments", "destination_on_behalf_of_charge_management", "dispute_management", "refund_management"]; readonly title: "ConnectEmbeddedPaymentsFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const connect_embedded_payouts_config_claimSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the embedded component is enabled."; readonly type: "boolean"; }; readonly features: { readonly $ref: "#/components/schemas/connect_embedded_payouts_features"; }; }; readonly required: readonly ["enabled", "features"]; readonly title: "ConnectEmbeddedPayoutsConfigClaim"; readonly type: "object"; readonly 'x-expandableFields': readonly ["features"]; }; export declare const connect_embedded_payouts_featuresSchema: { readonly description: ""; readonly properties: { readonly edit_payout_schedule: { readonly description: "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise."; readonly type: "boolean"; }; readonly external_account_collection: { readonly description: "Whether to allow platforms to control bank account collection for their connected accounts. This feature can only be false for custom accounts (or accounts where the platform is compliance owner). Otherwise, bank account collection is determined by compliance requirements."; readonly type: "boolean"; }; readonly instant_payouts: { readonly description: "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise."; readonly type: "boolean"; }; readonly standard_payouts: { readonly description: "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise."; readonly type: "boolean"; }; }; readonly required: readonly ["edit_payout_schedule", "external_account_collection", "instant_payouts", "standard_payouts"]; readonly title: "ConnectEmbeddedPayoutsFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const country_specSchema: { readonly description: "Stripe needs to collect certain pieces of information about each account\ncreated. These requirements can differ depending on the account's country. The\nCountry Specs API makes these rules available to your integration.\n\nYou can also view the information from this API call as [an online\nguide](/docs/connect/required-verification-information)."; readonly properties: { readonly default_currency: { readonly description: "The default currency for this country. This applies to both payment methods and bank accounts."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object. Represented as the ISO country code for this country."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["country_spec"]; readonly type: "string"; }; readonly supported_bank_account_currencies: { readonly additionalProperties: { readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly description: "Currencies that can be accepted in the specific country (for transfers)."; readonly type: "object"; }; readonly supported_payment_currencies: { readonly description: "Currencies that can be accepted in the specified country (for payments)."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly supported_payment_methods: { readonly description: "Payment methods available in the specified country. You may need to enable some payment methods (e.g., [ACH](https://stripe.com/docs/ach)) on your account before they appear in this list. The `stripe` payment method refers to [charging through your platform](https://stripe.com/docs/connect/destination-charges)."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly supported_transfer_countries: { readonly description: "Countries that can accept transfers from the specified country."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly verification_fields: { readonly $ref: "#/components/schemas/country_spec_verification_fields"; }; }; readonly required: readonly ["default_currency", "id", "object", "supported_bank_account_currencies", "supported_payment_currencies", "supported_payment_methods", "supported_transfer_countries", "verification_fields"]; readonly title: "CountrySpec"; readonly type: "object"; readonly 'x-expandableFields': readonly ["verification_fields"]; readonly 'x-resourceId': "country_spec"; }; export declare const country_spec_verification_field_detailsSchema: { readonly description: ""; readonly properties: { readonly additional: { readonly description: "Additional fields which are only required for some users."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly minimum: { readonly description: "Fields which every account must eventually provide."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["additional", "minimum"]; readonly title: "CountrySpecVerificationFieldDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const country_spec_verification_fieldsSchema: { readonly description: ""; readonly properties: { readonly company: { readonly $ref: "#/components/schemas/country_spec_verification_field_details"; }; readonly individual: { readonly $ref: "#/components/schemas/country_spec_verification_field_details"; }; }; readonly required: readonly ["company", "individual"]; readonly title: "CountrySpecVerificationFields"; readonly type: "object"; readonly 'x-expandableFields': readonly ["company", "individual"]; }; export declare const couponSchema: { readonly description: "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),\n[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents)."; readonly properties: { readonly amount_off: { readonly description: "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."; readonly nullable: true; readonly type: "integer"; }; readonly applies_to: { readonly $ref: "#/components/schemas/coupon_applies_to"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "If `amount_off` has been set, the three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the amount to take off."; readonly nullable: true; readonly type: "string"; }; readonly currency_options: { readonly additionalProperties: { readonly $ref: "#/components/schemas/coupon_currency_option"; }; readonly description: "Coupons defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."; readonly type: "object"; }; readonly duration: { readonly description: "One of `forever`, `once`, and `repeating`. Describes how long a customer who applies this coupon will get the discount."; readonly enum: readonly ["forever", "once", "repeating"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly duration_in_months: { readonly description: "If `duration` is `repeating`, the number of months the coupon applies. Null if coupon `duration` is `forever` or `once`."; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly max_redemptions: { readonly description: "Maximum number of times this coupon can be redeemed, in total, across all customers, before it is no longer valid."; readonly nullable: true; readonly type: "integer"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly name: { readonly description: "Name of the coupon displayed to customers on for instance invoices or receipts."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["coupon"]; readonly type: "string"; }; readonly percent_off: { readonly description: "Percent that will be taken off the subtotal of any invoices for this customer for the duration of the coupon. For example, a coupon with percent_off of 50 will make a $ (or local equivalent)100 invoice $ (or local equivalent)50 instead."; readonly nullable: true; readonly type: "number"; }; readonly redeem_by: { readonly description: "Date after which the coupon can no longer be redeemed."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly times_redeemed: { readonly description: "Number of times this coupon has been applied to a customer."; readonly type: "integer"; }; readonly valid: { readonly description: "Taking account of the above properties, whether this coupon can still be applied to a customer."; readonly type: "boolean"; }; }; readonly required: readonly ["created", "duration", "id", "livemode", "object", "times_redeemed", "valid"]; readonly title: "Coupon"; readonly type: "object"; readonly 'x-expandableFields': readonly ["applies_to", "currency_options"]; readonly 'x-resourceId': "coupon"; }; export declare const coupon_applies_toSchema: { readonly description: ""; readonly properties: { readonly products: { readonly description: "A list of product IDs this coupon applies to"; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["products"]; readonly title: "CouponAppliesTo"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const coupon_currency_optionSchema: { readonly description: ""; readonly properties: { readonly amount_off: { readonly description: "Amount (in the `currency` specified) that will be taken off the subtotal of any invoices for this customer."; readonly type: "integer"; }; }; readonly required: readonly ["amount_off"]; readonly title: "CouponCurrencyOption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const credit_noteSchema: { readonly description: "Issue a credit note to adjust an invoice's amount after the invoice is finalized.\n\nRelated guide: [Credit notes](https://stripe.com/docs/billing/invoices/credit-notes)"; readonly properties: { readonly amount: { readonly description: "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax."; readonly type: "integer"; }; readonly amount_shipping: { readonly description: "This is the sum of all the shipping amounts."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the customer."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly customer_balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer_balance_transaction"; }]; readonly description: "Customer balance transaction related to this credit note."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer_balance_transaction"; }]; }; }; readonly discount_amount: { readonly description: "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited."; readonly type: "integer"; }; readonly discount_amounts: { readonly description: "The aggregate amounts calculated per discount for all line items."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_discount_amount"; }; readonly type: "array"; }; readonly effective_at: { readonly description: "The date when this credit note is in effect. Same as `created` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the credit note PDF."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "ID of the invoice."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly lines: { readonly description: "Line items that make up the credit note"; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/credit_note_line_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "CreditNoteLinesList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly memo: { readonly description: "Customer-facing text that appears on the credit note PDF."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly number: { readonly description: "A unique number that identifies this particular credit note and appears on the PDF of the credit note and its associated invoice."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["credit_note"]; readonly type: "string"; }; readonly out_of_band_amount: { readonly description: "Amount that was credited outside of Stripe."; readonly nullable: true; readonly type: "integer"; }; readonly pdf: { readonly description: "The link to download the PDF of the credit note."; readonly maxLength: 5000; readonly type: "string"; }; readonly reason: { readonly description: "Reason for issuing this credit note, one of `duplicate`, `fraudulent`, `order_change`, or `product_unsatisfactory`"; readonly enum: readonly ["duplicate", "fraudulent", "order_change", "product_unsatisfactory"]; readonly nullable: true; readonly type: "string"; }; readonly refund: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/refund"; }]; readonly description: "Refund related to this credit note."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/refund"; }]; }; }; readonly shipping_cost: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_shipping_cost"; }]; readonly description: "The details of the cost of shipping, including the ShippingRate applied to the invoice."; readonly nullable: true; }; readonly status: { readonly description: "Status of this credit note, one of `issued` or `void`. Learn more about [voiding credit notes](https://stripe.com/docs/billing/invoices/credit-notes#voiding)."; readonly enum: readonly ["issued", "void"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly subtotal: { readonly description: "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts."; readonly type: "integer"; }; readonly subtotal_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts."; readonly nullable: true; readonly type: "integer"; }; readonly tax_amounts: { readonly description: "The aggregate amounts calculated per tax rate for all line items."; readonly items: { readonly $ref: "#/components/schemas/credit_note_tax_amount"; }; readonly type: "array"; }; readonly total: { readonly description: "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount."; readonly type: "integer"; }; readonly total_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts."; readonly nullable: true; readonly type: "integer"; }; readonly type: { readonly description: "Type of this credit note, one of `pre_payment` or `post_payment`. A `pre_payment` credit note means it was issued when the invoice was open. A `post_payment` credit note means it was issued when the invoice was paid."; readonly enum: readonly ["post_payment", "pre_payment"]; readonly type: "string"; }; readonly voided_at: { readonly description: "The time that the credit note was voided."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "amount_shipping", "created", "currency", "customer", "discount_amount", "discount_amounts", "id", "invoice", "lines", "livemode", "number", "object", "pdf", "status", "subtotal", "tax_amounts", "total", "type"]; readonly title: "CreditNote"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer", "customer_balance_transaction", "discount_amounts", "invoice", "lines", "refund", "shipping_cost", "tax_amounts"]; readonly 'x-resourceId': "credit_note"; }; export declare const credit_note_line_itemSchema: { readonly description: "The credit note line item object"; readonly properties: { readonly amount: { readonly description: "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts."; readonly type: "integer"; }; readonly amount_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts."; readonly nullable: true; readonly type: "integer"; }; readonly description: { readonly description: "Description of the item being credited."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discount_amount: { readonly description: "The integer amount in cents (or local equivalent) representing the discount being credited for this line item."; readonly type: "integer"; }; readonly discount_amounts: { readonly description: "The amount of discount calculated per discount for this line item"; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_discount_amount"; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice_line_item: { readonly description: "ID of the invoice line item being credited"; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["credit_note_line_item"]; readonly type: "string"; }; readonly quantity: { readonly description: "The number of units of product being credited."; readonly nullable: true; readonly type: "integer"; }; readonly tax_amounts: { readonly description: "The amount of tax calculated per tax rate for this line item"; readonly items: { readonly $ref: "#/components/schemas/credit_note_tax_amount"; }; readonly type: "array"; }; readonly tax_rates: { readonly description: "The tax rates which apply to the line item."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly type: "array"; }; readonly type: { readonly description: "The type of the credit note line item, one of `invoice_line_item` or `custom_line_item`. When the type is `invoice_line_item` there is an additional `invoice_line_item` property on the resource the value of which is the id of the credited line item on the invoice."; readonly enum: readonly ["custom_line_item", "invoice_line_item"]; readonly type: "string"; }; readonly unit_amount: { readonly description: "The cost of each unit of product being credited."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly unit_amount_excluding_tax: { readonly description: "The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "discount_amount", "discount_amounts", "id", "livemode", "object", "tax_amounts", "tax_rates", "type"]; readonly title: "CreditNoteLineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discount_amounts", "tax_amounts", "tax_rates"]; readonly 'x-resourceId': "credit_note_line_item"; }; export declare const credit_note_tax_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount, in cents (or local equivalent), of the tax."; readonly type: "integer"; }; readonly inclusive: { readonly description: "Whether this tax amount is inclusive or exclusive."; readonly type: "boolean"; }; readonly tax_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_rate"; }]; readonly description: "The tax rate that was applied to get this tax amount."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_rate"; }]; }; }; readonly taxability_reason: { readonly 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."; readonly enum: readonly ["customer_exempt", "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"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly taxable_amount: { readonly description: "The amount on which tax is calculated, in cents (or local equivalent)."; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "inclusive", "tax_rate"]; readonly title: "CreditNoteTaxAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tax_rate"]; }; export declare const currency_optionSchema: { readonly description: ""; readonly properties: { readonly custom_unit_amount: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/custom_unit_amount"; }]; readonly description: "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links."; readonly nullable: true; }; readonly tax_behavior: { readonly description: "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed."; readonly enum: readonly ["exclusive", "inclusive", "unspecified"]; readonly nullable: true; readonly type: "string"; }; readonly tiers: { readonly description: "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."; readonly items: { readonly $ref: "#/components/schemas/price_tier"; }; readonly type: "array"; }; readonly unit_amount: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CurrencyOption"; readonly type: "object"; readonly 'x-expandableFields': readonly ["custom_unit_amount", "tiers"]; }; export declare const custom_unit_amountSchema: { readonly description: ""; readonly properties: { readonly maximum: { readonly description: "The maximum unit amount the customer can specify for this item."; readonly nullable: true; readonly type: "integer"; }; readonly minimum: { readonly description: "The minimum unit amount the customer can specify for this item. Must be at least the minimum charge amount."; readonly nullable: true; readonly type: "integer"; }; readonly preset: { readonly description: "The starting unit amount which can be updated by the customer."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "CustomUnitAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customerSchema: { readonly description: "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)"; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "The customer's address."; readonly nullable: true; }; readonly balance: { readonly description: "The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize."; readonly type: "integer"; }; readonly cash_balance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/cash_balance"; }]; readonly description: "The current funds being held by Stripe on behalf of the customer. You can apply these funds towards payment intents when the source is \"cash_balance\". The `settings[reconciliation_mode]` field describes if these funds apply to these payment intents manually or automatically."; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) the customer can be charged in for recurring billing purposes."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly default_source: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly description: "ID of the default payment source for the customer.\n\nIf you use payment methods created through the PaymentMethods API, see the [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) field instead."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; }; readonly 'x-stripeBypassValidation': true; }; readonly delinquent: { readonly description: "Tracks the most recent state change on any invoice belonging to the customer. Paying an invoice or marking it uncollectible via the API will set this field to false. An automatic payment failure or passing the `invoice.due_date` will set this field to `true`.\n\nIf an invoice becomes uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't reset to `false`.\n\nIf you care whether the customer has paid their most recent subscription invoice, use `subscription.status` instead. Paying or marking uncollectible any customer invoice regardless of whether it is the latest invoice for a subscription will always set this field to `false`."; readonly nullable: true; readonly type: "boolean"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discount: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; readonly description: "Describes the current discount active on the customer, if there is one."; readonly nullable: true; }; readonly email: { readonly description: "The customer's email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice_credit_balance: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes."; readonly type: "object"; }; readonly invoice_prefix: { readonly description: "The prefix for the customer used to generate unique invoice numbers."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_settings: { readonly $ref: "#/components/schemas/invoice_setting_customer_setting"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly name: { readonly description: "The customer's full name or business name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly next_invoice_sequence: { readonly description: "The suffix of the customer's next invoice number (for example, 0001)."; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["customer"]; readonly type: "string"; }; readonly phone: { readonly description: "The customer's phone number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_locales: { readonly description: "The customer's preferred locales (languages), ordered by preference."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "Mailing and shipping address for the customer. Appears on invoices emailed to this customer."; readonly nullable: true; }; readonly sources: { readonly description: "The customer's payment sources, if any."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly title: "Polymorphic"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "ApmsSourcesSourceList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly subscriptions: { readonly description: "The customer's current subscriptions, if any."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/subscription"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "SubscriptionList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly tax: { readonly $ref: "#/components/schemas/customer_tax"; }; readonly tax_exempt: { readonly description: "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**."; readonly enum: readonly ["exempt", "none", "reverse"]; readonly nullable: true; readonly type: "string"; }; readonly tax_ids: { readonly description: "The customer's tax IDs."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/tax_id"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "TaxIDsList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock that this customer belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; }; readonly required: readonly ["created", "id", "livemode", "object"]; readonly title: "Customer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "cash_balance", "default_source", "discount", "invoice_settings", "shipping", "sources", "subscriptions", "tax", "tax_ids", "test_clock"]; readonly 'x-resourceId': "customer"; }; export declare const customer_acceptanceSchema: { readonly description: ""; readonly properties: { readonly accepted_at: { readonly description: "The time that the customer accepts the mandate."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly offline: { readonly $ref: "#/components/schemas/offline_acceptance"; }; readonly online: { readonly $ref: "#/components/schemas/online_acceptance"; }; readonly type: { readonly description: "The mandate includes the type of customer acceptance information, such as: `online` or `offline`."; readonly enum: readonly ["offline", "online"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "customer_acceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["offline", "online"]; }; export declare const customer_balance_customer_balance_settingsSchema: { readonly description: ""; readonly properties: { readonly reconciliation_mode: { readonly description: "The configuration for how funds that land in the customer cash balance are reconciled."; readonly enum: readonly ["automatic", "manual"]; readonly type: "string"; }; readonly using_merchant_default: { readonly description: "A flag to indicate if reconciliation mode returned is the user's default or is specific to this customer cash balance"; readonly type: "boolean"; }; }; readonly required: readonly ["reconciliation_mode", "using_merchant_default"]; readonly title: "CustomerBalanceCustomerBalanceSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraftSchema: { readonly description: ""; readonly properties: { readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly linked_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer_cash_balance_transaction"; }]; readonly description: "The [Cash Balance Transaction](https://stripe.com/docs/api/cash_balance_transactions/object) that brought the customer balance negative, triggering the clawback of funds."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer_cash_balance_transaction"; }]; }; }; }; readonly required: readonly ["balance_transaction", "linked_transaction"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "linked_transaction"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transactionSchema: { readonly description: ""; readonly properties: { readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were applied to."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; }; readonly required: readonly ["payment_intent"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceAppliedToPaymentTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_intent"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transactionSchema: { readonly description: ""; readonly properties: { readonly bank_transfer: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"; }; }; readonly required: readonly ["bank_transfer"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_transfer"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transferSchema: { readonly description: ""; readonly properties: { readonly eu_bank_transfer: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer"; }; readonly gb_bank_transfer: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer"; }; readonly jp_bank_transfer: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer"; }; readonly reference: { readonly description: "The user-supplied reference field on the bank transfer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "The funding method type used to fund the customer balance. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."; readonly enum: readonly ["eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_transfer: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer"; }; }; readonly required: readonly ["type"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "us_bank_transfer"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transferSchema: { readonly description: ""; readonly properties: { readonly bic: { readonly description: "The BIC of the bank of the sender of the funding."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly iban_last4: { readonly description: "The last 4 digits of the IBAN of the sender of the funding."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sender_name: { readonly description: "The full name of the sender, as supplied by the sending bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transferSchema: { readonly description: ""; readonly properties: { readonly account_number_last4: { readonly description: "The last 4 digits of the account number of the sender of the funding."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sender_name: { readonly description: "The full name of the sender, as supplied by the sending bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sort_code: { readonly description: "The sort code of the bank of the sender of the funding"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transferSchema: { readonly description: ""; readonly properties: { readonly sender_bank: { readonly description: "The name of the bank of the sender of the funding."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sender_branch: { readonly description: "The name of the bank branch of the sender of the funding."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sender_name: { readonly description: "The full name of the sender, as supplied by the sending bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transferSchema: { readonly description: ""; readonly properties: { readonly network: { readonly description: "The banking network used for this funding."; readonly enum: readonly ["ach", "domestic_wire_us", "swift"]; readonly type: "string"; }; readonly sender_name: { readonly description: "The full name of the sender, as supplied by the sending bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transactionSchema: { readonly description: ""; readonly properties: { readonly refund: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/refund"; }]; readonly description: "The [Refund](https://stripe.com/docs/api/refunds/object) that moved these funds into the customer's cash balance."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/refund"; }]; }; }; }; readonly required: readonly ["refund"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceRefundedFromPaymentTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["refund"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_transferred_to_balanceSchema: { readonly description: ""; readonly properties: { readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds transferred to your Stripe balance."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; }; readonly required: readonly ["balance_transaction"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction"]; }; export declare const customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transactionSchema: { readonly description: ""; readonly properties: { readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "The [Payment Intent](https://stripe.com/docs/api/payment_intents/object) that funds were unapplied from."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; }; readonly required: readonly ["payment_intent"]; readonly title: "CustomerBalanceResourceCashBalanceTransactionResourceUnappliedFromPaymentTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_intent"]; }; export declare const customer_balance_transactionSchema: { readonly description: "Each customer has a [Balance](https://stripe.com/docs/api/customers/object#customer_object-balance) value,\nwhich denotes a debit or credit that's automatically applied to their next invoice upon finalization.\nYou may modify the value directly by using the [update customer API](https://stripe.com/docs/api/customers/update),\nor by creating a Customer Balance Transaction, which increments or decrements the customer's `balance` by the specified `amount`.\n\nRelated guide: [Customer balance](https://stripe.com/docs/billing/customer/balance)"; readonly properties: { readonly amount: { readonly description: "The amount of the transaction. A negative value is a credit for the customer's balance, and a positive value is a debit to the customer's `balance`."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly credit_note: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/credit_note"; }]; readonly description: "The ID of the credit note (if any) related to the transaction."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/credit_note"; }]; }; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "The ID of the customer the transaction belongs to."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly ending_balance: { readonly description: "The customer's `balance` after the transaction was applied. A negative value decreases the amount due on the customer's next invoice. A positive value increases the amount due on the customer's next invoice."; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "The ID of the invoice (if any) related to the transaction."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["customer_balance_transaction"]; readonly type: "string"; }; readonly type: { readonly description: "Transaction type: `adjustment`, `applied_to_invoice`, `credit_note`, `initial`, `invoice_overpaid`, `invoice_too_large`, `invoice_too_small`, `unspent_receiver_credit`, or `unapplied_from_invoice`. See the [Customer Balance page](https://stripe.com/docs/billing/customer/balance#types) to learn more about transaction types."; readonly enum: readonly ["adjustment", "applied_to_invoice", "credit_note", "initial", "invoice_overpaid", "invoice_too_large", "invoice_too_small", "migration", "unapplied_from_invoice", "unspent_receiver_credit"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["amount", "created", "currency", "customer", "ending_balance", "id", "livemode", "object", "type"]; readonly title: "CustomerBalanceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["credit_note", "customer", "invoice"]; readonly 'x-resourceId': "customer_balance_transaction"; }; export declare const customer_cash_balance_transactionSchema: { readonly description: "Customers with certain payments enabled have a cash balance, representing funds that were paid\nby the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions\nrepresent when funds are moved into or out of this balance. This includes funding by the customer, allocation\nto payments, and refunds to the customer."; readonly properties: { readonly adjusted_for_overdraft: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"; }; readonly applied_to_payment: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "The customer whose available cash balance changed as a result of this transaction."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly ending_balance: { readonly description: "The total available cash balance for the specified currency after this transaction was applied. Represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly funded: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_funded_transaction"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly net_amount: { readonly description: "The amount by which the cash balance changed, represented in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). A positive value represents funds being added to the cash balance, a negative value represents funds being removed from the cash balance."; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["customer_cash_balance_transaction"]; readonly type: "string"; }; readonly refunded_from_payment: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"; }; readonly transferred_to_balance: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"; }; readonly type: { readonly description: "The type of the cash balance transaction. New types may be added in future. See [Customer Balance](https://stripe.com/docs/payments/customer-balance#types) to learn more about these types."; readonly enum: readonly ["adjusted_for_overdraft", "applied_to_payment", "funded", "funding_reversed", "refunded_from_payment", "return_canceled", "return_initiated", "transferred_to_balance", "unapplied_from_payment"]; readonly type: "string"; }; readonly unapplied_from_payment: { readonly $ref: "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"; }; }; readonly required: readonly ["created", "currency", "customer", "ending_balance", "id", "livemode", "net_amount", "object", "type"]; readonly title: "CustomerCashBalanceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["adjusted_for_overdraft", "applied_to_payment", "customer", "funded", "refunded_from_payment", "transferred_to_balance", "unapplied_from_payment"]; readonly 'x-resourceId': "customer_cash_balance_transaction"; }; export declare const customer_sessionSchema: { readonly description: "A customer session allows you to grant client access to Stripe's frontend SDKs (like StripeJs)\ncontrol over a customer."; readonly properties: { readonly client_secret: { readonly description: "The client secret of this customer session. Used on the client to set up secure access to the given `customer`.\n\nThe client secret can be used to provide access to `customer` from your frontend. It should not be stored, logged, or exposed to anyone other than the relevant customer. Make sure that you have TLS enabled on any page that includes the client secret."; readonly maxLength: 5000; readonly type: "string"; }; readonly components: { readonly $ref: "#/components/schemas/customer_session_resource_components"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "The customer the customer session was created for."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly expires_at: { readonly description: "The timestamp at which this customer session will expire."; readonly format: "unix-time"; readonly type: "integer"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["customer_session"]; readonly type: "string"; }; }; readonly required: readonly ["client_secret", "created", "customer", "expires_at", "livemode", "object"]; readonly title: "CustomerSessionResourceCustomerSession"; readonly type: "object"; readonly 'x-expandableFields': readonly ["components", "customer"]; readonly 'x-resourceId': "customer_session"; }; export declare const customer_session_resource_componentsSchema: { readonly description: "Configuration for the components supported by this customer session."; readonly properties: { readonly buy_button: { readonly $ref: "#/components/schemas/customer_session_resource_components_resource_buy_button"; }; readonly pricing_table: { readonly $ref: "#/components/schemas/customer_session_resource_components_resource_pricing_table"; }; }; readonly required: readonly ["buy_button", "pricing_table"]; readonly title: "CustomerSessionResourceComponents"; readonly type: "object"; readonly 'x-expandableFields': readonly ["buy_button", "pricing_table"]; }; export declare const customer_session_resource_components_resource_buy_buttonSchema: { readonly description: "This hash contains whether the buy button is enabled."; readonly properties: { readonly enabled: { readonly description: "Whether the buy button is enabled."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "CustomerSessionResourceComponentsResourceBuyButton"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_session_resource_components_resource_pricing_tableSchema: { readonly description: "This hash contains whether the pricing table is enabled."; readonly properties: { readonly enabled: { readonly description: "Whether the pricing table is enabled."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "CustomerSessionResourceComponentsResourcePricingTable"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const customer_taxSchema: { readonly description: ""; readonly properties: { readonly automatic_tax: { readonly description: "Surfaces if automatic tax computation is possible given the current customer location information."; readonly enum: readonly ["failed", "not_collecting", "supported", "unrecognized_location"]; readonly type: "string"; }; readonly ip_address: { readonly description: "A recent IP address of the customer used for tax reporting and tax location inference."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly location: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/customer_tax_location"; }]; readonly description: "The customer's location as identified by Stripe Tax."; readonly nullable: true; }; }; readonly required: readonly ["automatic_tax"]; readonly title: "CustomerTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["location"]; }; export declare const customer_tax_locationSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "The customer's country as identified by Stripe Tax."; readonly maxLength: 5000; readonly type: "string"; }; readonly source: { readonly description: "The data source used to infer the customer's location."; readonly enum: readonly ["billing_address", "ip_address", "payment_method", "shipping_destination"]; readonly type: "string"; }; readonly state: { readonly description: "The customer's state, county, province, or region as identified by Stripe Tax."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["country", "source"]; readonly title: "CustomerTaxLocation"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const deleted_accountSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["account"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_account"; }; export declare const deleted_apple_pay_domainSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["apple_pay_domain"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedApplePayDomain"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_apple_pay_domain"; }; export declare const deleted_applicationSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "The name of the application."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["application"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedApplication"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const deleted_bank_accountSchema: { readonly description: ""; readonly properties: { readonly currency: { readonly description: "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["bank_account"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedBankAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const deleted_cardSchema: { readonly description: ""; readonly properties: { readonly currency: { readonly description: "Three-letter [ISO code for the currency](https://stripe.com/docs/payouts) paid out to the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["card"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedCard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const deleted_couponSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["coupon"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedCoupon"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_coupon"; }; export declare const deleted_customerSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["customer"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedCustomer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_customer"; }; export declare const deleted_discountSchema: { readonly description: ""; readonly properties: { readonly checkout_session: { readonly description: "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly coupon: { readonly $ref: "#/components/schemas/coupon"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer associated with this discount."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly description: "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_item: { readonly description: "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["discount"]; readonly type: "string"; }; readonly promotion_code: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/promotion_code"; }]; readonly description: "The promotion code applied to create this discount."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/promotion_code"; }]; }; }; readonly start: { readonly description: "Date that the coupon was applied."; readonly format: "unix-time"; readonly type: "integer"; }; readonly subscription: { readonly description: "The subscription that this coupon is applied to, if it is applied to a particular subscription."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly subscription_item: { readonly description: "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["coupon", "deleted", "id", "object", "start"]; readonly title: "DeletedDiscount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["coupon", "customer", "promotion_code"]; readonly 'x-resourceId': "deleted_discount"; }; export declare const deleted_external_accountSchema: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/deleted_bank_account"; }, { readonly $ref: "#/components/schemas/deleted_card"; }]; readonly title: "Polymorphic"; readonly 'x-resourceId': "deleted_external_account"; readonly 'x-stripeBypassValidation': true; }; export declare const deleted_invoiceSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["invoice"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedInvoice"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_invoice"; }; export declare const deleted_invoiceitemSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["invoiceitem"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedInvoiceItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_invoiceitem"; }; export declare const deleted_payment_sourceSchema: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/deleted_bank_account"; }, { readonly $ref: "#/components/schemas/deleted_card"; }]; readonly title: "Polymorphic"; readonly 'x-resourceId': "deleted_payment_source"; readonly 'x-stripeBypassValidation': true; }; export declare const deleted_personSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["person"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedPerson"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_person"; }; export declare const deleted_planSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["plan"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedPlan"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_plan"; }; export declare const deleted_priceSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["price"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedPrice"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const deleted_productSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["product"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedProduct"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_product"; }; export declare const deleted_product_featureSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["product_feature"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedProductFeature"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_product_feature"; }; export declare const deleted_radar_value_listSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["radar.value_list"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "RadarListDeletedList"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_radar.value_list"; }; export declare const deleted_radar_value_list_itemSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["radar.value_list_item"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "RadarListDeletedListItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_radar.value_list_item"; }; export declare const deleted_subscription_itemSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["subscription_item"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedSubscriptionItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_subscription_item"; }; export declare const deleted_tax_idSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax_id"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "deleted_tax_id"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_tax_id"; }; export declare const deleted_terminal_configurationSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.configuration"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "TerminalConfigurationDeletedConfiguration"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_terminal.configuration"; }; export declare const deleted_terminal_locationSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.location"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "TerminalLocationDeletedLocation"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_terminal.location"; }; export declare const deleted_terminal_readerSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.reader"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "TerminalReaderDeletedReader"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_terminal.reader"; }; export declare const deleted_test_helpers_test_clockSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["test_helpers.test_clock"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "DeletedTestClock"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_test_helpers.test_clock"; }; export declare const deleted_webhook_endpointSchema: { readonly description: ""; readonly properties: { readonly deleted: { readonly description: "Always true for a deleted object"; readonly enum: readonly [true]; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["webhook_endpoint"]; readonly type: "string"; }; }; readonly required: readonly ["deleted", "id", "object"]; readonly title: "NotificationWebhookEndpointDeleted"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "deleted_webhook_endpoint"; }; export declare const destination_details_unimplementedSchema: { readonly description: ""; readonly properties: {}; readonly title: "destination_details_unimplemented"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const discountSchema: { readonly description: "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)"; readonly properties: { readonly checkout_session: { readonly description: "The Checkout session that this coupon is applied to, if it is applied to a particular session in payment mode. Will not be present for subscription mode."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly coupon: { readonly $ref: "#/components/schemas/coupon"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer associated with this discount."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly end: { readonly description: "If the coupon has a duration of `repeating`, the date that this discount will end. If the coupon has a duration of `once` or `forever`, this attribute will be null."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "The ID of the discount object. Discounts cannot be fetched by ID. Use `expand[]=discounts` in API calls to expand discount IDs in an array."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly description: "The invoice that the discount's coupon was applied to, if it was applied directly to a particular invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_item: { readonly description: "The invoice item `id` (or invoice line item `id` for invoice line items of type='subscription') that the discount's coupon was applied to, if it was applied directly to a particular invoice item or invoice line item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["discount"]; readonly type: "string"; }; readonly promotion_code: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/promotion_code"; }]; readonly description: "The promotion code applied to create this discount."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/promotion_code"; }]; }; }; readonly start: { readonly description: "Date that the coupon was applied."; readonly format: "unix-time"; readonly type: "integer"; }; readonly subscription: { readonly description: "The subscription that this coupon is applied to, if it is applied to a particular subscription."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly subscription_item: { readonly description: "The subscription item that this coupon is applied to, if it is applied to a particular subscription item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["coupon", "id", "object", "start"]; readonly title: "Discount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["coupon", "customer", "promotion_code"]; readonly 'x-resourceId': "discount"; }; export declare const discounts_resource_discount_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount, in cents (or local equivalent), of the discount."; readonly type: "integer"; }; readonly discount: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }, { readonly $ref: "#/components/schemas/deleted_discount"; }]; readonly description: "The discount that was applied to get this discount amount."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }, { readonly $ref: "#/components/schemas/deleted_discount"; }]; }; }; }; readonly required: readonly ["amount", "discount"]; readonly title: "DiscountsResourceDiscountAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discount"]; }; export declare const discounts_resource_stackable_discountSchema: { readonly description: ""; readonly properties: { readonly coupon: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/coupon"; }]; readonly description: "ID of the coupon to create a new discount for."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/coupon"; }]; }; }; readonly discount: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly description: "ID of an existing discount on the object (or one of its ancestors) to reuse."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly promotion_code: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/promotion_code"; }]; readonly description: "ID of the promotion code to create a new discount for."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/promotion_code"; }]; }; }; }; readonly title: "DiscountsResourceStackableDiscount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["coupon", "discount", "promotion_code"]; }; export declare const disputeSchema: { readonly description: "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)"; readonly properties: { readonly amount: { readonly description: "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed)."; readonly type: "integer"; }; readonly balance_transactions: { readonly description: "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute."; readonly items: { readonly $ref: "#/components/schemas/balance_transaction"; }; readonly type: "array"; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the charge that's disputed."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly evidence: { readonly $ref: "#/components/schemas/dispute_evidence"; }; readonly evidence_details: { readonly $ref: "#/components/schemas/dispute_evidence_details"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly is_charge_refundable: { readonly description: "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute."; readonly type: "boolean"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["dispute"]; readonly type: "string"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "ID of the PaymentIntent that's disputed."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly payment_method_details: { readonly $ref: "#/components/schemas/dispute_payment_method_details"; }; readonly reason: { readonly description: "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://stripe.com/docs/disputes/categories)."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`."; readonly enum: readonly ["lost", "needs_response", "under_review", "warning_closed", "warning_needs_response", "warning_under_review", "won"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "balance_transactions", "charge", "created", "currency", "evidence", "evidence_details", "id", "is_charge_refundable", "livemode", "metadata", "object", "reason", "status"]; readonly title: "Dispute"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transactions", "charge", "evidence", "evidence_details", "payment_intent", "payment_method_details"]; readonly 'x-resourceId': "dispute"; }; export declare const dispute_evidenceSchema: { readonly description: ""; readonly properties: { readonly access_activity_log: { readonly description: "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly billing_address: { readonly description: "The billing address provided by the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cancellation_policy: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly cancellation_policy_disclosure: { readonly description: "An explanation of how and when the customer was shown your refund policy prior to purchase."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly cancellation_rebuttal: { readonly description: "A justification for why the customer's subscription was not canceled."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly customer_communication: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly customer_email_address: { readonly description: "The email address of the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_name: { readonly description: "The name of the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_purchase_ip: { readonly description: "The IP address that the customer used when making the purchase."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_signature: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly duplicate_charge_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly duplicate_charge_explanation: { readonly description: "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly duplicate_charge_id: { readonly description: "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_description: { readonly description: "A description of the product or service that was sold."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly receipt: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly refund_policy: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly refund_policy_disclosure: { readonly description: "Documentation demonstrating that the customer was shown your refund policy prior to purchase."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly refund_refusal_explanation: { readonly description: "A justification for why the customer is not entitled to a refund."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; readonly service_date: { readonly description: "The date on which the customer received or began receiving the purchased service, in a clear human-readable format."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly service_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly shipping_address: { readonly description: "The address to which a physical product was shipped. You should try to include as complete address information as possible."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_carrier: { readonly description: "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_date: { readonly description: "The date on which a physical product began its route to the shipping address, in a clear human-readable format."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly shipping_tracking_number: { readonly description: "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly uncategorized_file: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly uncategorized_text: { readonly description: "Any additional evidence or statements."; readonly maxLength: 150000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "DisputeEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cancellation_policy", "customer_communication", "customer_signature", "duplicate_charge_documentation", "receipt", "refund_policy", "service_documentation", "shipping_documentation", "uncategorized_file"]; }; export declare const dispute_evidence_detailsSchema: { readonly description: ""; readonly properties: { readonly due_by: { readonly description: "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly has_evidence: { readonly description: "Whether evidence has been staged for this dispute."; readonly type: "boolean"; }; readonly past_due: { readonly description: "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed."; readonly type: "boolean"; }; readonly submission_count: { readonly description: "The number of times evidence has been submitted. Typically, you may only submit evidence once."; readonly type: "integer"; }; }; readonly required: readonly ["has_evidence", "past_due", "submission_count"]; readonly title: "DisputeEvidenceDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const dispute_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly card: { readonly $ref: "#/components/schemas/dispute_payment_method_details_card"; }; readonly klarna: { readonly $ref: "#/components/schemas/dispute_payment_method_details_klarna"; }; readonly paypal: { readonly $ref: "#/components/schemas/dispute_payment_method_details_paypal"; }; readonly type: { readonly description: "Payment method type."; readonly enum: readonly ["card", "klarna", "paypal"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "DisputePaymentMethodDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card", "klarna", "paypal"]; }; export declare const dispute_payment_method_details_cardSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly network_reason_code: { readonly description: "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["brand"]; readonly title: "DisputePaymentMethodDetailsCard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const dispute_payment_method_details_klarnaSchema: { readonly description: ""; readonly properties: { readonly reason_code: { readonly description: "The reason for the dispute as defined by Klarna"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "DisputePaymentMethodDetailsKlarna"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const dispute_payment_method_details_paypalSchema: { readonly description: ""; readonly properties: { readonly case_id: { readonly description: "The ID of the dispute in PayPal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reason_code: { readonly description: "The reason for the dispute as defined by PayPal"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "DisputePaymentMethodDetailsPaypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const email_sentSchema: { readonly description: ""; readonly properties: { readonly email_sent_at: { readonly description: "The timestamp when the email was sent."; readonly format: "unix-time"; readonly type: "integer"; }; readonly email_sent_to: { readonly description: "The recipient's email address."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["email_sent_at", "email_sent_to"]; readonly title: "EmailSent"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const entitlements_active_entitlementSchema: { readonly description: "An active entitlement describes access to a feature for a customer."; readonly properties: { readonly feature: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/entitlements.feature"; }]; readonly description: "The [Feature](https://stripe.com/docs/api/entitlements/feature) that the customer is entitled to."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/entitlements.feature"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly lookup_key: { readonly description: "A unique key you provide as your own system identifier. This may be up to 80 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["entitlements.active_entitlement"]; readonly type: "string"; }; }; readonly required: readonly ["feature", "id", "livemode", "lookup_key", "object"]; readonly title: "ActiveEntitlement"; readonly type: "object"; readonly 'x-expandableFields': readonly ["feature"]; readonly 'x-resourceId': "entitlements.active_entitlement"; }; export declare const entitlements_featureSchema: { readonly description: "A feature represents a monetizable ability or functionality in your system.\nFeatures can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer."; readonly properties: { readonly active: { readonly description: "Inactive features cannot be attached to new products and will not be returned from the features list endpoint."; readonly type: "boolean"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly lookup_key: { readonly description: "A unique key you provide as your own system identifier. This may be up to 80 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly 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."; readonly type: "object"; }; readonly name: { readonly description: "The feature's name, for your own purpose, not meant to be displayable to the customer."; readonly maxLength: 80; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["entitlements.feature"]; readonly type: "string"; }; }; readonly required: readonly ["active", "id", "livemode", "lookup_key", "metadata", "name", "object"]; readonly title: "Feature"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "entitlements.feature"; }; export declare const ephemeral_keySchema: { readonly description: ""; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expires: { readonly description: "Time at which the key will expire. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["ephemeral_key"]; readonly type: "string"; }; readonly secret: { readonly description: "The key's secret. You can use this value to make authorized requests to the Stripe API."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "expires", "id", "livemode", "object"]; readonly title: "EphemeralKey"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "ephemeral_key"; }; export declare const errorSchema: { readonly description: "An error response from the Stripe API"; readonly properties: { readonly error: { readonly $ref: "#/components/schemas/api_errors"; }; }; readonly required: readonly ["error"]; readonly type: "object"; }; export declare const eventSchema: { readonly description: "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://docs.stripe.com/webhooks)\nso that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://docs.stripe.com/connect), you can also receive event notifications\nthat occur in connected accounts. For these events, there's an\nadditional `account` attribute in the received `Event` object.\n\nWe only guarantee access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event)\nfor 30 days."; readonly properties: { readonly account: { readonly description: "The connected account that originates the event."; readonly maxLength: 5000; readonly type: "string"; }; readonly api_version: { readonly description: "The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly data: { readonly $ref: "#/components/schemas/notification_event_data"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["event"]; readonly type: "string"; }; readonly pending_webhooks: { readonly description: "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify."; readonly type: "integer"; }; readonly request: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/notification_event_request"; }]; readonly description: "Information on the API request that triggers the event."; readonly nullable: true; }; readonly type: { readonly description: "Description of the event (for example, `invoice.created` or `charge.refunded`)."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "data", "id", "livemode", "object", "pending_webhooks", "type"]; readonly title: "NotificationEvent"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data", "request"]; readonly 'x-resourceId': "event"; }; export declare const exchange_rateSchema: { readonly description: "`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.\n\n-----\n\n \n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*"; readonly properties: { readonly id: { readonly description: "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["exchange_rate"]; readonly type: "string"; }; readonly rates: { readonly additionalProperties: { readonly type: "number"; }; readonly description: "Hash where the keys are supported currencies and the values are the exchange rate at which the base id currency converts to the key currency."; readonly type: "object"; }; }; readonly required: readonly ["id", "object", "rates"]; readonly title: "ExchangeRate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "exchange_rate"; }; export declare const external_accountSchema: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }]; readonly title: "Polymorphic"; readonly 'x-resourceId': "external_account"; readonly 'x-stripeBypassValidation': true; }; export declare const external_account_requirementsSchema: { readonly description: ""; readonly properties: { readonly currently_due: { readonly description: "Fields that need to be collected to keep the external account enabled. If not collected by `current_deadline`, these fields appear in `past_due` as well, and the account is disabled."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly nullable: true; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by `current_deadline`. These fields need to be collected to enable the external account."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "ExternalAccountRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["errors"]; }; export declare const feeSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount of the fee, in cents."; readonly type: "integer"; }; readonly application: { readonly description: "ID of the Connect application that earned the fee."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency", "type"]; readonly title: "Fee"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const fee_refundSchema: { readonly description: "`Application Fee Refund` objects allow you to refund an application fee that\nhas previously been created but not yet refunded. Funds will be refunded to\nthe Stripe account from which the fee was originally collected.\n\nRelated guide: [Refunding application fees](https://stripe.com/docs/connect/destination-charges#refunding-app-fee)"; readonly properties: { readonly amount: { readonly description: "Amount, in cents (or local equivalent)."; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "Balance transaction that describes the impact on your account balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly fee: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application_fee"; }]; readonly description: "ID of the application fee that was refunded."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application_fee"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["fee_refund"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "created", "currency", "fee", "id", "object"]; readonly title: "FeeRefund"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "fee"]; readonly 'x-resourceId': "fee_refund"; }; export declare const fileSchema: { readonly description: "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)"; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expires_at: { readonly description: "The file expires and isn't available at this time in epoch seconds."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly filename: { readonly description: "The suitable name for saving the file to a filesystem."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly links: { readonly description: "A list of [file links](https://stripe.com/docs/api#file_links) that point at this file."; readonly nullable: true; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/file_link"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly pattern: "^/v1/file_links"; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "FileResourceFileLinkList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["file"]; readonly type: "string"; }; readonly purpose: { readonly description: "The [purpose](https://stripe.com/docs/file-upload#uploading-a-file) of the uploaded file."; readonly enum: readonly ["account_requirement", "additional_verification", "business_icon", "business_logo", "customer_signature", "dispute_evidence", "document_provider_identity_document", "finance_report_run", "identity_document", "identity_document_downloadable", "pci_document", "selfie", "sigma_scheduled_query", "tax_document_user_upload", "terminal_reader_splashscreen"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly size: { readonly description: "The size of the file object in bytes."; readonly type: "integer"; }; readonly title: { readonly description: "A suitable title for the document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "Use your live secret API key to download the file from this URL."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "object", "purpose", "size"]; readonly title: "File"; readonly type: "object"; readonly 'x-expandableFields': readonly ["links"]; readonly 'x-resourceId': "file"; }; export declare const file_linkSchema: { readonly description: "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that you can use to\nretrieve the contents of the file without authentication."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expired: { readonly description: "Returns if the link is already expired."; readonly type: "boolean"; }; readonly expires_at: { readonly description: "Time that the link expires."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly file: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The file object this link points to."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["file_link"]; readonly type: "string"; }; readonly url: { readonly description: "The publicly accessible URL to download the file."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["created", "expired", "file", "id", "livemode", "metadata", "object"]; readonly title: "FileLink"; readonly type: "object"; readonly 'x-expandableFields': readonly ["file"]; readonly 'x-resourceId': "file_link"; }; export declare const financial_connections_accountSchema: { readonly description: "A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access."; readonly properties: { readonly account_holder: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_accountholder"; }]; readonly description: "The account holder that this account belongs to."; readonly nullable: true; }; readonly balance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_balance"; }]; readonly description: "The most recent information about the account's balance."; readonly nullable: true; }; readonly balance_refresh: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_balance_refresh"; }]; readonly description: "The state of the most recent attempt to refresh the account balance."; readonly nullable: true; }; readonly category: { readonly description: "The type of the account. Account category is further divided in `subcategory`."; readonly enum: readonly ["cash", "credit", "investment", "other"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly display_name: { readonly description: "A human-readable name that has been assigned to this account, either by the account holder or by the institution."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly institution_name: { readonly description: "The name of the institution that holds this account."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "The last 4 digits of the account number. If present, this will be 4 numeric characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["financial_connections.account"]; readonly type: "string"; }; readonly ownership: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/financial_connections.account_ownership"; }]; readonly description: "The most recent information about the account's owners."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/financial_connections.account_ownership"; }]; }; }; readonly ownership_refresh: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_ownership_refresh"; }]; readonly description: "The state of the most recent attempt to refresh the account owners."; readonly nullable: true; }; readonly permissions: { readonly description: "The list of permissions granted by this account."; readonly items: { readonly enum: readonly ["balances", "ownership", "payment_method", "transactions"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly status: { readonly description: "The status of the link to the account."; readonly enum: readonly ["active", "disconnected", "inactive"]; readonly type: "string"; }; readonly subcategory: { readonly description: "If `category` is `cash`, one of:\n\n - `checking`\n - `savings`\n - `other`\n\nIf `category` is `credit`, one of:\n\n - `mortgage`\n - `line_of_credit`\n - `credit_card`\n - `other`\n\nIf `category` is `investment` or `other`, this will be `other`."; readonly enum: readonly ["checking", "credit_card", "line_of_credit", "mortgage", "other", "savings"]; readonly type: "string"; }; readonly subscriptions: { readonly description: "The list of data refresh subscriptions requested on this account."; readonly items: { readonly enum: readonly ["transactions"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly supported_payment_method_types: { readonly description: "The [PaymentMethod type](https://stripe.com/docs/api/payment_methods/object#payment_method_object-type)(s) that can be created from this account."; readonly items: { readonly enum: readonly ["link", "us_bank_account"]; readonly type: "string"; }; readonly type: "array"; }; readonly transaction_refresh: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_transaction_refresh"; }]; readonly description: "The state of the most recent attempt to refresh the account transactions."; readonly nullable: true; }; }; readonly required: readonly ["category", "created", "id", "institution_name", "livemode", "object", "status", "subcategory", "supported_payment_method_types"]; readonly title: "BankConnectionsResourceLinkedAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_holder", "balance", "balance_refresh", "ownership", "ownership_refresh", "transaction_refresh"]; readonly 'x-resourceId': "financial_connections.account"; }; export declare const financial_connections_account_ownerSchema: { readonly description: "Describes an owner of an account."; readonly properties: { readonly email: { readonly description: "The email address of the owner."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "The full name of the owner."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["financial_connections.account_owner"]; readonly type: "string"; }; readonly ownership: { readonly description: "The ownership object that this owner belongs to."; readonly maxLength: 5000; readonly type: "string"; }; readonly phone: { readonly description: "The raw phone number of the owner."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly raw_address: { readonly description: "The raw physical address of the owner."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly refreshed_at: { readonly description: "The timestamp of the refresh that updated this owner."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["id", "name", "object", "ownership"]; readonly title: "BankConnectionsResourceOwner"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "financial_connections.account_owner"; }; export declare const financial_connections_account_ownershipSchema: { readonly description: "Describes a snapshot of the owners of an account at a particular point in time."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["financial_connections.account_ownership"]; readonly type: "string"; }; readonly owners: { readonly description: "A paginated list of owners for this account."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/financial_connections.account_owner"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "BankConnectionsResourceOwnerList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; }; readonly required: readonly ["created", "id", "object", "owners"]; readonly title: "BankConnectionsResourceOwnership"; readonly type: "object"; readonly 'x-expandableFields': readonly ["owners"]; }; export declare const financial_connections_sessionSchema: { readonly description: "A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts."; readonly properties: { readonly account_holder: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/bank_connections_resource_accountholder"; }]; readonly description: "The account holder for whom accounts are collected in this session."; readonly nullable: true; }; readonly accounts: { readonly description: "The accounts that were collected as part of this Session."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/financial_connections.account"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly pattern: "^/v1/financial_connections/accounts"; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "BankConnectionsResourceLinkedAccountList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly client_secret: { readonly description: "A value that will be passed to the client to launch the authentication flow."; readonly maxLength: 5000; readonly type: "string"; }; readonly filters: { readonly $ref: "#/components/schemas/bank_connections_resource_link_account_session_filters"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["financial_connections.session"]; readonly type: "string"; }; readonly permissions: { readonly description: "Permissions requested for accounts collected during this session."; readonly items: { readonly enum: readonly ["balances", "ownership", "payment_method", "transactions"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly prefetch: { readonly description: "Data features requested to be retrieved upon account creation."; readonly items: { readonly enum: readonly ["balances", "ownership", "transactions"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly return_url: { readonly description: "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["accounts", "client_secret", "id", "livemode", "object", "permissions"]; readonly title: "BankConnectionsResourceLinkAccountSession"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_holder", "accounts", "filters"]; readonly 'x-resourceId': "financial_connections.session"; }; export declare const financial_connections_transactionSchema: { readonly description: "A Transaction represents a real transaction that affects a Financial Connections Account balance."; readonly properties: { readonly account: { readonly description: "The ID of the Financial Connections Account this transaction belongs to."; readonly maxLength: 5000; readonly type: "string"; }; readonly amount: { readonly description: "The amount of this transaction, in cents (or local equivalent)."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly description: { readonly description: "The description of this transaction."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["financial_connections.transaction"]; readonly type: "string"; }; readonly status: { readonly description: "The status of the transaction."; readonly enum: readonly ["pending", "posted", "void"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/bank_connections_resource_transaction_resource_status_transitions"; }; readonly transacted_at: { readonly description: "Time at which the transaction was transacted. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly transaction_refresh: { readonly description: "The token of the transaction refresh that last updated or created this transaction."; readonly maxLength: 5000; readonly type: "string"; }; readonly updated: { readonly description: "Time at which the object was last updated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["account", "amount", "currency", "description", "id", "livemode", "object", "status", "status_transitions", "transacted_at", "transaction_refresh", "updated"]; readonly title: "BankConnectionsResourceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_transitions"]; readonly 'x-resourceId': "financial_connections.transaction"; }; export declare const financial_reporting_finance_report_run_run_parametersSchema: { readonly description: ""; readonly properties: { readonly columns: { readonly description: "The set of output columns requested for inclusion in the report run."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly connected_account: { readonly description: "Connected account ID by which to filter the report run."; readonly maxLength: 5000; readonly type: "string"; }; readonly currency: { readonly description: "Currency of objects to be included in the report run."; readonly type: "string"; }; readonly interval_end: { readonly description: "Ending timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after the user specified `interval_start` and 1 second before this report's last `data_available_end` value."; readonly format: "unix-time"; readonly type: "integer"; }; readonly interval_start: { readonly description: "Starting timestamp of data to be included in the report run. Can be any UTC timestamp between 1 second after this report's `data_available_start` and 1 second before the user specified `interval_end` value."; readonly format: "unix-time"; readonly type: "integer"; }; readonly payout: { readonly description: "Payout ID by which to filter the report run."; readonly maxLength: 5000; readonly type: "string"; }; readonly reporting_category: { readonly description: "Category of balance transactions to be included in the report run."; readonly maxLength: 5000; readonly type: "string"; }; readonly timezone: { readonly description: "Defaults to `Etc/UTC`. The output timezone for all timestamps in the report. A list of possible time zone values is maintained at the [IANA Time Zone Database](http://www.iana.org/time-zones). Has no effect on `interval_start` or `interval_end`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "FinancialReportingFinanceReportRunRunParameters"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const forwarded_request_contextSchema: { readonly description: "Metadata about the forwarded request."; readonly properties: { readonly destination_duration: { readonly description: "The time it took in milliseconds for the destination endpoint to respond."; readonly type: "integer"; }; readonly destination_ip_address: { readonly description: "The IP address of the destination."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["destination_duration", "destination_ip_address"]; readonly title: "ForwardedRequestContext"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const forwarded_request_detailsSchema: { readonly description: "Details about the request forwarded to the destination endpoint."; readonly properties: { readonly body: { readonly description: "The body payload to send to the destination endpoint."; readonly maxLength: 5000; readonly type: "string"; }; readonly headers: { readonly description: "The headers to include in the forwarded request. Can be omitted if no additional headers (excluding Stripe-generated ones such as the Content-Type header) should be included."; readonly items: { readonly $ref: "#/components/schemas/forwarded_request_header"; }; readonly type: "array"; }; readonly http_method: { readonly description: "The HTTP method used to call the destination endpoint."; readonly enum: readonly ["POST"]; readonly type: "string"; }; }; readonly required: readonly ["body", "headers", "http_method"]; readonly title: "ForwardedRequestDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["headers"]; }; export declare const forwarded_request_headerSchema: { readonly description: "Header data."; readonly properties: { readonly name: { readonly description: "The header name."; readonly maxLength: 5000; readonly type: "string"; }; readonly value: { readonly description: "The header value."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["name", "value"]; readonly title: "ForwardedRequestHeader"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const forwarded_response_detailsSchema: { readonly description: "Details about the response from the destination endpoint."; readonly properties: { readonly body: { readonly description: "The response body from the destination endpoint to Stripe."; readonly maxLength: 5000; readonly type: "string"; }; readonly headers: { readonly description: "HTTP headers that the destination endpoint returned."; readonly items: { readonly $ref: "#/components/schemas/forwarded_request_header"; }; readonly type: "array"; }; readonly status: { readonly description: "The HTTP status code that the destination endpoint returned."; readonly type: "integer"; }; }; readonly required: readonly ["body", "headers", "status"]; readonly title: "ForwardedResponseDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["headers"]; }; export declare const forwarding_requestSchema: { readonly description: "Instructs Stripe to make a request on your behalf using the destination URL. The destination URL\nis activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials\nprovided during onboarding, and injects card details from the payment_method into the request.\n\nStripe redacts all sensitive fields and headers, including authentication credentials and card numbers,\nbefore storing the request and response data in the forwarding Request object, which are subject to a\n30-day retention period.\n\nYou can provide a Stripe idempotency key to make sure that requests with the same key result in only one\noutbound request. The Stripe idempotency key provided should be unique and different from any idempotency\nkeys provided on the underlying third-party request.\n\nForwarding Requests are synchronous requests that return a response or time out according to\nStripe’s limits.\n\nRelated guide: [Forward card details to third-party API endpoints](https://docs.stripe.com/payments/forwarding)."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["forwarding.request"]; readonly type: "string"; }; readonly payment_method: { readonly description: "The PaymentMethod to insert into the forwarded request. Forwarding previously consumed PaymentMethods is allowed."; readonly maxLength: 5000; readonly type: "string"; }; readonly replacements: { readonly description: "The field kinds to be replaced in the forwarded request."; readonly items: { readonly enum: readonly ["card_cvc", "card_expiry", "card_number", "cardholder_name"]; readonly type: "string"; }; readonly type: "array"; }; readonly request_context: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/forwarded_request_context"; }]; readonly description: "Context about the request from Stripe's servers to the destination endpoint."; readonly nullable: true; }; readonly request_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/forwarded_request_details"; }]; readonly description: "The request that was sent to the destination endpoint. We redact any sensitive fields."; readonly nullable: true; }; readonly response_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/forwarded_response_details"; }]; readonly description: "The response that the destination endpoint returned to us. We redact any sensitive fields."; readonly nullable: true; }; readonly url: { readonly description: "The destination URL for the forwarded request. Must be supported by the config."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "payment_method", "replacements"]; readonly title: "ForwardingRequest"; readonly type: "object"; readonly 'x-expandableFields': readonly ["request_context", "request_details", "response_details"]; readonly 'x-resourceId': "forwarding.request"; }; export declare const funding_instructionsSchema: { readonly description: "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)"; readonly properties: { readonly bank_transfer: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly funding_type: { readonly description: "The `funding_type` of the returned instructions"; readonly enum: readonly ["bank_transfer"]; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["funding_instructions"]; readonly type: "string"; }; }; readonly required: readonly ["bank_transfer", "currency", "funding_type", "livemode", "object"]; readonly title: "CustomerBalanceFundingInstructionsCustomerBalanceFundingInstructions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_transfer"]; readonly 'x-resourceId': "funding_instructions"; }; export declare const funding_instructions_bank_transferSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "The country of the bank account to fund"; readonly maxLength: 5000; readonly type: "string"; }; readonly financial_addresses: { readonly description: "A list of financial addresses that can be used to fund a particular balance"; readonly items: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_financial_address"; }; readonly type: "array"; }; readonly type: { readonly description: "The bank_transfer type"; readonly enum: readonly ["eu_bank_transfer", "jp_bank_transfer"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["country", "financial_addresses", "type"]; readonly title: "FundingInstructionsBankTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_addresses"]; }; export declare const funding_instructions_bank_transfer_aba_recordSchema: { readonly description: "ABA Records contain U.S. bank account details per the ABA format."; readonly properties: { readonly account_number: { readonly description: "The ABA account number"; readonly maxLength: 5000; readonly type: "string"; }; readonly bank_name: { readonly description: "The bank name"; readonly maxLength: 5000; readonly type: "string"; }; readonly routing_number: { readonly description: "The ABA routing number"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["account_number", "bank_name", "routing_number"]; readonly title: "FundingInstructionsBankTransferABARecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const funding_instructions_bank_transfer_financial_addressSchema: { readonly description: "FinancialAddresses contain identifying information that resolves to a FinancialAccount."; readonly properties: { readonly aba: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_aba_record"; }; readonly iban: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_iban_record"; }; readonly sort_code: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_sort_code_record"; }; readonly spei: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_spei_record"; }; readonly supported_networks: { readonly description: "The payment networks supported by this FinancialAddress"; readonly items: { readonly enum: readonly ["ach", "bacs", "domestic_wire_us", "fps", "sepa", "spei", "swift", "zengin"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly swift: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_swift_record"; }; readonly type: { readonly description: "The type of financial address"; readonly enum: readonly ["aba", "iban", "sort_code", "spei", "swift", "zengin"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly zengin: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_zengin_record"; }; }; readonly required: readonly ["type"]; readonly title: "FundingInstructionsBankTransferFinancialAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly ["aba", "iban", "sort_code", "spei", "swift", "zengin"]; }; export declare const funding_instructions_bank_transfer_iban_recordSchema: { readonly description: "Iban Records contain E.U. bank account details per the SEPA format."; readonly properties: { readonly account_holder_name: { readonly description: "The name of the person or business that owns the bank account"; readonly maxLength: 5000; readonly type: "string"; }; readonly bic: { readonly description: "The BIC/SWIFT code of the account."; readonly maxLength: 5000; readonly type: "string"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly iban: { readonly description: "The IBAN of the account."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["account_holder_name", "bic", "country", "iban"]; readonly title: "FundingInstructionsBankTransferIbanRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const funding_instructions_bank_transfer_sort_code_recordSchema: { readonly description: "Sort Code Records contain U.K. bank account details per the sort code format."; readonly properties: { readonly account_holder_name: { readonly description: "The name of the person or business that owns the bank account"; readonly maxLength: 5000; readonly type: "string"; }; readonly account_number: { readonly description: "The account number"; readonly maxLength: 5000; readonly type: "string"; }; readonly sort_code: { readonly description: "The six-digit sort code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["account_holder_name", "account_number", "sort_code"]; readonly title: "FundingInstructionsBankTransferSortCodeRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const funding_instructions_bank_transfer_spei_recordSchema: { readonly description: "SPEI Records contain Mexico bank account details per the SPEI format."; readonly properties: { readonly bank_code: { readonly description: "The three-digit bank code"; readonly maxLength: 5000; readonly type: "string"; }; readonly bank_name: { readonly description: "The short banking institution name"; readonly maxLength: 5000; readonly type: "string"; }; readonly clabe: { readonly description: "The CLABE number"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["bank_code", "bank_name", "clabe"]; readonly title: "FundingInstructionsBankTransferSpeiRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const funding_instructions_bank_transfer_swift_recordSchema: { readonly description: "SWIFT Records contain U.S. bank account details per the SWIFT format."; readonly properties: { readonly account_number: { readonly description: "The account number"; readonly maxLength: 5000; readonly type: "string"; }; readonly bank_name: { readonly description: "The bank name"; readonly maxLength: 5000; readonly type: "string"; }; readonly swift_code: { readonly description: "The SWIFT code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["account_number", "bank_name", "swift_code"]; readonly title: "FundingInstructionsBankTransferSwiftRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const funding_instructions_bank_transfer_zengin_recordSchema: { readonly description: "Zengin Records contain Japan bank account details per the Zengin format."; readonly properties: { readonly account_holder_name: { readonly description: "The account holder name"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_number: { readonly description: "The account number"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "The bank account type. In Japan, this can only be `futsu` or `toza`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_code: { readonly description: "The bank code of the account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "The bank name of the account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly branch_code: { readonly description: "The branch code of the account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly branch_name: { readonly description: "The branch name of the account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "FundingInstructionsBankTransferZenginRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_data_document_report_date_of_birthSchema: { readonly description: "Point in Time"; readonly properties: { readonly day: { readonly description: "Numerical day between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "Numerical month between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "GelatoDataDocumentReportDateOfBirth"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_data_document_report_expiration_dateSchema: { readonly description: "Point in Time"; readonly properties: { readonly day: { readonly description: "Numerical day between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "Numerical month between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "GelatoDataDocumentReportExpirationDate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_data_document_report_issued_dateSchema: { readonly description: "Point in Time"; readonly properties: { readonly day: { readonly description: "Numerical day between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "Numerical month between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "GelatoDataDocumentReportIssuedDate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_data_id_number_report_dateSchema: { readonly description: "Point in Time"; readonly properties: { readonly day: { readonly description: "Numerical day between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "Numerical month between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "GelatoDataIdNumberReportDate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_data_verified_outputs_dateSchema: { readonly description: "Point in Time"; readonly properties: { readonly day: { readonly description: "Numerical day between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "Numerical month between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "GelatoDataVerifiedOutputsDate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_document_reportSchema: { readonly description: "Result from a document check"; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Address as it appears in the document."; readonly nullable: true; }; readonly dob: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_data_document_report_date_of_birth"; }]; readonly description: "Date of birth as it appears in the document."; readonly nullable: true; }; readonly error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_document_report_error"; }]; readonly description: "Details on the verification error. Present when status is `unverified`."; readonly nullable: true; }; readonly expiration_date: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_data_document_report_expiration_date"; }]; readonly description: "Expiration date of the document."; readonly nullable: true; }; readonly files: { readonly description: "Array of [File](https://stripe.com/docs/api/files) ids containing images for this document."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly first_name: { readonly description: "First name as it appears in the document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issued_date: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_data_document_report_issued_date"; }]; readonly description: "Issued date of the document."; readonly nullable: true; }; readonly issuing_country: { readonly description: "Issuing country of the document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last_name: { readonly description: "Last name as it appears in the document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly number: { readonly description: "Document ID number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Status of this `document` check."; readonly enum: readonly ["unverified", "verified"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: { readonly description: "Type of the document."; readonly enum: readonly ["driving_license", "id_card", "passport"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "GelatoDocumentReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "dob", "error", "expiration_date", "issued_date"]; }; export declare const gelato_document_report_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification failure."; readonly enum: readonly ["document_expired", "document_type_not_supported", "document_unverified_other"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly reason: { readonly description: "A human-readable message giving the reason for the failure. These messages can be shown to your users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoDocumentReportError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_email_reportSchema: { readonly description: "Result from a email check"; readonly properties: { readonly email: { readonly description: "Email to be verified."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_email_report_error"; }]; readonly description: "Details on the verification error. Present when status is `unverified`."; readonly nullable: true; }; readonly status: { readonly description: "Status of this `email` check."; readonly enum: readonly ["unverified", "verified"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["status"]; readonly title: "GelatoEmailReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["error"]; }; export declare const gelato_email_report_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification failure."; readonly enum: readonly ["email_unverified_other", "email_verification_declined"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "A human-readable message giving the reason for the failure. These messages can be shown to your users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoEmailReportError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_id_number_reportSchema: { readonly description: "Result from an id_number check"; readonly properties: { readonly dob: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_data_id_number_report_date"; }]; readonly description: "Date of birth."; readonly nullable: true; }; readonly error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_id_number_report_error"; }]; readonly description: "Details on the verification error. Present when status is `unverified`."; readonly nullable: true; }; readonly first_name: { readonly description: "First name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id_number: { readonly description: "ID number. When `id_number_type` is `us_ssn`, only the last 4 digits are present."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id_number_type: { readonly description: "Type of ID number."; readonly enum: readonly ["br_cpf", "sg_nric", "us_ssn"]; readonly nullable: true; readonly type: "string"; }; readonly last_name: { readonly description: "Last name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Status of this `id_number` check."; readonly enum: readonly ["unverified", "verified"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["status"]; readonly title: "GelatoIdNumberReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["dob", "error"]; }; export declare const gelato_id_number_report_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification failure."; readonly enum: readonly ["id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "A human-readable message giving the reason for the failure. These messages can be shown to your users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoIdNumberReportError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_phone_reportSchema: { readonly description: "Result from a phone check"; readonly properties: { readonly error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_phone_report_error"; }]; readonly description: "Details on the verification error. Present when status is `unverified`."; readonly nullable: true; }; readonly phone: { readonly description: "Phone to be verified."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Status of this `phone` check."; readonly enum: readonly ["unverified", "verified"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["status"]; readonly title: "GelatoPhoneReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["error"]; }; export declare const gelato_phone_report_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification failure."; readonly enum: readonly ["phone_unverified_other", "phone_verification_declined"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "A human-readable message giving the reason for the failure. These messages can be shown to your users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoPhoneReportError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_provided_detailsSchema: { readonly description: ""; readonly properties: { readonly email: { readonly description: "Email of user being verified"; readonly maxLength: 5000; readonly type: "string"; }; readonly phone: { readonly description: "Phone number of user being verified"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "GelatoProvidedDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_report_document_optionsSchema: { readonly description: ""; readonly properties: { readonly allowed_types: { readonly description: "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."; readonly items: { readonly enum: readonly ["driving_license", "id_card", "passport"]; readonly type: "string"; }; readonly type: "array"; }; readonly require_id_number: { readonly description: "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."; readonly type: "boolean"; }; readonly require_live_capture: { readonly description: "Disable image uploads, identity document images have to be captured using the device’s camera."; readonly type: "boolean"; }; readonly require_matching_selfie: { readonly description: "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie)."; readonly type: "boolean"; }; }; readonly title: "GelatoReportDocumentOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_report_id_number_optionsSchema: { readonly description: ""; readonly properties: {}; readonly title: "GelatoReportIdNumberOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_selfie_reportSchema: { readonly description: "Result from a selfie check"; readonly properties: { readonly document: { readonly description: "ID of the [File](https://stripe.com/docs/api/files) holding the image of the identity document used in this check."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_selfie_report_error"; }]; readonly description: "Details on the verification error. Present when status is `unverified`."; readonly nullable: true; }; readonly selfie: { readonly description: "ID of the [File](https://stripe.com/docs/api/files) holding the image of the selfie used in this check."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Status of this `selfie` check."; readonly enum: readonly ["unverified", "verified"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["status"]; readonly title: "GelatoSelfieReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["error"]; }; export declare const gelato_selfie_report_errorSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification failure."; readonly enum: readonly ["selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "A human-readable message giving the reason for the failure. These messages can be shown to your users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoSelfieReportError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_session_document_optionsSchema: { readonly description: ""; readonly properties: { readonly allowed_types: { readonly description: "Array of strings of allowed identity document types. If the provided identity document isn’t one of the allowed types, the verification check will fail with a document_type_not_allowed error code."; readonly items: { readonly enum: readonly ["driving_license", "id_card", "passport"]; readonly type: "string"; }; readonly type: "array"; }; readonly require_id_number: { readonly description: "Collect an ID number and perform an [ID number check](https://stripe.com/docs/identity/verification-checks?type=id-number) with the document’s extracted name and date of birth."; readonly type: "boolean"; }; readonly require_live_capture: { readonly description: "Disable image uploads, identity document images have to be captured using the device’s camera."; readonly type: "boolean"; }; readonly require_matching_selfie: { readonly description: "Capture a face image and perform a [selfie check](https://stripe.com/docs/identity/verification-checks?type=selfie) comparing a photo ID and a picture of your user’s face. [Learn more](https://stripe.com/docs/identity/selfie)."; readonly type: "boolean"; }; }; readonly title: "GelatoSessionDocumentOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_session_email_optionsSchema: { readonly description: ""; readonly properties: { readonly require_verification: { readonly description: "Request one time password verification of `provided_details.email`."; readonly type: "boolean"; }; }; readonly title: "GelatoSessionEmailOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_session_id_number_optionsSchema: { readonly description: ""; readonly properties: {}; readonly title: "GelatoSessionIdNumberOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_session_last_errorSchema: { readonly description: "Shows last VerificationSession error"; readonly properties: { readonly code: { readonly description: "A short machine-readable string giving the reason for the verification or user-session failure."; readonly enum: readonly ["abandoned", "consent_declined", "country_not_supported", "device_not_supported", "document_expired", "document_type_not_supported", "document_unverified_other", "email_unverified_other", "email_verification_declined", "id_number_insufficient_document_data", "id_number_mismatch", "id_number_unverified_other", "phone_unverified_other", "phone_verification_declined", "selfie_document_missing_photo", "selfie_face_mismatch", "selfie_manipulated", "selfie_unverified_other", "under_supported_age"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly reason: { readonly description: "A message that explains the reason for verification or user-session failure."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoSessionLastError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_session_phone_optionsSchema: { readonly description: ""; readonly properties: { readonly require_verification: { readonly description: "Request one time password verification of `provided_details.phone`."; readonly type: "boolean"; }; }; readonly title: "GelatoSessionPhoneOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const gelato_verification_report_optionsSchema: { readonly description: ""; readonly properties: { readonly document: { readonly $ref: "#/components/schemas/gelato_report_document_options"; }; readonly id_number: { readonly $ref: "#/components/schemas/gelato_report_id_number_options"; }; }; readonly title: "GelatoVerificationReportOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["document", "id_number"]; }; export declare const gelato_verification_session_optionsSchema: { readonly description: ""; readonly properties: { readonly document: { readonly $ref: "#/components/schemas/gelato_session_document_options"; }; readonly email: { readonly $ref: "#/components/schemas/gelato_session_email_options"; }; readonly id_number: { readonly $ref: "#/components/schemas/gelato_session_id_number_options"; }; readonly phone: { readonly $ref: "#/components/schemas/gelato_session_phone_options"; }; }; readonly title: "GelatoVerificationSessionOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["document", "email", "id_number", "phone"]; }; export declare const gelato_verified_outputsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "The user's verified address."; readonly nullable: true; }; readonly dob: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_data_verified_outputs_date"; }]; readonly description: "The user’s verified date of birth."; readonly nullable: true; }; readonly email: { readonly description: "The user's verified email address"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly first_name: { readonly description: "The user's verified first name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id_number: { readonly description: "The user's verified id number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id_number_type: { readonly description: "The user's verified id number type."; readonly enum: readonly ["br_cpf", "sg_nric", "us_ssn"]; readonly nullable: true; readonly type: "string"; }; readonly last_name: { readonly description: "The user's verified last name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly phone: { readonly description: "The user's verified phone number"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "GelatoVerifiedOutputs"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "dob"]; }; export declare const identity_verification_reportSchema: { readonly description: "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results)."; readonly properties: { readonly client_reference_id: { readonly description: "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly document: { readonly $ref: "#/components/schemas/gelato_document_report"; }; readonly email: { readonly $ref: "#/components/schemas/gelato_email_report"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly id_number: { readonly $ref: "#/components/schemas/gelato_id_number_report"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["identity.verification_report"]; readonly type: "string"; }; readonly options: { readonly $ref: "#/components/schemas/gelato_verification_report_options"; }; readonly phone: { readonly $ref: "#/components/schemas/gelato_phone_report"; }; readonly selfie: { readonly $ref: "#/components/schemas/gelato_selfie_report"; }; readonly type: { readonly description: "Type of report."; readonly enum: readonly ["document", "id_number", "verification_flow"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly verification_flow: { readonly description: "The configuration token of a Verification Flow from the dashboard."; readonly maxLength: 5000; readonly type: "string"; }; readonly verification_session: { readonly description: "ID of the VerificationSession that created this report."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "type"]; readonly title: "GelatoVerificationReport"; readonly type: "object"; readonly 'x-expandableFields': readonly ["document", "email", "id_number", "options", "phone", "selfie"]; readonly 'x-resourceId': "identity.verification_report"; }; export declare const identity_verification_sessionSchema: { readonly description: "A VerificationSession guides you through the process of collecting and verifying the identities\nof your users. It contains details about the type of verification, such as what [verification\ncheck](/docs/identity/verification-checks) to perform. Only create one VerificationSession for\neach verification in your system.\n\nA VerificationSession transitions through [multiple\nstatuses](/docs/identity/how-sessions-work) throughout its lifetime as it progresses through\nthe verification flow. The VerificationSession contains the user's verified data after\nverification checks are complete.\n\nRelated guide: [The Verification Sessions API](https://stripe.com/docs/identity/verification-sessions)"; readonly properties: { readonly client_reference_id: { readonly description: "A string to reference this user. This can be a customer ID, a session ID, or similar, and can be used to reconcile this verification with your internal systems."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly client_secret: { readonly description: "The short-lived client secret used by Stripe.js to [show a verification modal](https://stripe.com/docs/js/identity/modal) inside your app. This client secret expires after 24 hours and can only be used once. Don’t store it, log it, embed it in a URL, or expose it to anyone other than the user. Make sure that you have TLS enabled on any page that includes the client secret. Refer to our docs on [passing the client secret to the frontend](https://stripe.com/docs/identity/verification-sessions#client-secret) to learn more."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last_error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_session_last_error"; }]; readonly description: "If present, this property tells you the last error encountered when processing the verification."; readonly nullable: true; }; readonly last_verification_report: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/identity.verification_report"; }]; readonly description: "ID of the most recent VerificationReport. [Learn more about accessing detailed verification results.](https://stripe.com/docs/identity/verification-sessions#results)"; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/identity.verification_report"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["identity.verification_session"]; readonly type: "string"; }; readonly options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_verification_session_options"; }]; readonly description: "A set of options for the session’s verification checks."; readonly nullable: true; }; readonly provided_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_provided_details"; }]; readonly description: "Details provided about the user being verified. These details may be shown to the user."; readonly nullable: true; }; readonly redaction: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/verification_session_redaction"; }]; readonly description: "Redaction status of this VerificationSession. If the VerificationSession is not redacted, this field will be null."; readonly nullable: true; }; readonly status: { readonly description: "Status of this VerificationSession. [Learn more about the lifecycle of sessions](https://stripe.com/docs/identity/how-sessions-work)."; readonly enum: readonly ["canceled", "processing", "requires_input", "verified"]; readonly type: "string"; }; readonly type: { readonly description: "The type of [verification check](https://stripe.com/docs/identity/verification-checks) to be performed."; readonly enum: readonly ["document", "id_number", "verification_flow"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly url: { readonly description: "The short-lived URL that you use to redirect a user to Stripe to submit their identity information. This URL expires after 48 hours and can only be used once. Don’t store it, log it, send it in emails or expose it to anyone other than the user. Refer to our docs on [verifying identity documents](https://stripe.com/docs/identity/verify-identity-documents?platform=web&type=redirect) to learn how to redirect users to Stripe."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verification_flow: { readonly description: "The configuration token of a Verification Flow from the dashboard."; readonly maxLength: 5000; readonly type: "string"; }; readonly verified_outputs: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/gelato_verified_outputs"; }]; readonly description: "The user’s verified data."; readonly nullable: true; }; }; readonly required: readonly ["created", "id", "livemode", "metadata", "object", "status", "type"]; readonly title: "GelatoVerificationSession"; readonly type: "object"; readonly 'x-expandableFields': readonly ["last_error", "last_verification_report", "options", "provided_details", "redaction", "verified_outputs"]; readonly 'x-resourceId': "identity.verification_session"; }; export declare const inbound_transfersSchema: { readonly description: ""; readonly properties: { readonly billing_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_billing_details"; }; readonly type: { readonly description: "The type of the payment method used in the InboundTransfer."; readonly enum: readonly ["us_bank_account"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/inbound_transfers_payment_method_details_us_bank_account"; }; }; readonly required: readonly ["billing_details", "type"]; readonly title: "InboundTransfers"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_details", "us_bank_account"]; }; export declare const inbound_transfers_payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Account holder type: individual or company."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "Account type: checkings or savings. Defaults to checking if omitted."; readonly enum: readonly ["checking", "savings"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the mandate used to make this payment."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly network: { readonly description: "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."; readonly enum: readonly ["ach"]; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["network"]; readonly title: "inbound_transfers_payment_method_details_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate"]; }; export declare const internal_cardSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Brand of the card used in the transaction"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two digit number representing the card's expiration month"; readonly nullable: true; readonly type: "integer"; }; readonly exp_year: { readonly description: "Two digit number representing the card's expiration year"; readonly nullable: true; readonly type: "integer"; }; readonly last4: { readonly description: "The last 4 digits of the card"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "internal_card"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoiceSchema: { readonly description: "Invoices are statements of amounts owed by a customer, and are either\ngenerated one-off, or generated periodically from a subscription.\n\nThey contain [invoice items](https://stripe.com/docs/api#invoiceitems), and proration adjustments\nthat may be caused by subscription upgrades/downgrades (if necessary).\n\nIf your invoice is configured to be billed through automatic charges,\nStripe automatically finalizes your invoice and attempts payment. Note\nthat finalizing the invoice,\n[when automatic](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection), does\nnot happen immediately as the invoice is created. Stripe waits\nuntil one hour after the last webhook was successfully sent (or the last\nwebhook timed out after failing). If you (and the platforms you may have\nconnected to) have no webhooks configured, Stripe waits one hour after\ncreation to finalize the invoice.\n\nIf your invoice is configured to be billed by sending an email, then based on your\n[email settings](https://dashboard.stripe.com/account/billing/automatic),\nStripe will email the invoice to your customer and await payment. These\nemails can contain a link to a hosted page to pay the invoice.\n\nStripe applies any customer credit on the account before determining the\namount due for the invoice (i.e., the amount that will be actually\ncharged). If the amount due for the invoice is less than Stripe's [minimum allowed charge\nper currency](/docs/currencies#minimum-and-maximum-charge-amounts), the\ninvoice is automatically marked paid, and we add the amount due to the\ncustomer's credit balance which is applied to the next invoice.\n\nMore details on the customer's credit balance are\n[here](https://stripe.com/docs/billing/customer/balance).\n\nRelated guide: [Send invoices to customers](https://stripe.com/docs/billing/invoices/sending)"; readonly properties: { readonly account_country: { readonly description: "The country of the business associated with this invoice, most often the business creating the invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_name: { readonly description: "The public name of the business associated with this invoice, most often the business creating the invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_tax_ids: { readonly description: "The account tax IDs associated with the invoice. Only editable when the invoice is a draft."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly amount_due: { readonly description: "Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`."; readonly type: "integer"; }; readonly amount_paid: { readonly description: "The amount, in cents (or local equivalent), that was paid."; readonly type: "integer"; }; readonly amount_remaining: { readonly description: "The difference between amount_due and amount_paid, in cents (or local equivalent)."; readonly type: "integer"; }; readonly amount_shipping: { readonly description: "This is the sum of all the shipping amounts."; readonly type: "integer"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "ID of the Connect Application that created the invoice."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly application_fee_amount: { readonly description: "The fee in cents (or local equivalent) that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid."; readonly nullable: true; readonly type: "integer"; }; readonly attempt_count: { readonly description: "Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule. If a failure is returned with a non-retryable return code, the invoice can no longer be retried unless a new payment method is obtained. Retries will continue to be scheduled, and attempt_count will continue to increment, but retries will only be executed if a new payment method is obtained."; readonly type: "integer"; }; readonly attempted: { readonly description: "Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users."; readonly type: "boolean"; }; readonly auto_advance: { readonly description: "Controls whether Stripe performs [automatic collection](https://stripe.com/docs/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action."; readonly type: "boolean"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/automatic_tax"; }; readonly billing_reason: { readonly description: "Indicates the reason why the invoice was created.\n\n* `manual`: Unrelated to a subscription, for example, created via the invoice editor.\n* `subscription`: No longer in use. Applies to subscriptions from before May 2018 where no distinction was made between updates, cycles, and thresholds.\n* `subscription_create`: A new subscription was created.\n* `subscription_cycle`: A subscription advanced into a new period.\n* `subscription_threshold`: A subscription reached a billing threshold.\n* `subscription_update`: A subscription was updated.\n* `upcoming`: Reserved for simulated invoices, per the upcoming invoice endpoint."; readonly enum: readonly ["automatic_pending_invoice_item_invoice", "manual", "quote_accept", "subscription", "subscription_create", "subscription_cycle", "subscription_threshold", "subscription_update", "upcoming"]; readonly nullable: true; readonly type: "string"; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the latest charge generated for this invoice, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly collection_method: { readonly description: "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions."; readonly enum: readonly ["charge_automatically", "send_invoice"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly custom_fields: { readonly description: "Custom fields displayed on the invoice."; readonly items: { readonly $ref: "#/components/schemas/invoice_setting_custom_field"; }; readonly nullable: true; readonly type: "array"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer who will be billed."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly customer_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated."; readonly nullable: true; }; readonly customer_email: { readonly description: "The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_name: { readonly description: "The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_phone: { readonly description: "The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated."; readonly nullable: true; }; readonly customer_tax_exempt: { readonly description: "The customer's tax exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated."; readonly enum: readonly ["exempt", "none", "reverse"]; readonly nullable: true; readonly type: "string"; }; readonly customer_tax_ids: { readonly description: "The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated."; readonly items: { readonly $ref: "#/components/schemas/invoices_resource_invoice_tax_id"; }; readonly nullable: true; readonly type: "array"; }; readonly default_payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly default_source: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly description: "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; }; readonly 'x-stripeBypassValidation': true; }; readonly default_tax_rates: { readonly description: "The tax rates applied to this invoice, if any."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly type: "array"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discount: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; readonly description: "Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts."; readonly nullable: true; }; readonly discounts: { readonly description: "The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }, { readonly $ref: "#/components/schemas/deleted_discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }, { readonly $ref: "#/components/schemas/deleted_discount"; }]; }; }; readonly type: "array"; }; readonly due_date: { readonly description: "The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly effective_at: { readonly description: "The date when this invoice is in effect. Same as `finalized_at` unless overwritten. When defined, this value replaces the system-generated 'Date of issue' printed on the invoice PDF and receipt."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly ending_balance: { readonly description: "Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null."; readonly nullable: true; readonly type: "integer"; }; readonly footer: { readonly description: "Footer displayed on the invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly from_invoice: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_from_invoice"; }]; readonly description: "Details of the invoice that was cloned. See the [revision documentation](https://stripe.com/docs/invoicing/invoice-revisions) for more details."; readonly nullable: true; }; readonly hosted_invoice_url: { readonly description: "The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://stripe.com/docs/api/invoices/upcoming) for more details."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice_pdf: { readonly description: "The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuer: { readonly $ref: "#/components/schemas/connect_account_reference"; }; readonly last_finalization_error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/api_errors"; }]; readonly description: "The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized."; readonly nullable: true; }; readonly latest_revision: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "The ID of the most recent non-draft revision of this invoice"; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly lines: { readonly description: "The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/line_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "InvoiceLinesList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly next_payment_attempt: { readonly description: "The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly number: { readonly description: "A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["invoice"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://stripe.com/docs/billing/invoices/connect) documentation for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly paid: { readonly description: "Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance."; readonly type: "boolean"; }; readonly paid_out_of_band: { readonly description: "Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on Stripe."; readonly type: "boolean"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly payment_settings: { readonly $ref: "#/components/schemas/invoices_payment_settings"; }; readonly period_end: { readonly description: "End of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."; readonly format: "unix-time"; readonly type: "integer"; }; readonly period_start: { readonly description: "Start of the usage period during which invoice items were added to this invoice. This looks back one period for a subscription invoice. Use the [line item period](/api/invoices/line_item#invoice_line_item_object-period) to get the service period for each price."; readonly format: "unix-time"; readonly type: "integer"; }; readonly post_payment_credit_notes_amount: { readonly description: "Total amount of all post-payment credit notes issued for this invoice."; readonly type: "integer"; }; readonly pre_payment_credit_notes_amount: { readonly description: "Total amount of all pre-payment credit notes issued for this invoice."; readonly type: "integer"; }; readonly quote: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/quote"; }]; readonly description: "The quote this invoice was generated from."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/quote"; }]; }; }; readonly receipt_number: { readonly description: "This is the transaction number that appears on email receipts sent for this invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly rendering: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_invoice_rendering"; }]; readonly description: "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page."; readonly nullable: true; }; readonly shipping_cost: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_shipping_cost"; }]; readonly description: "The details of the cost of shipping, including the ShippingRate applied on the invoice."; readonly nullable: true; }; readonly shipping_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer."; readonly nullable: true; }; readonly starting_balance: { readonly description: "Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice."; readonly type: "integer"; }; readonly statement_descriptor: { readonly description: "Extra information about an invoice for the customer's credit card statement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://stripe.com/docs/billing/invoices/workflow#workflow-overview)"; readonly enum: readonly ["draft", "open", "paid", "uncollectible", "void"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly status_transitions: { readonly $ref: "#/components/schemas/invoices_resource_status_transitions"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "The subscription that this invoice was prepared for, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly subscription_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_details_data"; }]; readonly description: "Details about the subscription that created this invoice."; readonly nullable: true; }; readonly subscription_proration_date: { readonly description: "Only set for upcoming invoices that preview prorations. The time used to calculate prorations."; readonly type: "integer"; }; readonly subtotal: { readonly description: "Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated"; readonly type: "integer"; }; readonly subtotal_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated"; readonly nullable: true; readonly type: "integer"; }; readonly tax: { readonly description: "The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice."; readonly nullable: true; readonly type: "integer"; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock this invoice belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; readonly threshold_reason: { readonly $ref: "#/components/schemas/invoice_threshold_reason"; }; readonly total: { readonly description: "Total after discounts and taxes."; readonly type: "integer"; }; readonly total_discount_amounts: { readonly description: "The aggregate amounts calculated per discount across all line items."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_discount_amount"; }; readonly nullable: true; readonly type: "array"; }; readonly total_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax."; readonly nullable: true; readonly type: "integer"; }; readonly total_tax_amounts: { readonly description: "The aggregate amounts calculated per tax rate for all line items."; readonly items: { readonly $ref: "#/components/schemas/invoice_tax_amount"; }; readonly type: "array"; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_transfer_data"; }]; readonly description: "The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice."; readonly nullable: true; }; readonly webhooks_delivered_at: { readonly description: "Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://stripe.com/docs/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount_due", "amount_paid", "amount_remaining", "amount_shipping", "attempt_count", "attempted", "automatic_tax", "collection_method", "created", "currency", "default_tax_rates", "discounts", "issuer", "lines", "livemode", "object", "paid", "paid_out_of_band", "payment_settings", "period_end", "period_start", "post_payment_credit_notes_amount", "pre_payment_credit_notes_amount", "starting_balance", "status_transitions", "subtotal", "total", "total_tax_amounts"]; readonly title: "Invoice"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "application", "automatic_tax", "charge", "custom_fields", "customer", "customer_address", "customer_shipping", "customer_tax_ids", "default_payment_method", "default_source", "default_tax_rates", "discount", "discounts", "from_invoice", "issuer", "last_finalization_error", "latest_revision", "lines", "on_behalf_of", "payment_intent", "payment_settings", "quote", "rendering", "shipping_cost", "shipping_details", "status_transitions", "subscription", "subscription_details", "test_clock", "threshold_reason", "total_discount_amounts", "total_tax_amounts", "transfer_data"]; readonly 'x-resourceId': "invoice"; }; export declare const invoice_installments_cardSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether Installments are enabled for this Invoice."; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "invoice_installments_card"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_item_threshold_reasonSchema: { readonly description: ""; readonly properties: { readonly line_item_ids: { readonly description: "The IDs of the line items that triggered the threshold invoice."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly usage_gte: { readonly description: "The quantity threshold boundary that applied to the given line item."; readonly type: "integer"; }; }; readonly required: readonly ["line_item_ids", "usage_gte"]; readonly title: "InvoiceItemThresholdReason"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_line_item_periodSchema: { readonly description: ""; readonly properties: { readonly end: { readonly description: "The end of the period, which must be greater than or equal to the start. This value is inclusive."; readonly format: "unix-time"; readonly type: "integer"; }; readonly start: { readonly description: "The start of the period. This value is inclusive."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["end", "start"]; readonly title: "InvoiceLineItemPeriod"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_mandate_options_cardSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount to be charged for future payments."; readonly nullable: true; readonly type: "integer"; }; readonly amount_type: { readonly description: "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."; readonly enum: readonly ["fixed", "maximum"]; readonly nullable: true; readonly type: "string"; }; readonly description: { readonly description: "A description of the mandate or subscription that is meant to be displayed to the customer."; readonly maxLength: 200; readonly nullable: true; readonly type: "string"; }; }; readonly title: "invoice_mandate_options_card"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_acss_debitSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly $ref: "#/components/schemas/invoice_payment_method_options_acss_debit_mandate_options"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "invoice_payment_method_options_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const invoice_payment_method_options_acss_debit_mandate_optionsSchema: { readonly description: ""; readonly properties: { readonly transaction_type: { readonly description: "Transaction type of the mandate."; readonly enum: readonly ["business", "personal"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "invoice_payment_method_options_acss_debit_mandate_options"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_bancontactSchema: { readonly description: ""; readonly properties: { readonly preferred_language: { readonly description: "Preferred language of the Bancontact authorization page that the customer is redirected to."; readonly enum: readonly ["de", "en", "fr", "nl"]; readonly type: "string"; }; }; readonly required: readonly ["preferred_language"]; readonly title: "invoice_payment_method_options_bancontact"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_cardSchema: { readonly description: ""; readonly properties: { readonly installments: { readonly $ref: "#/components/schemas/invoice_installments_card"; }; readonly request_three_d_secure: { readonly description: "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."; readonly enum: readonly ["any", "automatic", "challenge"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "invoice_payment_method_options_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["installments"]; }; export declare const invoice_payment_method_options_customer_balanceSchema: { readonly description: ""; readonly properties: { readonly bank_transfer: { readonly $ref: "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer"; }; readonly funding_type: { readonly description: "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."; readonly enum: readonly ["bank_transfer"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "invoice_payment_method_options_customer_balance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_transfer"]; }; export declare const invoice_payment_method_options_customer_balance_bank_transferSchema: { readonly description: ""; readonly properties: { readonly eu_bank_transfer: { readonly $ref: "#/components/schemas/invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"; }; readonly type: { readonly description: "The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."; readonly nullable: true; readonly type: "string"; }; }; readonly title: "invoice_payment_method_options_customer_balance_bank_transfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["eu_bank_transfer"]; }; export declare const invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transferSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`."; readonly enum: readonly ["BE", "DE", "ES", "FR", "IE", "NL"]; readonly type: "string"; }; }; readonly required: readonly ["country"]; readonly title: "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_konbiniSchema: { readonly description: ""; readonly properties: {}; readonly title: "invoice_payment_method_options_konbini"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_sepa_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "invoice_payment_method_options_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_payment_method_options_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly financial_connections: { readonly $ref: "#/components/schemas/invoice_payment_method_options_us_bank_account_linked_account_options"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "invoice_payment_method_options_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_connections"]; }; export declare const invoice_payment_method_options_us_bank_account_linked_account_optionsSchema: { readonly description: ""; readonly properties: { readonly permissions: { readonly description: "The list of permissions to request. The `payment_method` permission must be included."; readonly items: { readonly enum: readonly ["balances", "ownership", "payment_method", "transactions"]; readonly type: "string"; }; readonly type: "array"; }; readonly prefetch: { readonly description: "Data features requested to be retrieved upon account creation."; readonly items: { readonly enum: readonly ["balances", "ownership", "transactions"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "invoice_payment_method_options_us_bank_account_linked_account_options"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_rendering_pdfSchema: { readonly description: ""; readonly properties: { readonly page_size: { readonly description: "Page size of invoice pdf. Options include a4, letter, and auto. If set to auto, page size will be switched to a4 or letter based on customer locale."; readonly enum: readonly ["a4", "auto", "letter"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "InvoiceRenderingPdf"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_setting_custom_fieldSchema: { readonly description: ""; readonly properties: { readonly name: { readonly description: "The name of the custom field."; readonly maxLength: 5000; readonly type: "string"; }; readonly value: { readonly description: "The value of the custom field."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["name", "value"]; readonly title: "InvoiceSettingCustomField"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_setting_customer_rendering_optionsSchema: { readonly description: ""; readonly properties: { readonly amount_tax_display: { readonly description: "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "InvoiceSettingCustomerRenderingOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_setting_customer_settingSchema: { readonly description: ""; readonly properties: { readonly custom_fields: { readonly description: "Default custom fields to be displayed on invoices for this customer."; readonly items: { readonly $ref: "#/components/schemas/invoice_setting_custom_field"; }; readonly nullable: true; readonly type: "array"; }; readonly default_payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of a payment method that's attached to the customer, to be used as the customer's default payment method for subscriptions and invoices."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly footer: { readonly description: "Default footer to be displayed on invoices for this customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly rendering_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_setting_customer_rendering_options"; }]; readonly description: "Default options for invoice PDF rendering for this customer."; readonly nullable: true; }; }; readonly title: "InvoiceSettingCustomerSetting"; readonly type: "object"; readonly 'x-expandableFields': readonly ["custom_fields", "default_payment_method", "rendering_options"]; }; export declare const invoice_setting_quote_settingSchema: { readonly description: ""; readonly properties: { readonly days_until_due: { readonly description: "Number of days within which a customer must pay invoices generated by this quote. This value will be `null` for quotes where `collection_method=charge_automatically`."; readonly nullable: true; readonly type: "integer"; }; readonly issuer: { readonly $ref: "#/components/schemas/connect_account_reference"; }; }; readonly required: readonly ["issuer"]; readonly title: "InvoiceSettingQuoteSetting"; readonly type: "object"; readonly 'x-expandableFields': readonly ["issuer"]; }; export declare const invoice_setting_rendering_optionsSchema: { readonly description: ""; readonly properties: { readonly amount_tax_display: { readonly description: "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "InvoiceSettingRenderingOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoice_setting_subscription_schedule_phase_settingSchema: { readonly description: ""; readonly properties: { readonly account_tax_ids: { readonly description: "The account tax IDs associated with this phase of the subscription schedule. Will be set on invoices generated by this phase of the subscription schedule."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly days_until_due: { readonly description: "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."; readonly nullable: true; readonly type: "integer"; }; readonly issuer: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."; readonly nullable: true; }; }; readonly title: "InvoiceSettingSubscriptionSchedulePhaseSetting"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "issuer"]; }; export declare const invoice_setting_subscription_schedule_settingSchema: { readonly description: ""; readonly properties: { readonly account_tax_ids: { readonly description: "The account tax IDs associated with the subscription schedule. Will be set on invoices generated by the subscription schedule."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly days_until_due: { readonly description: "Number of days within which a customer must pay invoices generated by this subscription schedule. This value will be `null` for subscription schedules where `billing=charge_automatically`."; readonly nullable: true; readonly type: "integer"; }; readonly issuer: { readonly $ref: "#/components/schemas/connect_account_reference"; }; }; readonly required: readonly ["issuer"]; readonly title: "InvoiceSettingSubscriptionScheduleSetting"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "issuer"]; }; export declare const invoice_tax_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount, in cents (or local equivalent), of the tax."; readonly type: "integer"; }; readonly inclusive: { readonly description: "Whether this tax amount is inclusive or exclusive."; readonly type: "boolean"; }; readonly tax_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_rate"; }]; readonly description: "The tax rate that was applied to get this tax amount."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_rate"; }]; }; }; readonly taxability_reason: { readonly 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."; readonly enum: readonly ["customer_exempt", "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"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly taxable_amount: { readonly description: "The amount on which tax is calculated, in cents (or local equivalent)."; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "inclusive", "tax_rate"]; readonly title: "InvoiceTaxAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tax_rate"]; }; export declare const invoice_threshold_reasonSchema: { readonly description: ""; readonly properties: { readonly amount_gte: { readonly description: "The total invoice amount threshold boundary if it triggered the threshold invoice."; readonly nullable: true; readonly type: "integer"; }; readonly item_reasons: { readonly description: "Indicates which line items triggered a threshold invoice."; readonly items: { readonly $ref: "#/components/schemas/invoice_item_threshold_reason"; }; readonly type: "array"; }; }; readonly required: readonly ["item_reasons"]; readonly title: "InvoiceThresholdReason"; readonly type: "object"; readonly 'x-expandableFields': readonly ["item_reasons"]; }; export declare const invoice_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination."; readonly nullable: true; readonly type: "integer"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account where funds from the payment will be transferred to upon payment success."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "InvoiceTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const invoiceitemSchema: { readonly description: "Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an\ninvoice by creating or updating it with an `invoice` field, at which point it will be included as\n[an invoice line item](https://stripe.com/docs/api/invoices/line_item) within\n[invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items)."; readonly properties: { readonly amount: { readonly description: "Amount (in the `currency` specified) of the invoice item. This should always be equal to `unit_amount * quantity`."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The ID of the customer who will be billed when this invoice item is billed."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly date: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discountable: { readonly description: "If true, discounts will apply to this invoice item. Always false for prorations."; readonly type: "boolean"; }; readonly discounts: { readonly description: "The discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "The ID of the invoice this invoice item belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["invoiceitem"]; readonly type: "string"; }; readonly period: { readonly $ref: "#/components/schemas/invoice_line_item_period"; }; readonly price: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/price"; }]; readonly description: "The price of the invoice item."; readonly nullable: true; }; readonly proration: { readonly description: "Whether the invoice item was created automatically as a proration adjustment when the customer switched plans."; readonly type: "boolean"; }; readonly quantity: { readonly description: "Quantity of units for the invoice item. If the invoice item is a proration, the quantity of the subscription that the proration was computed for."; readonly type: "integer"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "The subscription that this invoice item has been created for, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly subscription_item: { readonly description: "The subscription item that this invoice item has been created for, if any."; readonly maxLength: 5000; readonly type: "string"; }; readonly tax_rates: { readonly description: "The tax rates which apply to the invoice item. When set, the `default_tax_rates` on the invoice do not apply to this invoice item."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock this invoice item belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; readonly unit_amount: { readonly description: "Unit amount (in the `currency` specified) of the invoice item."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency", "customer", "date", "discountable", "id", "livemode", "object", "period", "proration", "quantity"]; readonly title: "InvoiceItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer", "discounts", "invoice", "period", "price", "subscription", "tax_rates", "test_clock"]; readonly 'x-resourceId': "invoiceitem"; }; export declare const invoices_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_acss_debit"; }]; readonly description: "If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly bancontact: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_bancontact"; }]; readonly description: "If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly card: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_card"; }]; readonly description: "If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly customer_balance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_customer_balance"; }]; readonly description: "If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly konbini: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_konbini"; }]; readonly description: "If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly sepa_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_sepa_debit"; }]; readonly description: "If paying by `sepa_debit`, this sub-hash contains details about the SEPA Direct Debit payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly us_bank_account: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_us_bank_account"; }]; readonly description: "If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice’s PaymentIntent."; readonly nullable: true; }; }; readonly title: "InvoicesPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account"]; }; export declare const invoices_payment_settingsSchema: { readonly description: ""; readonly properties: { readonly default_mandate: { readonly description: "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_payment_method_options"; }]; readonly description: "Payment-method-specific configuration to provide to the invoice’s PaymentIntent."; readonly nullable: true; }; readonly payment_method_types: { readonly description: "The list of payment method types (e.g. card) to provide to the invoice’s PaymentIntent. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."; readonly items: { readonly enum: readonly ["ach_credit_transfer", "ach_debit", "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "konbini", "link", "p24", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "InvoicesPaymentSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_method_options"]; }; export declare const invoices_resource_from_invoiceSchema: { readonly description: ""; readonly properties: { readonly action: { readonly description: "The relation between this invoice and the cloned invoice"; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "The invoice that was cloned."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; }; readonly required: readonly ["action", "invoice"]; readonly title: "InvoicesResourceFromInvoice"; readonly type: "object"; readonly 'x-expandableFields': readonly ["invoice"]; }; export declare const invoices_resource_invoice_renderingSchema: { readonly description: ""; readonly properties: { readonly amount_tax_display: { readonly description: "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly pdf: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_rendering_pdf"; }]; readonly description: "Invoice pdf rendering options"; readonly nullable: true; }; }; readonly title: "InvoicesResourceInvoiceRendering"; readonly type: "object"; readonly 'x-expandableFields': readonly ["pdf"]; }; export declare const invoices_resource_invoice_tax_idSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`"; readonly enum: readonly ["ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat"]; readonly type: "string"; }; readonly value: { readonly description: "The value of the tax ID."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "InvoicesResourceInvoiceTaxID"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoices_resource_line_items_credited_itemsSchema: { readonly description: ""; readonly properties: { readonly invoice: { readonly description: "Invoice containing the credited invoice line items"; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice_line_items: { readonly description: "Credited invoice line items"; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["invoice", "invoice_line_items"]; readonly title: "InvoicesResourceLineItemsCreditedItems"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const invoices_resource_line_items_proration_detailsSchema: { readonly description: ""; readonly properties: { readonly credited_items: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_line_items_credited_items"; }]; readonly description: "For a credit proration `line_item`, the original debit line_items to which the credit proration applies."; readonly nullable: true; }; }; readonly title: "InvoicesResourceLineItemsProrationDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["credited_items"]; }; export declare const invoices_resource_shipping_costSchema: { readonly description: ""; readonly properties: { readonly amount_subtotal: { readonly description: "Total shipping cost before any taxes are applied."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total shipping cost after taxes are applied."; readonly type: "integer"; }; readonly shipping_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/shipping_rate"; }]; readonly description: "The ID of the ShippingRate for this invoice."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate"; }]; }; }; readonly taxes: { readonly description: "The taxes applied to the shipping rate."; readonly items: { readonly $ref: "#/components/schemas/line_items_tax_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["amount_subtotal", "amount_tax", "amount_total"]; readonly title: "InvoicesResourceShippingCost"; readonly type: "object"; readonly 'x-expandableFields': readonly ["shipping_rate", "taxes"]; }; export declare const invoices_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly finalized_at: { readonly description: "The time that the invoice draft was finalized."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly marked_uncollectible_at: { readonly description: "The time that the invoice was marked uncollectible."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly paid_at: { readonly description: "The time that the invoice was paid."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly voided_at: { readonly description: "The time that the invoice was voided."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "InvoicesResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorizationSchema: { readonly description: "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)"; readonly properties: { readonly amount: { readonly description: "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different."; readonly type: "integer"; }; readonly amount_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_amount_details"; }]; readonly description: "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; }; readonly approved: { readonly description: "Whether the authorization has been approved."; readonly type: "boolean"; }; readonly authorization_method: { readonly description: "How the card details were provided."; readonly enum: readonly ["chip", "contactless", "keyed_in", "online", "swipe"]; readonly type: "string"; }; readonly balance_transactions: { readonly description: "List of balance transactions associated with this authorization."; readonly items: { readonly $ref: "#/components/schemas/balance_transaction"; }; readonly type: "array"; }; readonly card: { readonly $ref: "#/components/schemas/issuing.card"; }; readonly cardholder: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.cardholder"; }]; readonly description: "The cardholder to whom this authorization belongs."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.cardholder"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. 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)."; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly merchant_amount: { readonly description: "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different."; readonly type: "integer"; }; readonly merchant_currency: { readonly description: "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. 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)."; readonly type: "string"; }; readonly merchant_data: { readonly $ref: "#/components/schemas/issuing_authorization_merchant_data"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly network_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_network_data"; }]; readonly description: "Details about the authorization, such as identifiers, set by the card network."; readonly nullable: true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.authorization"]; readonly type: "string"; }; readonly pending_request: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_pending_request"; }]; readonly description: "The pending authorization request. This field will only be non-null during an `issuing_authorization.request` webhook."; readonly nullable: true; }; readonly request_history: { readonly description: "History of every time a `pending_request` authorization was approved/declined, either by you directly or by Stripe (e.g. based on your spending_controls). If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined."; readonly items: { readonly $ref: "#/components/schemas/issuing_authorization_request"; }; readonly type: "array"; }; readonly status: { readonly description: "The current status of the authorization in its lifecycle."; readonly enum: readonly ["closed", "pending", "reversed"]; readonly type: "string"; }; readonly token: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.token"; }]; readonly description: "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this authorization. If a network token was not used for this authorization, this field will be null."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.token"; }]; }; }; readonly transactions: { readonly description: "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization."; readonly items: { readonly $ref: "#/components/schemas/issuing.transaction"; }; readonly type: "array"; }; readonly treasury: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_treasury"; }]; readonly description: "[Treasury](https://stripe.com/docs/api/treasury) details related to this authorization if it was created on a [FinancialAccount](https://stripe.com/docs/api/treasury/financial_accounts)."; readonly nullable: true; }; readonly verification_data: { readonly $ref: "#/components/schemas/issuing_authorization_verification_data"; }; readonly wallet: { readonly description: "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`. Will populate as `null` when no digital wallet was utilized."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "approved", "authorization_method", "balance_transactions", "card", "created", "currency", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "object", "request_history", "status", "transactions", "verification_data"]; readonly title: "IssuingAuthorization"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amount_details", "balance_transactions", "card", "cardholder", "merchant_data", "network_data", "pending_request", "request_history", "token", "transactions", "treasury", "verification_data"]; readonly 'x-resourceId': "issuing.authorization"; }; export declare const issuing_cardSchema: { readonly description: "You can [create physical or virtual cards](https://stripe.com/docs/issuing/cards) that are issued to cardholders."; readonly properties: { readonly brand: { readonly description: "The brand of the card."; readonly maxLength: 5000; readonly type: "string"; }; readonly cancellation_reason: { readonly description: "The reason why the card was canceled."; readonly enum: readonly ["design_rejected", "lost", "stolen"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly cardholder: { readonly $ref: "#/components/schemas/issuing.cardholder"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Supported currencies are `usd` in the US, `eur` in the EU, and `gbp` in the UK."; readonly type: "string"; }; readonly cvc: { readonly description: "The card's CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."; readonly maxLength: 5000; readonly type: "string"; }; readonly exp_month: { readonly description: "The expiration month of the card."; readonly type: "integer"; }; readonly exp_year: { readonly description: "The expiration year of the card."; readonly type: "integer"; }; readonly financial_account: { readonly description: "The financial account this card is attached to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "The last 4 digits of the card number."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly number: { readonly description: "The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with [the `expand` parameter](https://stripe.com/docs/api/expanding_objects). Additionally, it's only available via the [\"Retrieve a card\" endpoint](https://stripe.com/docs/api/issuing/cards/retrieve), not via \"List all cards\" or any other endpoint."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.card"]; readonly type: "string"; }; readonly personalization_design: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.personalization_design"; }]; readonly description: "The personalization design object belonging to this card."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.personalization_design"; }]; }; }; readonly replaced_by: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.card"; }]; readonly description: "The latest card that replaces this card, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.card"; }]; }; }; readonly replacement_for: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.card"; }]; readonly description: "The card this card replaces, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.card"; }]; }; }; readonly replacement_reason: { readonly description: "The reason why the previous card needed to be replaced."; readonly enum: readonly ["damaged", "expired", "lost", "stolen"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_card_shipping"; }]; readonly description: "Where and how the card will be shipped."; readonly nullable: true; }; readonly spending_controls: { readonly $ref: "#/components/schemas/issuing_card_authorization_controls"; }; readonly status: { readonly description: "Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to `inactive`."; readonly enum: readonly ["active", "canceled", "inactive"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: { readonly description: "The type of the card."; readonly enum: readonly ["physical", "virtual"]; readonly type: "string"; }; readonly wallets: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_card_wallets"; }]; readonly description: "Information relating to digital wallets (like Apple Pay and Google Pay)."; readonly nullable: true; }; }; readonly required: readonly ["brand", "cardholder", "created", "currency", "exp_month", "exp_year", "id", "last4", "livemode", "metadata", "object", "spending_controls", "status", "type"]; readonly title: "IssuingCard"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cardholder", "personalization_design", "replaced_by", "replacement_for", "shipping", "spending_controls", "wallets"]; readonly 'x-resourceId': "issuing.card"; }; export declare const issuing_cardholderSchema: { readonly description: "An Issuing `Cardholder` object represents an individual or business entity who is [issued](https://stripe.com/docs/issuing) cards.\n\nRelated guide: [How to create a cardholder](https://stripe.com/docs/issuing/cards#create-cardholder)"; readonly properties: { readonly billing: { readonly $ref: "#/components/schemas/issuing_cardholder_address"; }; readonly company: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_company"; }]; readonly description: "Additional information about a `company` cardholder."; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly email: { readonly description: "The cardholder's email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly individual: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_individual"; }]; readonly description: "Additional information about an `individual` cardholder."; readonly nullable: true; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly name: { readonly description: "The cardholder's name. This will be printed on cards issued to them."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.cardholder"]; readonly type: "string"; }; readonly phone_number: { readonly description: "The cardholder's phone number. This is required for all cardholders who will be creating EU cards. See the [3D Secure documentation](https://stripe.com/docs/issuing/3d-secure#when-is-3d-secure-applied) for more details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_locales: { readonly description: "The cardholder’s preferred locales (languages), ordered by preference. Locales can be `de`, `en`, `es`, `fr`, or `it`.\n This changes the language of the [3D Secure flow](https://stripe.com/docs/issuing/3d-secure) and one-time password messages sent to the cardholder."; readonly items: { readonly enum: readonly ["de", "en", "es", "fr", "it"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly requirements: { readonly $ref: "#/components/schemas/issuing_cardholder_requirements"; }; readonly spending_controls: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_authorization_controls"; }]; readonly description: "Rules that control spending across this cardholder's cards. Refer to our [documentation](https://stripe.com/docs/issuing/controls/spending-controls) for more details."; readonly nullable: true; }; readonly status: { readonly description: "Specifies whether to permit authorizations on this cardholder's cards."; readonly enum: readonly ["active", "blocked", "inactive"]; readonly type: "string"; }; readonly type: { readonly description: "One of `individual` or `company`. See [Choose a cardholder type](https://stripe.com/docs/issuing/other/choose-cardholder) for more details."; readonly enum: readonly ["company", "individual"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["billing", "created", "id", "livemode", "metadata", "name", "object", "requirements", "status", "type"]; readonly title: "IssuingCardholder"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing", "company", "individual", "requirements", "spending_controls"]; readonly 'x-resourceId': "issuing.cardholder"; }; export declare const issuing_disputeSchema: { readonly description: "As a [card issuer](https://stripe.com/docs/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.\n\nRelated guide: [Issuing disputes](https://stripe.com/docs/issuing/purchases/disputes)"; readonly properties: { readonly amount: { readonly description: "Disputed amount in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation)."; readonly type: "integer"; }; readonly balance_transactions: { readonly description: "List of balance transactions associated with the dispute."; readonly items: { readonly $ref: "#/components/schemas/balance_transaction"; }; readonly nullable: true; readonly type: "array"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "The currency the `transaction` was made in."; readonly type: "string"; }; readonly evidence: { readonly $ref: "#/components/schemas/issuing_dispute_evidence"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly loss_reason: { readonly description: "The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values."; readonly enum: readonly ["cardholder_authentication_issuer_liability", "eci5_token_transaction_with_tavv", "excess_disputes_in_timeframe", "has_not_met_the_minimum_dispute_amount_requirements", "invalid_duplicate_dispute", "invalid_incorrect_amount_dispute", "invalid_no_authorization", "invalid_use_of_disputes", "merchandise_delivered_or_shipped", "merchandise_or_service_as_described", "not_cancelled", "other", "refund_issued", "submitted_beyond_allowable_time_limit", "transaction_3ds_required", "transaction_approved_after_prior_fraud_dispute", "transaction_authorized", "transaction_electronically_read", "transaction_qualifies_for_visa_easy_payment_service", "transaction_unattended"]; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.dispute"]; readonly type: "string"; }; readonly status: { readonly description: "Current status of the dispute."; readonly enum: readonly ["expired", "lost", "submitted", "unsubmitted", "won"]; readonly type: "string"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.transaction"; }]; readonly description: "The transaction being disputed."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.transaction"; }]; }; }; readonly treasury: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_dispute_treasury"; }]; readonly description: "[Treasury](https://stripe.com/docs/api/treasury) details related to this dispute if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"; readonly nullable: true; }; }; readonly required: readonly ["amount", "created", "currency", "evidence", "id", "livemode", "metadata", "object", "status", "transaction"]; readonly title: "IssuingDispute"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transactions", "evidence", "transaction", "treasury"]; readonly 'x-resourceId': "issuing.dispute"; }; export declare const issuing_personalization_designSchema: { readonly description: "A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line."; readonly properties: { readonly card_logo: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The file for the card logo to use with physical bundles that support card logos. Must have a `purpose` value of `issuing_logo`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly carrier_text: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_personalization_design_carrier_text"; }]; readonly description: "Hash containing carrier text, for use with physical bundles that support carrier text."; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly lookup_key: { readonly description: "A lookup key used to retrieve personalization designs dynamically from a static string. This may be up to 200 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly name: { readonly description: "Friendly display name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.personalization_design"]; readonly type: "string"; }; readonly physical_bundle: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.physical_bundle"; }]; readonly description: "The physical bundle object belonging to this personalization design."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.physical_bundle"; }]; }; }; readonly preferences: { readonly $ref: "#/components/schemas/issuing_personalization_design_preferences"; }; readonly rejection_reasons: { readonly $ref: "#/components/schemas/issuing_personalization_design_rejection_reasons"; }; readonly status: { readonly description: "Whether this personalization design can be used to create cards."; readonly enum: readonly ["active", "inactive", "rejected", "review"]; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "metadata", "object", "physical_bundle", "preferences", "rejection_reasons", "status"]; readonly title: "IssuingPersonalizationDesign"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card_logo", "carrier_text", "physical_bundle", "preferences", "rejection_reasons"]; readonly 'x-resourceId': "issuing.personalization_design"; }; export declare const issuing_physical_bundleSchema: { readonly description: "A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card."; readonly properties: { readonly features: { readonly $ref: "#/components/schemas/issuing_physical_bundle_features"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly name: { readonly description: "Friendly display name."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.physical_bundle"]; readonly type: "string"; }; readonly status: { readonly description: "Whether this physical bundle can be used to create cards."; readonly enum: readonly ["active", "inactive", "review"]; readonly type: "string"; }; readonly type: { readonly description: "Whether this physical bundle is a standard Stripe offering or custom-made for you."; readonly enum: readonly ["custom", "standard"]; readonly type: "string"; }; }; readonly required: readonly ["features", "id", "livemode", "name", "object", "status", "type"]; readonly title: "IssuingPhysicalBundle"; readonly type: "object"; readonly 'x-expandableFields': readonly ["features"]; readonly 'x-resourceId': "issuing.physical_bundle"; }; export declare const issuing_settlementSchema: { readonly description: "When a non-stripe BIN is used, any use of an [issued card](https://stripe.com/docs/issuing) must be settled directly with the card network. The net amount owed is represented by an Issuing `Settlement` object."; readonly properties: { readonly bin: { readonly description: "The Bank Identification Number reflecting this settlement record."; readonly maxLength: 5000; readonly type: "string"; }; readonly clearing_date: { readonly description: "The date that the transactions are cleared and posted to user's accounts."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly interchange_fees: { readonly description: "The total interchange received as reimbursement for the transactions."; readonly type: "integer"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly net_total: { readonly description: "The total net amount required to settle with the network."; readonly type: "integer"; }; readonly network: { readonly description: "The card network for this settlement report. One of [\"visa\"]"; readonly enum: readonly ["visa"]; readonly type: "string"; }; readonly network_fees: { readonly description: "The total amount of fees owed to the network."; readonly type: "integer"; }; readonly network_settlement_identifier: { readonly description: "The Settlement Identification Number assigned by the network."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.settlement"]; readonly type: "string"; }; readonly settlement_service: { readonly description: "One of `international` or `uk_national_net`."; readonly maxLength: 5000; readonly type: "string"; }; readonly transaction_count: { readonly description: "The total number of transactions reflected in this settlement."; readonly type: "integer"; }; readonly transaction_volume: { readonly description: "The total transaction amount reflected in this settlement."; readonly type: "integer"; }; }; readonly required: readonly ["bin", "clearing_date", "created", "currency", "id", "interchange_fees", "livemode", "metadata", "net_total", "network", "network_fees", "network_settlement_identifier", "object", "settlement_service", "transaction_count", "transaction_volume"]; readonly title: "IssuingSettlement"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "issuing.settlement"; }; export declare const issuing_tokenSchema: { readonly description: "An issuing token object is created when an issued card is added to a digital wallet. As a [card issuer](https://stripe.com/docs/issuing), you can [view and manage these tokens](https://stripe.com/docs/issuing/controls/token-management) through Stripe."; readonly properties: { readonly card: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.card"; }]; readonly description: "Card associated with this token."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.card"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly device_fingerprint: { readonly description: "The hashed ID derived from the device ID from the card network associated with the token."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the token."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly network: { readonly description: "The token service provider / card network associated with the token."; readonly enum: readonly ["mastercard", "visa"]; readonly type: "string"; }; readonly network_data: { readonly $ref: "#/components/schemas/issuing_network_token_network_data"; }; readonly network_updated_at: { readonly description: "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.token"]; readonly type: "string"; }; readonly status: { readonly description: "The usage state of the token."; readonly enum: readonly ["active", "deleted", "requested", "suspended"]; readonly type: "string"; }; readonly wallet_provider: { readonly description: "The digital wallet for this token, if one was used."; readonly enum: readonly ["apple_pay", "google_pay", "samsung_pay"]; readonly type: "string"; }; }; readonly required: readonly ["card", "created", "id", "livemode", "network", "network_updated_at", "object", "status"]; readonly title: "IssuingNetworkToken"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card", "network_data"]; readonly 'x-resourceId': "issuing.token"; }; export declare const issuing_transactionSchema: { readonly description: "Any use of an [issued card](https://stripe.com/docs/issuing) that results in funds entering or leaving\nyour Stripe account, such as a completed purchase or refund, is represented by an Issuing\n`Transaction` object.\n\nRelated guide: [Issued card transactions](https://stripe.com/docs/issuing/purchases/transactions)"; readonly properties: { readonly amount: { readonly description: "The transaction amount, which will be reflected in your balance. This amount is in your currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly amount_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_amount_details"; }]; readonly description: "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; }; readonly authorization: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.authorization"; }]; readonly description: "The `Authorization` object that led to this transaction."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.authorization"; }]; }; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "ID of the [balance transaction](https://stripe.com/docs/api/balance_transactions) associated with this transaction."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly card: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.card"; }]; readonly description: "The card used to make this transaction."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.card"; }]; }; }; readonly cardholder: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.cardholder"; }]; readonly description: "The cardholder to whom this transaction belongs."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.cardholder"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly dispute: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.dispute"; }]; readonly description: "If you've disputed the transaction, the ID of the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.dispute"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly merchant_amount: { readonly description: "The amount that the merchant will receive, denominated in `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). It will be different from `amount` if the merchant is taking payment in a different currency."; readonly type: "integer"; }; readonly merchant_currency: { readonly description: "The currency with which the merchant is taking payment."; readonly type: "string"; }; readonly merchant_data: { readonly $ref: "#/components/schemas/issuing_authorization_merchant_data"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly network_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_network_data"; }]; readonly description: "Details about the transaction, such as processing dates, set by the card network."; readonly nullable: true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["issuing.transaction"]; readonly type: "string"; }; readonly purchase_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_purchase_details"; }]; readonly description: "Additional purchase information that is optionally provided by the merchant."; readonly nullable: true; }; readonly token: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/issuing.token"; }]; readonly description: "[Token](https://stripe.com/docs/api/issuing/tokens/object) object used for this transaction. If a network token was not used for this transaction, this field will be null."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/issuing.token"; }]; }; }; readonly treasury: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_treasury"; }]; readonly description: "[Treasury](https://stripe.com/docs/api/treasury) details related to this transaction if it was created on a [FinancialAccount](/docs/api/treasury/financial_accounts"; readonly nullable: true; }; readonly type: { readonly description: "The nature of the transaction."; readonly enum: readonly ["capture", "refund"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly wallet: { readonly description: "The digital wallet used for this transaction. One of `apple_pay`, `google_pay`, or `samsung_pay`."; readonly enum: readonly ["apple_pay", "google_pay", "samsung_pay"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "card", "created", "currency", "id", "livemode", "merchant_amount", "merchant_currency", "merchant_data", "metadata", "object", "type"]; readonly title: "IssuingTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amount_details", "authorization", "balance_transaction", "card", "cardholder", "dispute", "merchant_data", "network_data", "purchase_details", "token", "treasury"]; readonly 'x-resourceId': "issuing.transaction"; }; export declare const issuing_authorization_amount_detailsSchema: { readonly description: ""; readonly properties: { readonly atm_fee: { readonly description: "The fee charged by the ATM for the cash withdrawal."; readonly nullable: true; readonly type: "integer"; }; readonly cashback_amount: { readonly description: "The amount of cash requested by the cardholder."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingAuthorizationAmountDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_authentication_exemptionSchema: { readonly description: ""; readonly properties: { readonly claimed_by: { readonly description: "The entity that requested the exemption, either the acquiring merchant or the Issuing user."; readonly enum: readonly ["acquirer", "issuer"]; readonly type: "string"; }; readonly type: { readonly description: "The specific exemption claimed for this authorization."; readonly enum: readonly ["low_value_transaction", "transaction_risk_analysis", "unknown"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["claimed_by", "type"]; readonly title: "IssuingAuthorizationAuthenticationExemption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_merchant_dataSchema: { readonly description: ""; readonly properties: { readonly category: { readonly description: "A categorization of the seller's type of business. See our [merchant categories guide](https://stripe.com/docs/issuing/merchant-categories) for a list of possible values."; readonly maxLength: 5000; readonly type: "string"; }; readonly category_code: { readonly description: "The merchant category code for the seller’s business"; readonly maxLength: 5000; readonly type: "string"; }; readonly city: { readonly description: "City where the seller is located"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Country where the seller is located"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Name of the seller"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly network_id: { readonly description: "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant."; readonly maxLength: 5000; readonly type: "string"; }; readonly postal_code: { readonly description: "Postal code where the seller is located"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly state: { readonly description: "State where the seller is located"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly terminal_id: { readonly description: "An ID assigned by the seller to the location of the sale."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "URL provided by the merchant on a 3DS request"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["category", "category_code", "network_id"]; readonly title: "IssuingAuthorizationMerchantData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_network_dataSchema: { readonly description: ""; readonly properties: { readonly acquiring_institution_id: { readonly description: "Identifier assigned to the acquirer by the card network. Sometimes this value is not provided by the network; in this case, the value will be `null`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly system_trace_audit_number: { readonly description: "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingAuthorizationNetworkData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_pending_requestSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The additional amount Stripe will hold if the authorization is approved, in the card's [currency](https://stripe.com/docs/api#issuing_authorization_object-pending-request-currency) and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly amount_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_amount_details"; }]; readonly description: "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly is_amount_controllable: { readonly description: "If set `true`, you may provide [amount](https://stripe.com/docs/api/issuing/authorizations/approve#approve_issuing_authorization-amount) to control how much to hold for the authorization."; readonly type: "boolean"; }; readonly merchant_amount: { readonly description: "The amount the merchant is requesting to be authorized in the `merchant_currency`. The amount is in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly merchant_currency: { readonly description: "The local currency the merchant is requesting to authorize."; readonly type: "string"; }; readonly network_risk_score: { readonly description: "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "currency", "is_amount_controllable", "merchant_amount", "merchant_currency"]; readonly title: "IssuingAuthorizationPendingRequest"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amount_details"]; }; export declare const issuing_authorization_requestSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The `pending_request.amount` at the time of the request, presented in your card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). Stripe held this amount from your account to fund the authorization if the request was approved."; readonly type: "integer"; }; readonly amount_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_amount_details"; }]; readonly description: "Detailed breakdown of amount components. These amounts are denominated in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; }; readonly approved: { readonly description: "Whether this request was approved."; readonly type: "boolean"; }; readonly authorization_code: { readonly description: "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly merchant_amount: { readonly description: "The `pending_request.merchant_amount` at the time of the request, presented in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly merchant_currency: { readonly description: "The currency that was collected by the merchant and presented to the cardholder for the authorization. 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly network_risk_score: { readonly description: "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99."; readonly nullable: true; readonly type: "integer"; }; readonly reason: { readonly description: "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome."; readonly enum: readonly ["account_disabled", "card_active", "card_inactive", "cardholder_inactive", "cardholder_verification_required", "insufficient_funds", "not_allowed", "spending_controls", "suspected_fraud", "verification_failed", "webhook_approved", "webhook_declined", "webhook_error", "webhook_timeout"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly reason_message: { readonly description: "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly requested_at: { readonly description: "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "approved", "created", "currency", "merchant_amount", "merchant_currency", "reason"]; readonly title: "IssuingAuthorizationRequest"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amount_details"]; }; export declare const issuing_authorization_three_d_secureSchema: { readonly description: ""; readonly properties: { readonly result: { readonly description: "The outcome of the 3D Secure authentication request."; readonly enum: readonly ["attempt_acknowledged", "authenticated", "failed", "required"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["result"]; readonly title: "IssuingAuthorizationThreeDSecure"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_treasurySchema: { readonly description: ""; readonly properties: { readonly received_credits: { readonly description: "The array of [ReceivedCredits](https://stripe.com/docs/api/treasury/received_credits) associated with this authorization"; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly received_debits: { readonly description: "The array of [ReceivedDebits](https://stripe.com/docs/api/treasury/received_debits) associated with this authorization"; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly transaction: { readonly description: "The Treasury [Transaction](https://stripe.com/docs/api/treasury/transactions) associated with this authorization"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["received_credits", "received_debits"]; readonly title: "IssuingAuthorizationTreasury"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_authorization_verification_dataSchema: { readonly description: ""; readonly properties: { readonly address_line1_check: { readonly description: "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`."; readonly enum: readonly ["match", "mismatch", "not_provided"]; readonly type: "string"; }; readonly address_postal_code_check: { readonly description: "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`."; readonly enum: readonly ["match", "mismatch", "not_provided"]; readonly type: "string"; }; readonly authentication_exemption: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_authentication_exemption"; }]; readonly description: "The exemption applied to this authorization."; readonly nullable: true; }; readonly cvc_check: { readonly description: "Whether the cardholder provided a CVC and if it matched Stripe’s record."; readonly enum: readonly ["match", "mismatch", "not_provided"]; readonly type: "string"; }; readonly expiry_check: { readonly description: "Whether the cardholder provided an expiry date and if it matched Stripe’s record."; readonly enum: readonly ["match", "mismatch", "not_provided"]; readonly type: "string"; }; readonly postal_code: { readonly description: "The postal code submitted as part of the authorization used for postal code verification."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly three_d_secure: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_authorization_three_d_secure"; }]; readonly description: "3D Secure details."; readonly nullable: true; }; }; readonly required: readonly ["address_line1_check", "address_postal_code_check", "cvc_check", "expiry_check"]; readonly title: "IssuingAuthorizationVerificationData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["authentication_exemption", "three_d_secure"]; }; export declare const issuing_card_apple_paySchema: { readonly description: ""; readonly properties: { readonly eligible: { readonly description: "Apple Pay Eligibility"; readonly type: "boolean"; }; readonly ineligible_reason: { readonly description: "Reason the card is ineligible for Apple Pay"; readonly enum: readonly ["missing_agreement", "missing_cardholder_contact", "unsupported_region"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["eligible"]; readonly title: "IssuingCardApplePay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_card_authorization_controlsSchema: { readonly description: ""; readonly properties: { readonly allowed_categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly allowed_merchant_countries: { readonly description: "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly blocked_categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly blocked_merchant_countries: { readonly description: "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly spending_limits: { readonly description: "Limit spending with amount-based rules that apply across any cards this card replaced (i.e., its `replacement_for` card and _that_ card's `replacement_for` card, up the chain)."; readonly items: { readonly $ref: "#/components/schemas/issuing_card_spending_limit"; }; readonly nullable: true; readonly type: "array"; }; readonly spending_limits_currency: { readonly description: "Currency of the amounts within `spending_limits`. Always the same as the currency of the card."; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingCardAuthorizationControls"; readonly type: "object"; readonly 'x-expandableFields': readonly ["spending_limits"]; }; export declare const issuing_card_google_paySchema: { readonly description: ""; readonly properties: { readonly eligible: { readonly description: "Google Pay Eligibility"; readonly type: "boolean"; }; readonly ineligible_reason: { readonly description: "Reason the card is ineligible for Google Pay"; readonly enum: readonly ["missing_agreement", "missing_cardholder_contact", "unsupported_region"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["eligible"]; readonly title: "IssuingCardGooglePay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_card_shippingSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly carrier: { readonly description: "The delivery company that shipped a card."; readonly enum: readonly ["dhl", "fedex", "royal_mail", "usps"]; readonly nullable: true; readonly type: "string"; }; readonly customs: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_card_shipping_customs"; }]; readonly description: "Additional information that may be required for clearing customs."; readonly nullable: true; }; readonly eta: { readonly description: "A unix timestamp representing a best estimate of when the card will be delivered."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly name: { readonly description: "Recipient name."; readonly maxLength: 5000; readonly type: "string"; }; readonly phone_number: { readonly description: "The phone number of the receiver of the shipment. Our courier partners will use this number to contact you in the event of card delivery issues. For individual shipments to the EU/UK, if this field is empty, we will provide them with the phone number provided when the cardholder was initially created."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly require_signature: { readonly description: "Whether a signature is required for card delivery. This feature is only supported for US users. Standard shipping service does not support signature on delivery. The default value for standard shipping service is false and for express and priority services is true."; readonly nullable: true; readonly type: "boolean"; }; readonly service: { readonly description: "Shipment service, such as `standard` or `express`."; readonly enum: readonly ["express", "priority", "standard"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly status: { readonly description: "The delivery status of the card."; readonly enum: readonly ["canceled", "delivered", "failure", "pending", "returned", "shipped"]; readonly nullable: true; readonly type: "string"; }; readonly tracking_number: { readonly description: "A tracking number for a card shipment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tracking_url: { readonly description: "A link to the shipping carrier's site where you can view detailed information about a card shipment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "Packaging options."; readonly enum: readonly ["bulk", "individual"]; readonly type: "string"; }; }; readonly required: readonly ["address", "name", "service", "type"]; readonly title: "IssuingCardShipping"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "customs"]; }; export declare const issuing_card_shipping_customsSchema: { readonly description: ""; readonly properties: { readonly eori_number: { readonly description: "A registration number used for customs in Europe. See [https://www.gov.uk/eori](https://www.gov.uk/eori) for the UK and [https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en](https://ec.europa.eu/taxation_customs/business/customs-procedures-import-and-export/customs-procedures/economic-operators-registration-and-identification-number-eori_en) for the EU."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingCardShippingCustoms"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_card_spending_limitSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly interval: { readonly description: "Interval (or event) to which the amount applies."; readonly enum: readonly ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "interval"]; readonly title: "IssuingCardSpendingLimit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_card_walletsSchema: { readonly description: ""; readonly properties: { readonly apple_pay: { readonly $ref: "#/components/schemas/issuing_card_apple_pay"; }; readonly google_pay: { readonly $ref: "#/components/schemas/issuing_card_google_pay"; }; readonly primary_account_identifier: { readonly description: "Unique identifier for a card used with digital wallets"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["apple_pay", "google_pay"]; readonly title: "IssuingCardWallets"; readonly type: "object"; readonly 'x-expandableFields': readonly ["apple_pay", "google_pay"]; }; export declare const issuing_cardholder_addressSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; }; readonly required: readonly ["address"]; readonly title: "IssuingCardholderAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const issuing_cardholder_authorization_controlsSchema: { readonly description: ""; readonly properties: { readonly allowed_categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to allow. All other categories will be blocked. Cannot be set with `blocked_categories`."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly allowed_merchant_countries: { readonly description: "Array of strings containing representing countries from which authorizations will be allowed. Authorizations from merchants in all other countries will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `blocked_merchant_countries`. Provide an empty value to unset this control."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly blocked_categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) of authorizations to decline. All other categories will be allowed. Cannot be set with `allowed_categories`."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly blocked_merchant_countries: { readonly description: "Array of strings containing representing countries from which authorizations will be declined. Country codes should be ISO 3166 alpha-2 country codes (e.g. `US`). Cannot be set with `allowed_merchant_countries`. Provide an empty value to unset this control."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly spending_limits: { readonly description: "Limit spending with amount-based rules that apply across this cardholder's cards."; readonly items: { readonly $ref: "#/components/schemas/issuing_cardholder_spending_limit"; }; readonly nullable: true; readonly type: "array"; }; readonly spending_limits_currency: { readonly description: "Currency of the amounts within `spending_limits`."; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingCardholderAuthorizationControls"; readonly type: "object"; readonly 'x-expandableFields': readonly ["spending_limits"]; }; export declare const issuing_cardholder_card_issuingSchema: { readonly description: ""; readonly properties: { readonly user_terms_acceptance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_user_terms_acceptance"; }]; readonly description: "Information about cardholder acceptance of Celtic [Authorized User Terms](https://stripe.com/docs/issuing/cards#accept-authorized-user-terms). Required for cards backed by a Celtic program."; readonly nullable: true; }; }; readonly title: "IssuingCardholderCardIssuing"; readonly type: "object"; readonly 'x-expandableFields': readonly ["user_terms_acceptance"]; }; export declare const issuing_cardholder_companySchema: { readonly description: ""; readonly properties: { readonly tax_id_provided: { readonly description: "Whether the company's business ID number was provided."; readonly type: "boolean"; }; }; readonly required: readonly ["tax_id_provided"]; readonly title: "IssuingCardholderCompany"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_cardholder_id_documentSchema: { readonly description: ""; readonly properties: { readonly back: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly front: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; }; readonly title: "IssuingCardholderIdDocument"; readonly type: "object"; readonly 'x-expandableFields': readonly ["back", "front"]; }; export declare const issuing_cardholder_individualSchema: { readonly description: ""; readonly properties: { readonly card_issuing: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_card_issuing"; }]; readonly description: "Information related to the card_issuing program for this cardholder."; readonly nullable: true; }; readonly dob: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_individual_dob"; }]; readonly description: "The date of birth of this cardholder."; readonly nullable: true; }; readonly first_name: { readonly description: "The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last_name: { readonly description: "The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verification: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_verification"; }]; readonly description: "Government-issued ID document for this cardholder."; readonly nullable: true; }; }; readonly title: "IssuingCardholderIndividual"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card_issuing", "dob", "verification"]; }; export declare const issuing_cardholder_individual_dobSchema: { readonly description: ""; readonly properties: { readonly day: { readonly description: "The day of birth, between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "The month of birth, between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year of birth."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingCardholderIndividualDOB"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_cardholder_requirementsSchema: { readonly description: ""; readonly properties: { readonly disabled_reason: { readonly description: "If `disabled_reason` is present, all cards will decline authorizations with `cardholder_verification_required` reason."; readonly enum: readonly ["listed", "rejected.listed", "requirements.past_due", "under_review"]; readonly nullable: true; readonly type: "string"; }; readonly past_due: { readonly description: "Array of fields that need to be collected in order to verify and re-enable the cardholder."; readonly items: { readonly enum: readonly ["company.tax_id", "individual.card_issuing.user_terms_acceptance.date", "individual.card_issuing.user_terms_acceptance.ip", "individual.dob.day", "individual.dob.month", "individual.dob.year", "individual.first_name", "individual.last_name", "individual.verification.document"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "IssuingCardholderRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_cardholder_spending_limitSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Maximum amount allowed to spend per interval. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly categories: { readonly description: "Array of strings containing [categories](https://stripe.com/docs/api#issuing_authorization_object-merchant_data-category) this limit applies to. Omitting this field will apply the limit to all categories."; readonly items: { readonly enum: readonly ["ac_refrigeration_repair", "accounting_bookkeeping_services", "advertising_services", "agricultural_cooperative", "airlines_air_carriers", "airports_flying_fields", "ambulance_services", "amusement_parks_carnivals", "antique_reproductions", "antique_shops", "aquariums", "architectural_surveying_services", "art_dealers_and_galleries", "artists_supply_and_craft_shops", "auto_and_home_supply_stores", "auto_body_repair_shops", "auto_paint_shops", "auto_service_shops", "automated_cash_disburse", "automated_fuel_dispensers", "automobile_associations", "automotive_parts_and_accessories_stores", "automotive_tire_stores", "bail_and_bond_payments", "bakeries", "bands_orchestras", "barber_and_beauty_shops", "betting_casino_gambling", "bicycle_shops", "billiard_pool_establishments", "boat_dealers", "boat_rentals_and_leases", "book_stores", "books_periodicals_and_newspapers", "bowling_alleys", "bus_lines", "business_secretarial_schools", "buying_shopping_services", "cable_satellite_and_other_pay_television_and_radio", "camera_and_photographic_supply_stores", "candy_nut_and_confectionery_stores", "car_and_truck_dealers_new_used", "car_and_truck_dealers_used_only", "car_rental_agencies", "car_washes", "carpentry_services", "carpet_upholstery_cleaning", "caterers", "charitable_and_social_service_organizations_fundraising", "chemicals_and_allied_products", "child_care_services", "childrens_and_infants_wear_stores", "chiropodists_podiatrists", "chiropractors", "cigar_stores_and_stands", "civic_social_fraternal_associations", "cleaning_and_maintenance", "clothing_rental", "colleges_universities", "commercial_equipment", "commercial_footwear", "commercial_photography_art_and_graphics", "commuter_transport_and_ferries", "computer_network_services", "computer_programming", "computer_repair", "computer_software_stores", "computers_peripherals_and_software", "concrete_work_services", "construction_materials", "consulting_public_relations", "correspondence_schools", "cosmetic_stores", "counseling_services", "country_clubs", "courier_services", "court_costs", "credit_reporting_agencies", "cruise_lines", "dairy_products_stores", "dance_hall_studios_schools", "dating_escort_services", "dentists_orthodontists", "department_stores", "detective_agencies", "digital_goods_applications", "digital_goods_games", "digital_goods_large_volume", "digital_goods_media", "direct_marketing_catalog_merchant", "direct_marketing_combination_catalog_and_retail_merchant", "direct_marketing_inbound_telemarketing", "direct_marketing_insurance_services", "direct_marketing_other", "direct_marketing_outbound_telemarketing", "direct_marketing_subscription", "direct_marketing_travel", "discount_stores", "doctors", "door_to_door_sales", "drapery_window_covering_and_upholstery_stores", "drinking_places", "drug_stores_and_pharmacies", "drugs_drug_proprietaries_and_druggist_sundries", "dry_cleaners", "durable_goods", "duty_free_stores", "eating_places_restaurants", "educational_services", "electric_razor_stores", "electric_vehicle_charging", "electrical_parts_and_equipment", "electrical_services", "electronics_repair_shops", "electronics_stores", "elementary_secondary_schools", "emergency_services_gcas_visa_use_only", "employment_temp_agencies", "equipment_rental", "exterminating_services", "family_clothing_stores", "fast_food_restaurants", "financial_institutions", "fines_government_administrative_entities", "fireplace_fireplace_screens_and_accessories_stores", "floor_covering_stores", "florists", "florists_supplies_nursery_stock_and_flowers", "freezer_and_locker_meat_provisioners", "fuel_dealers_non_automotive", "funeral_services_crematories", "furniture_home_furnishings_and_equipment_stores_except_appliances", "furniture_repair_refinishing", "furriers_and_fur_shops", "general_services", "gift_card_novelty_and_souvenir_shops", "glass_paint_and_wallpaper_stores", "glassware_crystal_stores", "golf_courses_public", "government_licensed_horse_dog_racing_us_region_only", "government_licensed_online_casions_online_gambling_us_region_only", "government_owned_lotteries_non_us_region", "government_owned_lotteries_us_region_only", "government_services", "grocery_stores_supermarkets", "hardware_equipment_and_supplies", "hardware_stores", "health_and_beauty_spas", "hearing_aids_sales_and_supplies", "heating_plumbing_a_c", "hobby_toy_and_game_shops", "home_supply_warehouse_stores", "hospitals", "hotels_motels_and_resorts", "household_appliance_stores", "industrial_supplies", "information_retrieval_services", "insurance_default", "insurance_underwriting_premiums", "intra_company_purchases", "jewelry_stores_watches_clocks_and_silverware_stores", "landscaping_services", "laundries", "laundry_cleaning_services", "legal_services_attorneys", "luggage_and_leather_goods_stores", "lumber_building_materials_stores", "manual_cash_disburse", "marinas_service_and_supplies", "marketplaces", "masonry_stonework_and_plaster", "massage_parlors", "medical_and_dental_labs", "medical_dental_ophthalmic_and_hospital_equipment_and_supplies", "medical_services", "membership_organizations", "mens_and_boys_clothing_and_accessories_stores", "mens_womens_clothing_stores", "metal_service_centers", "miscellaneous", "miscellaneous_apparel_and_accessory_shops", "miscellaneous_auto_dealers", "miscellaneous_business_services", "miscellaneous_food_stores", "miscellaneous_general_merchandise", "miscellaneous_general_services", "miscellaneous_home_furnishing_specialty_stores", "miscellaneous_publishing_and_printing", "miscellaneous_recreation_services", "miscellaneous_repair_shops", "miscellaneous_specialty_retail", "mobile_home_dealers", "motion_picture_theaters", "motor_freight_carriers_and_trucking", "motor_homes_dealers", "motor_vehicle_supplies_and_new_parts", "motorcycle_shops_and_dealers", "motorcycle_shops_dealers", "music_stores_musical_instruments_pianos_and_sheet_music", "news_dealers_and_newsstands", "non_fi_money_orders", "non_fi_stored_value_card_purchase_load", "nondurable_goods", "nurseries_lawn_and_garden_supply_stores", "nursing_personal_care", "office_and_commercial_furniture", "opticians_eyeglasses", "optometrists_ophthalmologist", "orthopedic_goods_prosthetic_devices", "osteopaths", "package_stores_beer_wine_and_liquor", "paints_varnishes_and_supplies", "parking_lots_garages", "passenger_railways", "pawn_shops", "pet_shops_pet_food_and_supplies", "petroleum_and_petroleum_products", "photo_developing", "photographic_photocopy_microfilm_equipment_and_supplies", "photographic_studios", "picture_video_production", "piece_goods_notions_and_other_dry_goods", "plumbing_heating_equipment_and_supplies", "political_organizations", "postal_services_government_only", "precious_stones_and_metals_watches_and_jewelry", "professional_services", "public_warehousing_and_storage", "quick_copy_repro_and_blueprint", "railroads", "real_estate_agents_and_managers_rentals", "record_stores", "recreational_vehicle_rentals", "religious_goods_stores", "religious_organizations", "roofing_siding_sheet_metal", "secretarial_support_services", "security_brokers_dealers", "service_stations", "sewing_needlework_fabric_and_piece_goods_stores", "shoe_repair_hat_cleaning", "shoe_stores", "small_appliance_repair", "snowmobile_dealers", "special_trade_services", "specialty_cleaning", "sporting_goods_stores", "sporting_recreation_camps", "sports_and_riding_apparel_stores", "sports_clubs_fields", "stamp_and_coin_stores", "stationary_office_supplies_printing_and_writing_paper", "stationery_stores_office_and_school_supply_stores", "swimming_pools_sales", "t_ui_travel_germany", "tailors_alterations", "tax_payments_government_agencies", "tax_preparation_services", "taxicabs_limousines", "telecommunication_equipment_and_telephone_sales", "telecommunication_services", "telegraph_services", "tent_and_awning_shops", "testing_laboratories", "theatrical_ticket_agencies", "timeshares", "tire_retreading_and_repair", "tolls_bridge_fees", "tourist_attractions_and_exhibits", "towing_services", "trailer_parks_campgrounds", "transportation_services", "travel_agencies_tour_operators", "truck_stop_iteration", "truck_utility_trailer_rentals", "typesetting_plate_making_and_related_services", "typewriter_stores", "u_s_federal_government_agencies_or_departments", "uniforms_commercial_clothing", "used_merchandise_and_secondhand_stores", "utilities", "variety_stores", "veterinary_services", "video_amusement_game_supplies", "video_game_arcades", "video_tape_rental_stores", "vocational_trade_schools", "watch_jewelry_repair", "welding_repair", "wholesale_clubs", "wig_and_toupee_stores", "wires_money_orders", "womens_accessory_and_specialty_shops", "womens_ready_to_wear_stores", "wrecking_and_salvage_yards"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly interval: { readonly description: "Interval (or event) to which the amount applies."; readonly enum: readonly ["all_time", "daily", "monthly", "per_authorization", "weekly", "yearly"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "interval"]; readonly title: "IssuingCardholderSpendingLimit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_cardholder_user_terms_acceptanceSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the cardholder accepted the Authorized User Terms."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the cardholder accepted the Authorized User Terms."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the cardholder accepted the Authorized User Terms."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingCardholderUserTermsAcceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_cardholder_verificationSchema: { readonly description: ""; readonly properties: { readonly document: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_cardholder_id_document"; }]; readonly description: "An identifying document, either a passport or local ID card."; readonly nullable: true; }; }; readonly title: "IssuingCardholderVerification"; readonly type: "object"; readonly 'x-expandableFields': readonly ["document"]; }; export declare const issuing_dispute_canceled_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly canceled_at: { readonly description: "Date when order was canceled."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancellation_policy_provided: { readonly description: "Whether the cardholder was provided with a cancellation policy."; readonly nullable: true; readonly type: "boolean"; }; readonly cancellation_reason: { readonly description: "Reason for canceling the order."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly expected_at: { readonly description: "Date when the cardholder expected to receive the product."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_description: { readonly description: "Description of the merchandise or service that was purchased."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_type: { readonly description: "Whether the product was a merchandise or service."; readonly enum: readonly ["merchandise", "service"]; readonly nullable: true; readonly type: "string"; }; readonly return_status: { readonly description: "Result of cardholder's attempt to return the product."; readonly enum: readonly ["merchant_rejected", "successful"]; readonly nullable: true; readonly type: "string"; }; readonly returned_at: { readonly description: "Date when the product was returned or attempted to be returned."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingDisputeCanceledEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_duplicate_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly card_statement: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the card statement showing that the product had already been paid for."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly cash_receipt: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Copy of the receipt showing that the product had been paid for in cash."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly check_image: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Image of the front and back of the check that was used to pay for the product."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly original_transaction: { readonly description: "Transaction (e.g., ipi_...) that the disputed transaction is a duplicate of. Of the two or more transactions that are copies of each other, this is original undisputed one."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingDisputeDuplicateEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation", "card_statement", "cash_receipt", "check_image"]; }; export declare const issuing_dispute_evidenceSchema: { readonly description: ""; readonly properties: { readonly canceled: { readonly $ref: "#/components/schemas/issuing_dispute_canceled_evidence"; }; readonly duplicate: { readonly $ref: "#/components/schemas/issuing_dispute_duplicate_evidence"; }; readonly fraudulent: { readonly $ref: "#/components/schemas/issuing_dispute_fraudulent_evidence"; }; readonly merchandise_not_as_described: { readonly $ref: "#/components/schemas/issuing_dispute_merchandise_not_as_described_evidence"; }; readonly no_valid_authorization: { readonly $ref: "#/components/schemas/issuing_dispute_no_valid_authorization_evidence"; }; readonly not_received: { readonly $ref: "#/components/schemas/issuing_dispute_not_received_evidence"; }; readonly other: { readonly $ref: "#/components/schemas/issuing_dispute_other_evidence"; }; readonly reason: { readonly description: "The reason for filing the dispute. Its value will match the field containing the evidence."; readonly enum: readonly ["canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly service_not_as_described: { readonly $ref: "#/components/schemas/issuing_dispute_service_not_as_described_evidence"; }; }; readonly required: readonly ["reason"]; readonly title: "IssuingDisputeEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["canceled", "duplicate", "fraudulent", "merchandise_not_as_described", "no_valid_authorization", "not_received", "other", "service_not_as_described"]; }; export declare const issuing_dispute_fraudulent_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingDisputeFraudulentEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_merchandise_not_as_described_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly received_at: { readonly description: "Date when the product was received."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly return_description: { readonly description: "Description of the cardholder's attempt to return the product."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly return_status: { readonly description: "Result of cardholder's attempt to return the product."; readonly enum: readonly ["merchant_rejected", "successful"]; readonly nullable: true; readonly type: "string"; }; readonly returned_at: { readonly description: "Date when the product was returned or attempted to be returned."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingDisputeMerchandiseNotAsDescribedEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_no_valid_authorization_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingDisputeNoValidAuthorizationEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_not_received_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly expected_at: { readonly description: "Date when the cardholder expected to receive the product."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_description: { readonly description: "Description of the merchandise or service that was purchased."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_type: { readonly description: "Whether the product was a merchandise or service."; readonly enum: readonly ["merchandise", "service"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingDisputeNotReceivedEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_other_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_description: { readonly description: "Description of the merchandise or service that was purchased."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly product_type: { readonly description: "Whether the product was a merchandise or service."; readonly enum: readonly ["merchandise", "service"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingDisputeOtherEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_service_not_as_described_evidenceSchema: { readonly description: ""; readonly properties: { readonly additional_documentation: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly canceled_at: { readonly description: "Date when order was canceled."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancellation_reason: { readonly description: "Reason for canceling the order."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly explanation: { readonly description: "Explanation of why the cardholder is disputing this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly received_at: { readonly description: "Date when the product was received."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingDisputeServiceNotAsDescribedEvidence"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_documentation"]; }; export declare const issuing_dispute_treasurySchema: { readonly description: ""; readonly properties: { readonly debit_reversal: { readonly description: "The Treasury [DebitReversal](https://stripe.com/docs/api/treasury/debit_reversals) representing this Issuing dispute"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly received_debit: { readonly description: "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) that is being disputed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["received_debit"]; readonly title: "IssuingDisputeTreasury"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_network_token_addressSchema: { readonly description: ""; readonly properties: { readonly line1: { readonly description: "The street address of the cardholder tokenizing the card."; readonly maxLength: 5000; readonly type: "string"; }; readonly postal_code: { readonly description: "The postal code of the cardholder tokenizing the card."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["line1", "postal_code"]; readonly title: "IssuingNetworkTokenAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_network_token_deviceSchema: { readonly description: ""; readonly properties: { readonly device_fingerprint: { readonly description: "An obfuscated ID derived from the device ID."; readonly maxLength: 5000; readonly type: "string"; }; readonly ip_address: { readonly description: "The IP address of the device at provisioning time."; readonly maxLength: 5000; readonly type: "string"; }; readonly location: { readonly description: "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "The name of the device used for tokenization."; readonly maxLength: 5000; readonly type: "string"; }; readonly phone_number: { readonly description: "The phone number of the device used for tokenization."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "The type of device used for tokenization."; readonly enum: readonly ["other", "phone", "watch"]; readonly type: "string"; }; }; readonly title: "IssuingNetworkTokenDevice"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_network_token_mastercardSchema: { readonly description: ""; readonly properties: { readonly card_reference_id: { readonly description: "A unique reference ID from MasterCard to represent the card account number."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_reference_id: { readonly description: "The network-unique identifier for the token."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_requestor_id: { readonly description: "The ID of the entity requesting tokenization, specific to MasterCard."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_requestor_name: { readonly description: "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["token_reference_id", "token_requestor_id"]; readonly title: "IssuingNetworkTokenMastercard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_network_token_network_dataSchema: { readonly description: ""; readonly properties: { readonly device: { readonly $ref: "#/components/schemas/issuing_network_token_device"; }; readonly mastercard: { readonly $ref: "#/components/schemas/issuing_network_token_mastercard"; }; readonly type: { readonly description: "The network that the token is associated with. An additional hash is included with a name matching this value, containing tokenization data specific to the card network."; readonly enum: readonly ["mastercard", "visa"]; readonly type: "string"; }; readonly visa: { readonly $ref: "#/components/schemas/issuing_network_token_visa"; }; readonly wallet_provider: { readonly $ref: "#/components/schemas/issuing_network_token_wallet_provider"; }; }; readonly required: readonly ["type"]; readonly title: "IssuingNetworkTokenNetworkData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["device", "mastercard", "visa", "wallet_provider"]; }; export declare const issuing_network_token_visaSchema: { readonly description: ""; readonly properties: { readonly card_reference_id: { readonly description: "A unique reference ID from Visa to represent the card account number."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_reference_id: { readonly description: "The network-unique identifier for the token."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_requestor_id: { readonly description: "The ID of the entity requesting tokenization, specific to Visa."; readonly maxLength: 5000; readonly type: "string"; }; readonly token_risk_score: { readonly description: "Degree of risk associated with the token between `01` and `99`, with higher number indicating higher risk. A `00` value indicates the token was not scored by Visa."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["card_reference_id", "token_reference_id", "token_requestor_id"]; readonly title: "IssuingNetworkTokenVisa"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_network_token_wallet_providerSchema: { readonly description: ""; readonly properties: { readonly account_id: { readonly description: "The wallet provider-given account ID of the digital wallet the token belongs to."; readonly maxLength: 5000; readonly type: "string"; }; readonly account_trust_score: { readonly description: "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy."; readonly type: "integer"; }; readonly card_number_source: { readonly description: "The method used for tokenizing a card."; readonly enum: readonly ["app", "manual", "on_file", "other"]; readonly type: "string"; }; readonly cardholder_address: { readonly $ref: "#/components/schemas/issuing_network_token_address"; }; readonly cardholder_name: { readonly description: "The name of the cardholder tokenizing the card."; readonly maxLength: 5000; readonly type: "string"; }; readonly device_trust_score: { readonly description: "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy."; readonly type: "integer"; }; readonly hashed_account_email_address: { readonly description: "The hashed email address of the cardholder's account with the wallet provider."; readonly maxLength: 5000; readonly type: "string"; }; readonly reason_codes: { readonly description: "The reasons for suggested tokenization given by the card network."; readonly items: { readonly enum: readonly ["account_card_too_new", "account_recently_changed", "account_too_new", "account_too_new_since_launch", "additional_device", "data_expired", "defer_id_v_decision", "device_recently_lost", "good_activity_history", "has_suspended_tokens", "high_risk", "inactive_account", "long_account_tenure", "low_account_score", "low_device_score", "low_phone_number_score", "network_service_error", "outside_home_territory", "provisioning_cardholder_mismatch", "provisioning_device_and_cardholder_mismatch", "provisioning_device_mismatch", "same_device_no_prior_authentication", "same_device_successful_prior_authentication", "software_update", "suspicious_activity", "too_many_different_cardholders", "too_many_recent_attempts", "too_many_recent_tokens"]; readonly type: "string"; }; readonly type: "array"; }; readonly suggested_decision: { readonly description: "The recommendation on responding to the tokenization request."; readonly enum: readonly ["approve", "decline", "require_auth"]; readonly type: "string"; }; readonly suggested_decision_version: { readonly description: "The version of the standard for mapping reason codes followed by the wallet provider."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "IssuingNetworkTokenWalletProvider"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cardholder_address"]; }; export declare const issuing_personalization_design_carrier_textSchema: { readonly description: ""; readonly properties: { readonly footer_body: { readonly description: "The footer body text of the carrier letter."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly footer_title: { readonly description: "The footer title text of the carrier letter."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly header_body: { readonly description: "The header body text of the carrier letter."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly header_title: { readonly description: "The header title text of the carrier letter."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingPersonalizationDesignCarrierText"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_personalization_design_preferencesSchema: { readonly description: ""; readonly properties: { readonly is_default: { readonly description: "Whether we use this personalization design to create cards when one isn't specified. A connected account uses the Connect platform's default design if no personalization design is set as the default design."; readonly type: "boolean"; }; readonly is_platform_default: { readonly description: "Whether this personalization design is used to create cards when one is not specified and a default for this connected account does not exist."; readonly nullable: true; readonly type: "boolean"; }; }; readonly required: readonly ["is_default"]; readonly title: "IssuingPersonalizationDesignPreferences"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_personalization_design_rejection_reasonsSchema: { readonly description: ""; readonly properties: { readonly card_logo: { readonly description: "The reason(s) the card logo was rejected."; readonly items: { readonly enum: readonly ["geographic_location", "inappropriate", "network_name", "non_binary_image", "non_fiat_currency", "other", "other_entity", "promotional_material"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly carrier_text: { readonly description: "The reason(s) the carrier text was rejected."; readonly items: { readonly enum: readonly ["geographic_location", "inappropriate", "network_name", "non_fiat_currency", "other", "other_entity", "promotional_material"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "IssuingPersonalizationDesignRejectionReasons"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_physical_bundle_featuresSchema: { readonly description: ""; readonly properties: { readonly card_logo: { readonly description: "The policy for how to use card logo images in a card design with this physical bundle."; readonly enum: readonly ["optional", "required", "unsupported"]; readonly type: "string"; }; readonly carrier_text: { readonly description: "The policy for how to use carrier letter text in a card design with this physical bundle."; readonly enum: readonly ["optional", "required", "unsupported"]; readonly type: "string"; }; readonly second_line: { readonly description: "The policy for how to use a second line on a card with this physical bundle."; readonly enum: readonly ["optional", "required", "unsupported"]; readonly type: "string"; }; }; readonly required: readonly ["card_logo", "carrier_text", "second_line"]; readonly title: "IssuingPhysicalBundleFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_amount_detailsSchema: { readonly description: ""; readonly properties: { readonly atm_fee: { readonly description: "The fee charged by the ATM for the cash withdrawal."; readonly nullable: true; readonly type: "integer"; }; readonly cashback_amount: { readonly description: "The amount of cash requested by the cardholder."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingTransactionAmountDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_flight_dataSchema: { readonly description: ""; readonly properties: { readonly departure_at: { readonly description: "The time that the flight departed."; readonly nullable: true; readonly type: "integer"; }; readonly passenger_name: { readonly description: "The name of the passenger."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly refundable: { readonly description: "Whether the ticket is refundable."; readonly nullable: true; readonly type: "boolean"; }; readonly segments: { readonly description: "The legs of the trip."; readonly items: { readonly $ref: "#/components/schemas/issuing_transaction_flight_data_leg"; }; readonly nullable: true; readonly type: "array"; }; readonly travel_agency: { readonly description: "The travel agency that issued the ticket."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingTransactionFlightData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["segments"]; }; export declare const issuing_transaction_flight_data_legSchema: { readonly description: ""; readonly properties: { readonly arrival_airport_code: { readonly description: "The three-letter IATA airport code of the flight's destination."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly carrier: { readonly description: "The airline carrier code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly departure_airport_code: { readonly description: "The three-letter IATA airport code that the flight departed from."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly flight_number: { readonly description: "The flight number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly service_class: { readonly description: "The flight's service class."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly stopover_allowed: { readonly description: "Whether a stopover is allowed on this flight."; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "IssuingTransactionFlightDataLeg"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_fuel_dataSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`."; readonly maxLength: 5000; readonly type: "string"; }; readonly unit: { readonly description: "The units for `volume_decimal`. One of `liter`, `us_gallon`, or `other`."; readonly maxLength: 5000; readonly type: "string"; }; readonly unit_cost_decimal: { readonly description: "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places."; readonly format: "decimal"; readonly type: "string"; }; readonly volume_decimal: { readonly description: "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["type", "unit", "unit_cost_decimal"]; readonly title: "IssuingTransactionFuelData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_lodging_dataSchema: { readonly description: ""; readonly properties: { readonly check_in_at: { readonly description: "The time of checking into the lodging."; readonly nullable: true; readonly type: "integer"; }; readonly nights: { readonly description: "The number of nights stayed at the lodging."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingTransactionLodgingData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_network_dataSchema: { readonly description: ""; readonly properties: { readonly authorization_code: { readonly description: "A code created by Stripe which is shared with the merchant to validate the authorization. This field will be populated if the authorization message was approved. The code typically starts with the letter \"S\", followed by a six-digit number. For example, \"S498162\". Please note that the code is not guaranteed to be unique across authorizations."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly processing_date: { readonly description: "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingTransactionNetworkData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_purchase_detailsSchema: { readonly description: ""; readonly properties: { readonly flight: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_flight_data"; }]; readonly description: "Information about the flight that was purchased with this transaction."; readonly nullable: true; }; readonly fuel: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_fuel_data"; }]; readonly description: "Information about fuel that was purchased with this transaction."; readonly nullable: true; }; readonly lodging: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/issuing_transaction_lodging_data"; }]; readonly description: "Information about lodging that was purchased with this transaction."; readonly nullable: true; }; readonly receipt: { readonly description: "The line items in the purchase."; readonly items: { readonly $ref: "#/components/schemas/issuing_transaction_receipt_data"; }; readonly nullable: true; readonly type: "array"; }; readonly reference: { readonly description: "A merchant-specific order number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingTransactionPurchaseDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["flight", "fuel", "lodging", "receipt"]; }; export declare const issuing_transaction_receipt_dataSchema: { readonly description: ""; readonly properties: { readonly description: { readonly description: "The description of the item. The maximum length of this field is 26 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly quantity: { readonly description: "The quantity of the item."; readonly nullable: true; readonly type: "number"; }; readonly total: { readonly description: "The total for this line item in cents."; readonly nullable: true; readonly type: "integer"; }; readonly unit_cost: { readonly description: "The unit cost of the item in cents."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "IssuingTransactionReceiptData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const issuing_transaction_treasurySchema: { readonly description: ""; readonly properties: { readonly received_credit: { readonly description: "The Treasury [ReceivedCredit](https://stripe.com/docs/api/treasury/received_credits) representing this Issuing transaction if it is a refund"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly received_debit: { readonly description: "The Treasury [ReceivedDebit](https://stripe.com/docs/api/treasury/received_debits) representing this Issuing transaction if it is a capture"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "IssuingTransactionTreasury"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const itemSchema: { readonly description: "A line item."; readonly properties: { readonly amount_discount: { readonly description: "Total discount amount applied. If no discounts were applied, defaults to 0."; readonly type: "integer"; }; readonly amount_subtotal: { readonly description: "Total before any discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "Total tax amount applied. If no tax was applied, defaults to 0."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total after discounts and taxes."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users. Defaults to product name."; readonly maxLength: 5000; readonly type: "string"; }; readonly discounts: { readonly description: "The discounts applied to the line item."; readonly items: { readonly $ref: "#/components/schemas/line_items_discount_amount"; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["item"]; readonly type: "string"; }; readonly price: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/price"; }]; readonly description: "The price used to generate the line item."; readonly nullable: true; }; readonly quantity: { readonly description: "The quantity of products being purchased."; readonly nullable: true; readonly type: "integer"; }; readonly taxes: { readonly description: "The taxes applied to the line item."; readonly items: { readonly $ref: "#/components/schemas/line_items_tax_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["amount_discount", "amount_subtotal", "amount_tax", "amount_total", "currency", "description", "id", "object"]; readonly title: "LineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discounts", "price", "taxes"]; readonly 'x-resourceId': "item"; }; export declare const legal_entity_companySchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly address_kana: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_japan_address"; }]; readonly description: "The Kana variation of the company's primary address (Japan only)."; readonly nullable: true; }; readonly address_kanji: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_japan_address"; }]; readonly description: "The Kanji variation of the company's primary address (Japan only)."; readonly nullable: true; }; readonly directors_provided: { readonly description: "Whether the company's directors have been provided. This Boolean will be `true` if you've manually indicated that all directors are provided via [the `directors_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-directors_provided)."; readonly type: "boolean"; }; readonly executives_provided: { readonly description: "Whether the company's executives have been provided. This Boolean will be `true` if you've manually indicated that all executives are provided via [the `executives_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-executives_provided), or if Stripe determined that sufficient executives were provided."; readonly type: "boolean"; }; readonly export_license_id: { readonly description: "The export license ID number of the company, also referred as Import Export Code (India only)."; readonly maxLength: 5000; readonly type: "string"; }; readonly export_purpose_code: { readonly description: "The purpose code to use for export transactions (India only)."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "The company's legal name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name_kana: { readonly description: "The Kana variation of the company's legal name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name_kanji: { readonly description: "The Kanji variation of the company's legal name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly owners_provided: { readonly description: "Whether the company's owners have been provided. This Boolean will be `true` if you've manually indicated that all owners are provided via [the `owners_provided` parameter](https://stripe.com/docs/api/accounts/update#update_account-company-owners_provided), or if Stripe determined that sufficient owners were provided. Stripe determines ownership requirements using both the number of owners provided and their total percent ownership (calculated by adding the `percent_ownership` of each owner together)."; readonly type: "boolean"; }; readonly ownership_declaration: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_ubo_declaration"; }]; readonly description: "This hash is used to attest that the beneficial owner information provided to Stripe is both current and correct."; readonly nullable: true; }; readonly phone: { readonly description: "The company's phone number (used for verification)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly structure: { readonly description: "The category identifying the legal structure of the company or legal entity. See [Business structure](https://stripe.com/docs/connect/identity-verification#business-structure) for more details."; readonly enum: readonly ["free_zone_establishment", "free_zone_llc", "government_instrumentality", "governmental_unit", "incorporated_non_profit", "incorporated_partnership", "limited_liability_partnership", "llc", "multi_member_llc", "private_company", "private_corporation", "private_partnership", "public_company", "public_corporation", "public_partnership", "registered_charity", "single_member_llc", "sole_establishment", "sole_proprietorship", "tax_exempt_government_instrumentality", "unincorporated_association", "unincorporated_non_profit", "unincorporated_partnership"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly tax_id_provided: { readonly description: "Whether the company's business ID number was provided."; readonly type: "boolean"; }; readonly tax_id_registrar: { readonly description: "The jurisdiction in which the `tax_id` is registered (Germany-based companies only)."; readonly maxLength: 5000; readonly type: "string"; }; readonly vat_id_provided: { readonly description: "Whether the company's business VAT number was provided."; readonly type: "boolean"; }; readonly verification: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_company_verification"; }]; readonly description: "Information on the verification state of the company."; readonly nullable: true; }; }; readonly title: "LegalEntityCompany"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "address_kana", "address_kanji", "ownership_declaration", "verification"]; }; export declare const legal_entity_company_verificationSchema: { readonly description: ""; readonly properties: { readonly document: { readonly $ref: "#/components/schemas/legal_entity_company_verification_document"; }; }; readonly required: readonly ["document"]; readonly title: "LegalEntityCompanyVerification"; readonly type: "object"; readonly 'x-expandableFields': readonly ["document"]; }; export declare const legal_entity_company_verification_documentSchema: { readonly description: ""; readonly properties: { readonly back: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The back of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly details: { readonly description: "A user-displayable string describing the verification state of this document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly details_code: { readonly description: "One of `document_corrupt`, `document_expired`, `document_failed_copy`, `document_failed_greyscale`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_not_readable`, `document_not_uploaded`, `document_type_not_supported`, or `document_too_large`. A machine-readable code specifying the verification state for this document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly front: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The front of a document returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `additional_verification`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; }; readonly title: "LegalEntityCompanyVerificationDocument"; readonly type: "object"; readonly 'x-expandableFields': readonly ["back", "front"]; }; export declare const legal_entity_dobSchema: { readonly description: ""; readonly properties: { readonly day: { readonly description: "The day of birth, between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "The month of birth, between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year of birth."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "LegalEntityDOB"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const legal_entity_japan_addressSchema: { readonly description: ""; readonly properties: { readonly city: { readonly description: "City/Ward."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line1: { readonly description: "Block/Building number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line2: { readonly description: "Building details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly postal_code: { readonly description: "ZIP or postal code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly state: { readonly description: "Prefecture."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly town: { readonly description: "Town/cho-me."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "LegalEntityJapanAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const legal_entity_person_verificationSchema: { readonly description: ""; readonly properties: { readonly additional_document: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_person_verification_document"; }]; readonly description: "A document showing address, either a passport, local ID card, or utility bill from a well-known utility company."; readonly nullable: true; }; readonly details: { readonly description: "A user-displayable string describing the verification state for the person. For example, this may say \"Provided identity information could not be verified\"."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly details_code: { readonly description: "One of `document_address_mismatch`, `document_dob_mismatch`, `document_duplicate_type`, `document_id_number_mismatch`, `document_name_mismatch`, `document_nationality_mismatch`, `failed_keyed_identity`, or `failed_other`. A machine-readable code specifying the verification state for the person."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly document: { readonly $ref: "#/components/schemas/legal_entity_person_verification_document"; }; readonly status: { readonly description: "The state of verification for the person. Possible values are `unverified`, `pending`, or `verified`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "LegalEntityPersonVerification"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_document", "document"]; }; export declare const legal_entity_person_verification_documentSchema: { readonly description: ""; readonly properties: { readonly back: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The back of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; readonly details: { readonly description: "A user-displayable string describing the verification state of this document. For example, if a document is uploaded and the picture is too fuzzy, this may say \"Identity document is too unclear to read\"."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly details_code: { readonly description: "One of `document_corrupt`, `document_country_not_supported`, `document_expired`, `document_failed_copy`, `document_failed_other`, `document_failed_test_mode`, `document_fraudulent`, `document_failed_greyscale`, `document_incomplete`, `document_invalid`, `document_manipulated`, `document_missing_back`, `document_missing_front`, `document_not_readable`, `document_not_uploaded`, `document_photo_mismatch`, `document_too_large`, or `document_type_not_supported`. A machine-readable code specifying the verification state for this document."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly front: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "The front of an ID returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `identity_document`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; }; readonly title: "LegalEntityPersonVerificationDocument"; readonly type: "object"; readonly 'x-expandableFields': readonly ["back", "front"]; }; export declare const legal_entity_ubo_declarationSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the beneficial owner attestation was made."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the beneficial owner attestation was made."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user-agent string from the browser where the beneficial owner attestation was made."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "LegalEntityUBODeclaration"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const line_itemSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount, in cents (or local equivalent)."; readonly type: "integer"; }; readonly amount_excluding_tax: { readonly description: "The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts."; readonly nullable: true; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discount_amounts: { readonly description: "The amount of discount calculated per discount for this line item."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_discount_amount"; }; readonly nullable: true; readonly type: "array"; }; readonly discountable: { readonly description: "If true, discounts will apply to this line item. Always false for prorations."; readonly type: "boolean"; }; readonly discounts: { readonly description: "The discounts applied to the invoice line item. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly description: "The ID of the invoice that contains this line item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_item: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoiceitem"; }]; readonly description: "The ID of the [invoice item](https://stripe.com/docs/api/invoiceitems) associated with this line item if any."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoiceitem"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Note that for line items with `type=subscription`, `metadata` reflects the current metadata from the subscription associated with the line item, unless the invoice line was directly updated with different metadata after creation."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["line_item"]; readonly type: "string"; }; readonly period: { readonly $ref: "#/components/schemas/invoice_line_item_period"; }; readonly price: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/price"; }]; readonly description: "The price of the line item."; readonly nullable: true; }; readonly proration: { readonly description: "Whether this is a proration."; readonly type: "boolean"; }; readonly proration_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoices_resource_line_items_proration_details"; }]; readonly description: "Additional details for proration line items"; readonly nullable: true; }; readonly quantity: { readonly description: "The quantity of the subscription, if the line item is a subscription or a proration."; readonly nullable: true; readonly type: "integer"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "The subscription that the invoice item pertains to, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly subscription_item: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription_item"; }]; readonly description: "The subscription item that generated this line item. Left empty if the line item is not an explicit result of a subscription."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription_item"; }]; }; }; readonly tax_amounts: { readonly description: "The amount of tax calculated per tax rate for this line item"; readonly items: { readonly $ref: "#/components/schemas/invoice_tax_amount"; }; readonly type: "array"; }; readonly tax_rates: { readonly description: "The tax rates which apply to the line item."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly type: "array"; }; readonly type: { readonly description: "A string identifying the type of the source of this line item, either an `invoiceitem` or a `subscription`."; readonly enum: readonly ["invoiceitem", "subscription"]; readonly type: "string"; }; readonly unit_amount_excluding_tax: { readonly description: "The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency", "discountable", "discounts", "id", "livemode", "metadata", "object", "period", "proration", "type"]; readonly title: "InvoiceLineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discount_amounts", "discounts", "invoice_item", "period", "price", "proration_details", "subscription", "subscription_item", "tax_amounts", "tax_rates"]; readonly 'x-resourceId': "line_item"; }; export declare const line_items_discount_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount discounted."; readonly type: "integer"; }; readonly discount: { readonly $ref: "#/components/schemas/discount"; }; }; readonly required: readonly ["amount", "discount"]; readonly title: "LineItemsDiscountAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discount"]; }; export declare const line_items_tax_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount of tax applied for this rate."; readonly type: "integer"; }; readonly rate: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly taxability_reason: { readonly 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."; readonly enum: readonly ["customer_exempt", "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"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly taxable_amount: { readonly description: "The amount on which tax is calculated, in cents (or local equivalent)."; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["amount", "rate"]; readonly title: "LineItemsTaxAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["rate"]; }; export declare const linked_account_options_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly permissions: { readonly description: "The list of permissions to request. The `payment_method` permission must be included."; readonly items: { readonly enum: readonly ["balances", "ownership", "payment_method", "transactions"]; readonly type: "string"; }; readonly type: "array"; }; readonly prefetch: { readonly description: "Data features requested to be retrieved upon account creation."; readonly items: { readonly enum: readonly ["balances", "ownership", "transactions"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly return_url: { readonly description: "For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "linked_account_options_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const login_linkSchema: { readonly description: "Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account's [account.controller.stripe_dashboard.type](/api/accounts/object#account_object-controller-stripe_dashboard-type) must be `express` to have access to the Express Dashboard."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["login_link"]; readonly type: "string"; }; readonly url: { readonly description: "The URL for the login link."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "object", "url"]; readonly title: "LoginLink"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "login_link"; }; export declare const mandateSchema: { readonly description: "A Mandate is a record of the permission that your customer gives you to debit their payment method."; readonly properties: { readonly customer_acceptance: { readonly $ref: "#/components/schemas/customer_acceptance"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly multi_use: { readonly $ref: "#/components/schemas/mandate_multi_use"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["mandate"]; readonly type: "string"; }; readonly on_behalf_of: { readonly description: "The account (if any) that the mandate is intended for."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the payment method associated with this mandate."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly payment_method_details: { readonly $ref: "#/components/schemas/mandate_payment_method_details"; }; readonly single_use: { readonly $ref: "#/components/schemas/mandate_single_use"; }; readonly status: { readonly description: "The mandate status indicates whether or not you can use it to initiate a payment."; readonly enum: readonly ["active", "inactive", "pending"]; readonly type: "string"; }; readonly type: { readonly description: "The type of the mandate."; readonly enum: readonly ["multi_use", "single_use"]; readonly type: "string"; }; }; readonly required: readonly ["customer_acceptance", "id", "livemode", "object", "payment_method", "payment_method_details", "status", "type"]; readonly title: "Mandate"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_acceptance", "multi_use", "payment_method", "payment_method_details", "single_use"]; readonly 'x-resourceId': "mandate"; }; export declare const mandate_acss_debitSchema: { readonly description: ""; readonly properties: { readonly default_for: { readonly description: "List of Stripe products where this mandate can be selected automatically."; readonly items: { readonly enum: readonly ["invoice", "subscription"]; readonly type: "string"; }; readonly type: "array"; }; readonly interval_description: { readonly description: "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_schedule: { readonly description: "Payment schedule for the mandate."; readonly enum: readonly ["combined", "interval", "sporadic"]; readonly type: "string"; }; readonly transaction_type: { readonly description: "Transaction type of the mandate."; readonly enum: readonly ["business", "personal"]; readonly type: "string"; }; }; readonly required: readonly ["payment_schedule", "transaction_type"]; readonly title: "mandate_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_amazon_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "mandate_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_au_becs_debitSchema: { readonly description: ""; readonly properties: { readonly url: { readonly description: "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["url"]; readonly title: "mandate_au_becs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_bacs_debitSchema: { readonly description: ""; readonly properties: { readonly network_status: { readonly description: "The status of the mandate on the Bacs network. Can be one of `pending`, `revoked`, `refused`, or `accepted`."; readonly enum: readonly ["accepted", "pending", "refused", "revoked"]; readonly type: "string"; }; readonly reference: { readonly description: "The unique reference identifying the mandate on the Bacs network."; readonly maxLength: 5000; readonly type: "string"; }; readonly revocation_reason: { readonly description: "When the mandate is revoked on the Bacs network this field displays the reason for the revocation."; readonly enum: readonly ["account_closed", "bank_account_restricted", "bank_ownership_changed", "could_not_process", "debit_not_authorized"]; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The URL that will contain the mandate that the customer has signed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["network_status", "reference", "url"]; readonly title: "mandate_bacs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_cashappSchema: { readonly description: ""; readonly properties: {}; readonly title: "mandate_cashapp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_linkSchema: { readonly description: ""; readonly properties: {}; readonly title: "mandate_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_multi_useSchema: { readonly description: ""; readonly properties: {}; readonly title: "mandate_multi_use"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/mandate_acss_debit"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/mandate_amazon_pay"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/mandate_au_becs_debit"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/mandate_bacs_debit"; }; readonly card: { readonly $ref: "#/components/schemas/card_mandate_payment_method_details"; }; readonly cashapp: { readonly $ref: "#/components/schemas/mandate_cashapp"; }; readonly link: { readonly $ref: "#/components/schemas/mandate_link"; }; readonly paypal: { readonly $ref: "#/components/schemas/mandate_paypal"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/mandate_revolut_pay"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/mandate_sepa_debit"; }; readonly type: { readonly description: "This mandate corresponds with a specific payment method type. The `payment_method_details` includes an additional hash with the same name and contains mandate information that's specific to that payment method."; readonly maxLength: 5000; readonly type: "string"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/mandate_us_bank_account"; }; }; readonly required: readonly ["type"]; readonly title: "mandate_payment_method_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "card", "cashapp", "link", "paypal", "revolut_pay", "sepa_debit", "us_bank_account"]; }; export declare const mandate_paypalSchema: { readonly description: ""; readonly properties: { readonly billing_agreement_id: { readonly description: "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payer_id: { readonly description: "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "mandate_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_revolut_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "mandate_revolut_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_sepa_debitSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "The unique reference of the mandate."; readonly maxLength: 5000; readonly type: "string"; }; readonly url: { readonly description: "The URL of the mandate. This URL generally contains sensitive information about the customer and should be shared with them exclusively."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["reference", "url"]; readonly title: "mandate_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_single_useSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount of the payment on a single use mandate."; readonly type: "integer"; }; readonly currency: { readonly description: "The currency of the payment on a single use mandate."; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "mandate_single_use"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const mandate_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly collection_method: { readonly description: "Mandate collection method"; readonly enum: readonly ["paper"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "mandate_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const networksSchema: { readonly description: ""; readonly properties: { readonly available: { readonly description: "All available networks for the card."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly preferred: { readonly description: "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["available"]; readonly title: "networks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const notification_event_dataSchema: { readonly description: ""; readonly properties: { readonly object: { readonly description: "Object containing the API resource relevant to the event. For example, an `invoice.created` event will have a full [invoice object](https://stripe.com/docs/api#invoice_object) as the value of the object key."; readonly type: "object"; }; readonly previous_attributes: { readonly description: "Object containing the names of the updated attributes and their values prior to the event (only included in events of type `*.updated`). If an array attribute has any updated elements, this object contains the entire array. In Stripe API versions 2017-04-06 or earlier, an updated array attribute in this object includes only the updated array elements."; readonly type: "object"; }; }; readonly required: readonly ["object"]; readonly title: "NotificationEventData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const notification_event_requestSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "ID of the API request that caused the event. If null, the event was automatic (e.g., Stripe's automatic subscription handling). Request logs are available in the [dashboard](https://dashboard.stripe.com/logs), but currently not in the API."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly idempotency_key: { readonly description: "The idempotency key transmitted during the request, if any. *Note: This property is populated only for events on or after May 23, 2017*."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "NotificationEventRequest"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const offline_acceptanceSchema: { readonly description: ""; readonly properties: {}; readonly title: "offline_acceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const online_acceptanceSchema: { readonly description: ""; readonly properties: { readonly ip_address: { readonly description: "The customer accepts the mandate from this IP address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The customer accepts the mandate using the user agent of the browser."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "online_acceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const outbound_payments_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly billing_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_billing_details"; }; readonly financial_account: { readonly $ref: "#/components/schemas/outbound_payments_payment_method_details_financial_account"; }; readonly type: { readonly description: "The type of the payment method used in the OutboundPayment."; readonly enum: readonly ["financial_account", "us_bank_account"]; readonly type: "string"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/outbound_payments_payment_method_details_us_bank_account"; }; }; readonly required: readonly ["billing_details", "type"]; readonly title: "OutboundPaymentsPaymentMethodDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_details", "financial_account", "us_bank_account"]; }; export declare const outbound_payments_payment_method_details_financial_accountSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "Token of the FinancialAccount."; readonly maxLength: 5000; readonly type: "string"; }; readonly network: { readonly description: "The rails used to send funds."; readonly enum: readonly ["stripe"]; readonly type: "string"; }; }; readonly required: readonly ["id", "network"]; readonly title: "outbound_payments_payment_method_details_financial_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const outbound_payments_payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Account holder type: individual or company."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "Account type: checkings or savings. Defaults to checking if omitted."; readonly enum: readonly ["checking", "savings"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the mandate used to make this payment."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly network: { readonly description: "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."; readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["network"]; readonly title: "outbound_payments_payment_method_details_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate"]; }; export declare const outbound_transfers_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly billing_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_billing_details"; }; readonly type: { readonly description: "The type of the payment method used in the OutboundTransfer."; readonly enum: readonly ["us_bank_account"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/outbound_transfers_payment_method_details_us_bank_account"; }; }; readonly required: readonly ["billing_details", "type"]; readonly title: "OutboundTransfersPaymentMethodDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_details", "us_bank_account"]; }; export declare const outbound_transfers_payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Account holder type: individual or company."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "Account type: checkings or savings. Defaults to checking if omitted."; readonly enum: readonly ["checking", "savings"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the mandate used to make this payment."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly network: { readonly description: "The network rails used. See the [docs](https://stripe.com/docs/treasury/money-movement/timelines) to learn more about money movement timelines for each network type."; readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["network"]; readonly title: "outbound_transfers_payment_method_details_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate"]; }; export declare const package_dimensionsSchema: { readonly description: ""; readonly properties: { readonly height: { readonly description: "Height, in inches."; readonly type: "number"; }; readonly length: { readonly description: "Length, in inches."; readonly type: "number"; }; readonly weight: { readonly description: "Weight, in ounces."; readonly type: "number"; }; readonly width: { readonly description: "Width, in inches."; readonly type: "number"; }; }; readonly required: readonly ["height", "length", "weight", "width"]; readonly title: "PackageDimensions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_amount_detailsSchema: { readonly description: ""; readonly properties: { readonly tip: { readonly $ref: "#/components/schemas/payment_flows_amount_details_resource_tip"; }; }; readonly title: "PaymentFlowsAmountDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tip"]; }; export declare const payment_flows_amount_details_resource_tipSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Portion of the amount that corresponds to a tip."; readonly type: "integer"; }; }; readonly title: "PaymentFlowsAmountDetailsResourceTip"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_automatic_payment_methods_payment_intentSchema: { readonly description: ""; readonly properties: { readonly allow_redirects: { readonly description: "Controls whether this PaymentIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the payment."; readonly enum: readonly ["always", "never"]; readonly type: "string"; }; readonly enabled: { readonly description: "Automatically calculates compatible payment methods"; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentFlowsAutomaticPaymentMethodsPaymentIntent"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_automatic_payment_methods_setup_intentSchema: { readonly description: ""; readonly properties: { readonly allow_redirects: { readonly description: "Controls whether this SetupIntent will accept redirect-based payment methods.\n\nRedirect-based payment methods may require your customer to be redirected to a payment method's app or site for authentication or additional steps. To [confirm](https://stripe.com/docs/api/setup_intents/confirm) this SetupIntent, you may be required to provide a `return_url` to redirect customers back to your site after they authenticate or complete the setup."; readonly enum: readonly ["always", "never"]; readonly type: "string"; }; readonly enabled: { readonly description: "Automatically calculates compatible payment methods"; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "PaymentFlowsAutomaticPaymentMethodsSetupIntent"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_installment_optionsSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly type: "boolean"; }; readonly plan: { readonly $ref: "#/components/schemas/payment_method_details_card_installments_plan"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentFlowsInstallmentOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["plan"]; }; export declare const payment_flows_private_payment_methods_alipaySchema: { readonly description: ""; readonly properties: {}; readonly title: "PaymentFlowsPrivatePaymentMethodsAlipay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_alipay_detailsSchema: { readonly description: ""; readonly properties: { readonly buyer_id: { readonly description: "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same."; readonly maxLength: 5000; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "Transaction ID of this particular Alipay transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentFlowsPrivatePaymentMethodsAlipayDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorizationSchema: { readonly description: ""; readonly properties: { readonly status: { readonly description: "Indicates whether or not the capture window is extended beyond the standard authorization."; readonly enum: readonly ["disabled", "enabled"]; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorizationSchema: { readonly description: ""; readonly properties: { readonly status: { readonly description: "Indicates whether or not the incremental authorization feature is supported."; readonly enum: readonly ["available", "unavailable"]; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcaptureSchema: { readonly description: ""; readonly properties: { readonly maximum_amount_capturable: { readonly description: "The maximum amount that can be captured."; readonly type: "integer"; }; readonly status: { readonly description: "Indicates whether or not the authorized amount can be over-captured."; readonly enum: readonly ["available", "unavailable"]; readonly type: "string"; }; }; readonly required: readonly ["maximum_amount_capturable", "status"]; readonly title: "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_card_details_api_resource_multicaptureSchema: { readonly description: ""; readonly properties: { readonly status: { readonly description: "Indicates whether or not multiple captures are supported."; readonly enum: readonly ["available", "unavailable"]; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_flows_private_payment_methods_klarna_dobSchema: { readonly description: ""; readonly properties: { readonly day: { readonly description: "The day of birth, between 1 and 31."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "The month of birth, between 1 and 12."; readonly nullable: true; readonly type: "integer"; }; readonly year: { readonly description: "The four-digit year of birth."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PaymentFlowsPrivatePaymentMethodsKlarnaDOB"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intentSchema: { readonly description: "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)"; readonly properties: { readonly amount: { readonly description: "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."; readonly type: "integer"; }; readonly amount_capturable: { readonly description: "Amount that can be captured from this PaymentIntent."; readonly type: "integer"; }; readonly amount_details: { readonly $ref: "#/components/schemas/payment_flows_amount_details"; }; readonly amount_received: { readonly description: "Amount that this PaymentIntent collects."; readonly type: "integer"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "ID of the Connect application that created the PaymentIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly application_fee_amount: { readonly description: "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)."; readonly nullable: true; readonly type: "integer"; }; readonly automatic_payment_methods: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_flows_automatic_payment_methods_payment_intent"; }]; readonly description: "Settings to configure compatible payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods)"; readonly nullable: true; }; readonly canceled_at: { readonly description: "Populated when `status` is `canceled`, this is the time at which the PaymentIntent was canceled. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancellation_reason: { readonly description: "Reason for cancellation of this PaymentIntent, either user-provided (`duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`) or generated by Stripe internally (`failed_invoice`, `void_invoice`, or `automatic`)."; readonly enum: readonly ["abandoned", "automatic", "duplicate", "failed_invoice", "fraudulent", "requested_by_customer", "void_invoice"]; readonly nullable: true; readonly type: "string"; }; readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["automatic", "automatic_async", "manual"]; readonly type: "string"; }; readonly client_secret: { readonly description: "The client secret of this PaymentIntent. Used for client-side retrieval using a publishable key. \n\nThe client secret can be used to complete a payment from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret.\n\nRefer to our docs to [accept a payment](https://stripe.com/docs/payments/accept-a-payment?ui=elements) and learn about how `client_secret` should be handled."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly confirmation_method: { readonly description: "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment."; readonly enum: readonly ["automatic", "manual"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the Customer this PaymentIntent belongs to, if one exists.\n\nPayment methods attached to other Customers cannot be used with this PaymentIntent.\n\nIf present in combination with [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "ID of the invoice that created this PaymentIntent, if it exists."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly last_payment_error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/api_errors"; }]; readonly description: "The payment error encountered in the previous PaymentIntent confirmation. It will be cleared if the PaymentIntent is later updated for any reason."; readonly nullable: true; }; readonly latest_charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "The latest charge created by this PaymentIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Learn more about [storing information in metadata](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata)."; readonly type: "object"; }; readonly next_action: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_next_action"; }]; readonly description: "If present, this property tells you what actions you need to take in order for your customer to fulfill a payment using the provided source."; readonly nullable: true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payment_intent"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) for which the funds of the PaymentIntent are intended. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the payment method used in this PaymentIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly payment_method_configuration_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"; }]; readonly description: "Information about the payment method configuration used for this PaymentIntent."; readonly nullable: true; }; readonly payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options"; }]; readonly description: "Payment-method-specific configuration for this PaymentIntent."; readonly nullable: true; }; readonly payment_method_types: { readonly description: "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly processing: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_processing"; }]; readonly description: "If present, this property tells you about the processing state of the payment."; readonly nullable: true; }; readonly receipt_email: { readonly description: "Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly review: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/review"; }]; readonly description: "ID of the review associated with this PaymentIntent, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/review"; }]; }; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["off_session", "on_session"]; readonly nullable: true; readonly type: "string"; }; readonly shipping: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping"; }]; readonly description: "Shipping information for this PaymentIntent."; readonly nullable: true; }; readonly statement_descriptor: { readonly description: "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_suffix: { readonly description: "Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Status of this PaymentIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `requires_capture`, `canceled`, or `succeeded`. Read more about each PaymentIntent [status](https://stripe.com/docs/payments/intents#intent-statuses)."; readonly enum: readonly ["canceled", "processing", "requires_action", "requires_capture", "requires_confirmation", "requires_payment_method", "succeeded"]; readonly type: "string"; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/transfer_data"; }]; readonly description: "The data that automatically creates a Transfer after the payment finalizes. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts)."; readonly nullable: true; }; readonly transfer_group: { readonly description: "A string that identifies the resulting payment as part of a group. Learn more about the [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "capture_method", "confirmation_method", "created", "currency", "id", "livemode", "object", "payment_method_types", "status"]; readonly title: "PaymentIntent"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amount_details", "application", "automatic_payment_methods", "customer", "invoice", "last_payment_error", "latest_charge", "next_action", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "processing", "review", "shipping", "transfer_data"]; readonly 'x-resourceId': "payment_intent"; }; export declare const payment_intent_card_processingSchema: { readonly description: ""; readonly properties: { readonly customer_notification: { readonly $ref: "#/components/schemas/payment_intent_processing_customer_notification"; }; }; readonly title: "PaymentIntentCardProcessing"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_notification"]; }; export declare const payment_intent_next_actionSchema: { readonly description: ""; readonly properties: { readonly alipay_handle_redirect: { readonly $ref: "#/components/schemas/payment_intent_next_action_alipay_handle_redirect"; }; readonly boleto_display_details: { readonly $ref: "#/components/schemas/payment_intent_next_action_boleto"; }; readonly card_await_notification: { readonly $ref: "#/components/schemas/payment_intent_next_action_card_await_notification"; }; readonly cashapp_handle_redirect_or_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"; }; readonly display_bank_transfer_instructions: { readonly $ref: "#/components/schemas/payment_intent_next_action_display_bank_transfer_instructions"; }; readonly konbini_display_details: { readonly $ref: "#/components/schemas/payment_intent_next_action_konbini"; }; readonly multibanco_display_details: { readonly $ref: "#/components/schemas/payment_intent_next_action_display_multibanco_details"; }; readonly oxxo_display_details: { readonly $ref: "#/components/schemas/payment_intent_next_action_display_oxxo_details"; }; readonly paynow_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_paynow_display_qr_code"; }; readonly pix_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_pix_display_qr_code"; }; readonly promptpay_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_promptpay_display_qr_code"; }; readonly redirect_to_url: { readonly $ref: "#/components/schemas/payment_intent_next_action_redirect_to_url"; }; readonly swish_handle_redirect_or_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_swish_handle_redirect_or_display_qr_code"; }; readonly type: { readonly description: "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."; readonly maxLength: 5000; readonly type: "string"; }; readonly use_stripe_sdk: { readonly description: "When confirming a PaymentIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."; readonly type: "object"; }; readonly verify_with_microdeposits: { readonly $ref: "#/components/schemas/payment_intent_next_action_verify_with_microdeposits"; }; readonly wechat_pay_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_wechat_pay_display_qr_code"; }; readonly wechat_pay_redirect_to_android_app: { readonly $ref: "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_android_app"; }; readonly wechat_pay_redirect_to_ios_app: { readonly $ref: "#/components/schemas/payment_intent_next_action_wechat_pay_redirect_to_ios_app"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentIntentNextAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alipay_handle_redirect", "boleto_display_details", "card_await_notification", "cashapp_handle_redirect_or_display_qr_code", "display_bank_transfer_instructions", "konbini_display_details", "multibanco_display_details", "oxxo_display_details", "paynow_display_qr_code", "pix_display_qr_code", "promptpay_display_qr_code", "redirect_to_url", "swish_handle_redirect_or_display_qr_code", "verify_with_microdeposits", "wechat_pay_display_qr_code", "wechat_pay_redirect_to_android_app", "wechat_pay_redirect_to_ios_app"]; }; export declare const payment_intent_next_action_alipay_handle_redirectSchema: { readonly description: ""; readonly properties: { readonly native_data: { readonly description: "The native data to be used with Alipay SDK you must redirect your customer to in order to authenticate the payment in an Android App."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly native_url: { readonly description: "The native URL you must redirect your customer to in order to authenticate the payment in an iOS App."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly return_url: { readonly description: "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The URL you must redirect your customer to in order to authenticate the payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentIntentNextActionAlipayHandleRedirect"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_boletoSchema: { readonly description: ""; readonly properties: { readonly expires_at: { readonly description: "The timestamp after which the boleto expires."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly hosted_voucher_url: { readonly description: "The URL to the hosted boleto voucher page, which allows customers to view the boleto voucher."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly number: { readonly description: "The boleto number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly pdf: { readonly description: "The URL to the downloadable boleto voucher PDF."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_intent_next_action_boleto"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_card_await_notificationSchema: { readonly description: ""; readonly properties: { readonly charge_attempt_at: { readonly description: "The time that payment will be attempted. If customer approval is required, they need to provide approval before this time."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly customer_approval_required: { readonly description: "For payments greater than INR 15000, the customer must provide explicit approval of the payment with their bank. For payments of lower amount, no customer action is required."; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "PaymentIntentNextActionCardAwaitNotification"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_cashapp_handle_redirect_or_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly hosted_instructions_url: { readonly description: "The URL to the hosted Cash App Pay instructions page, which allows customers to view the QR code, and supports QR code refreshing on expiration."; readonly maxLength: 5000; readonly type: "string"; }; readonly mobile_auth_url: { readonly description: "The url for mobile redirect based auth"; readonly maxLength: 5000; readonly type: "string"; }; readonly qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_cashapp_qr_code"; }; }; readonly required: readonly ["hosted_instructions_url", "mobile_auth_url", "qr_code"]; readonly title: "PaymentIntentNextActionCashappHandleRedirectOrDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly ["qr_code"]; }; export declare const payment_intent_next_action_cashapp_qr_codeSchema: { readonly description: ""; readonly properties: { readonly expires_at: { readonly description: "The date (unix timestamp) when the QR code expires."; readonly format: "unix-time"; readonly type: "integer"; }; readonly image_url_png: { readonly description: "The image_url_png string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The image_url_svg string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["expires_at", "image_url_png", "image_url_svg"]; readonly title: "PaymentIntentNextActionCashappQRCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_display_bank_transfer_instructionsSchema: { readonly description: ""; readonly properties: { readonly amount_remaining: { readonly description: "The remaining amount that needs to be transferred to complete the payment."; readonly nullable: true; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly nullable: true; readonly type: "string"; }; readonly financial_addresses: { readonly description: "A list of financial addresses that can be used to fund the customer balance"; readonly items: { readonly $ref: "#/components/schemas/funding_instructions_bank_transfer_financial_address"; }; readonly type: "array"; }; readonly hosted_instructions_url: { readonly description: "A link to a hosted page that guides your customer through completing the transfer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "A string identifying this payment. Instruct your customer to include this code in the reference or memo field of their bank transfer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "Type of bank transfer"; readonly enum: readonly ["eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["type"]; readonly title: "PaymentIntentNextActionDisplayBankTransferInstructions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_addresses"]; }; export declare const payment_intent_next_action_display_multibanco_detailsSchema: { readonly description: ""; readonly properties: { readonly entity: { readonly description: "Entity number associated with this Multibanco payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly expires_at: { readonly description: "The timestamp at which the Multibanco voucher expires."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly hosted_voucher_url: { readonly description: "The URL for the hosted Multibanco voucher page, which allows customers to view a Multibanco voucher."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "Reference number associated with this Multibanco payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentIntentNextActionDisplayMultibancoDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_display_oxxo_detailsSchema: { readonly description: ""; readonly properties: { readonly expires_after: { readonly description: "The timestamp after which the OXXO voucher expires."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly hosted_voucher_url: { readonly description: "The URL for the hosted OXXO voucher page, which allows customers to view and print an OXXO voucher."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly number: { readonly description: "OXXO reference number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentIntentNextActionDisplayOxxoDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_konbiniSchema: { readonly description: ""; readonly properties: { readonly expires_at: { readonly description: "The timestamp at which the pending Konbini payment expires."; readonly format: "unix-time"; readonly type: "integer"; }; readonly hosted_voucher_url: { readonly description: "The URL for the Konbini payment instructions page, which allows customers to view and print a Konbini voucher."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly stores: { readonly $ref: "#/components/schemas/payment_intent_next_action_konbini_stores"; }; }; readonly required: readonly ["expires_at", "stores"]; readonly title: "payment_intent_next_action_konbini"; readonly type: "object"; readonly 'x-expandableFields': readonly ["stores"]; }; export declare const payment_intent_next_action_konbini_familymartSchema: { readonly description: ""; readonly properties: { readonly confirmation_number: { readonly description: "The confirmation number."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_code: { readonly description: "The payment code."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["payment_code"]; readonly title: "payment_intent_next_action_konbini_familymart"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_konbini_lawsonSchema: { readonly description: ""; readonly properties: { readonly confirmation_number: { readonly description: "The confirmation number."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_code: { readonly description: "The payment code."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["payment_code"]; readonly title: "payment_intent_next_action_konbini_lawson"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_konbini_ministopSchema: { readonly description: ""; readonly properties: { readonly confirmation_number: { readonly description: "The confirmation number."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_code: { readonly description: "The payment code."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["payment_code"]; readonly title: "payment_intent_next_action_konbini_ministop"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_konbini_seicomartSchema: { readonly description: ""; readonly properties: { readonly confirmation_number: { readonly description: "The confirmation number."; readonly maxLength: 5000; readonly type: "string"; }; readonly payment_code: { readonly description: "The payment code."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["payment_code"]; readonly title: "payment_intent_next_action_konbini_seicomart"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_konbini_storesSchema: { readonly description: ""; readonly properties: { readonly familymart: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_next_action_konbini_familymart"; }]; readonly description: "FamilyMart instruction details."; readonly nullable: true; }; readonly lawson: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_next_action_konbini_lawson"; }]; readonly description: "Lawson instruction details."; readonly nullable: true; }; readonly ministop: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_next_action_konbini_ministop"; }]; readonly description: "Ministop instruction details."; readonly nullable: true; }; readonly seicomart: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_next_action_konbini_seicomart"; }]; readonly description: "Seicomart instruction details."; readonly nullable: true; }; }; readonly title: "payment_intent_next_action_konbini_stores"; readonly type: "object"; readonly 'x-expandableFields': readonly ["familymart", "lawson", "ministop", "seicomart"]; }; export declare const payment_intent_next_action_paynow_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly data: { readonly description: "The raw data string used to generate QR code, it should be used together with QR code library."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_instructions_url: { readonly description: "The URL to the hosted PayNow instructions page, which allows customers to view the PayNow QR code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly image_url_png: { readonly description: "The image_url_png string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The image_url_svg string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "image_url_png", "image_url_svg"]; readonly title: "PaymentIntentNextActionPaynowDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_pix_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly data: { readonly description: "The raw data string used to generate QR code, it should be used together with QR code library."; readonly maxLength: 5000; readonly type: "string"; }; readonly expires_at: { readonly description: "The date (unix timestamp) when the PIX expires."; readonly type: "integer"; }; readonly hosted_instructions_url: { readonly description: "The URL to the hosted pix instructions page, which allows customers to view the pix QR code."; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_png: { readonly description: "The image_url_png string used to render png QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The image_url_svg string used to render svg QR code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "PaymentIntentNextActionPixDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_promptpay_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly data: { readonly description: "The raw data string used to generate QR code, it should be used together with QR code library."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_instructions_url: { readonly description: "The URL to the hosted PromptPay instructions page, which allows customers to view the PromptPay QR code."; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_png: { readonly description: "The PNG path used to render the QR code, can be used as the source in an HTML img tag"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The SVG path used to render the QR code, can be used as the source in an HTML img tag"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "hosted_instructions_url", "image_url_png", "image_url_svg"]; readonly title: "PaymentIntentNextActionPromptpayDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_redirect_to_urlSchema: { readonly description: ""; readonly properties: { readonly return_url: { readonly description: "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The URL you must redirect your customer to in order to authenticate the payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentIntentNextActionRedirectToUrl"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_swish_handle_redirect_or_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly hosted_instructions_url: { readonly description: "The URL to the hosted Swish instructions page, which allows customers to view the QR code."; readonly maxLength: 5000; readonly type: "string"; }; readonly qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_swish_qr_code"; }; }; readonly required: readonly ["hosted_instructions_url", "qr_code"]; readonly title: "PaymentIntentNextActionSwishHandleRedirectOrDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly ["qr_code"]; }; export declare const payment_intent_next_action_swish_qr_codeSchema: { readonly description: ""; readonly properties: { readonly data: { readonly description: "The raw data string used to generate QR code, it should be used together with QR code library."; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_png: { readonly description: "The image_url_png string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The image_url_svg string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "image_url_png", "image_url_svg"]; readonly title: "PaymentIntentNextActionSwishQRCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_verify_with_microdepositsSchema: { readonly description: ""; readonly properties: { readonly arrival_date: { readonly description: "The timestamp when the microdeposits are expected to land."; readonly format: "unix-time"; readonly type: "integer"; }; readonly hosted_verification_url: { readonly description: "The URL for the hosted verification page, which allows customers to verify their bank account."; readonly maxLength: 5000; readonly type: "string"; }; readonly microdeposit_type: { readonly description: "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."; readonly enum: readonly ["amounts", "descriptor_code"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["arrival_date", "hosted_verification_url"]; readonly title: "PaymentIntentNextActionVerifyWithMicrodeposits"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_wechat_pay_display_qr_codeSchema: { readonly description: ""; readonly properties: { readonly data: { readonly description: "The data being used to generate QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_instructions_url: { readonly description: "The URL to the hosted WeChat Pay instructions page, which allows customers to view the WeChat Pay QR code."; readonly maxLength: 5000; readonly type: "string"; }; readonly image_data_url: { readonly description: "The base64 image data for a pre-generated QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_png: { readonly description: "The image_url_png string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; readonly image_url_svg: { readonly description: "The image_url_svg string used to render QR code"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "hosted_instructions_url", "image_data_url", "image_url_png", "image_url_svg"]; readonly title: "PaymentIntentNextActionWechatPayDisplayQrCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_wechat_pay_redirect_to_android_appSchema: { readonly description: ""; readonly properties: { readonly app_id: { readonly description: "app_id is the APP ID registered on WeChat open platform"; readonly maxLength: 5000; readonly type: "string"; }; readonly nonce_str: { readonly description: "nonce_str is a random string"; readonly maxLength: 5000; readonly type: "string"; }; readonly package: { readonly description: "package is static value"; readonly maxLength: 5000; readonly type: "string"; }; readonly partner_id: { readonly description: "an unique merchant ID assigned by WeChat Pay"; readonly maxLength: 5000; readonly type: "string"; }; readonly prepay_id: { readonly description: "an unique trading ID assigned by WeChat Pay"; readonly maxLength: 5000; readonly type: "string"; }; readonly sign: { readonly description: "A signature"; readonly maxLength: 5000; readonly type: "string"; }; readonly timestamp: { readonly description: "Specifies the current time in epoch format"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["app_id", "nonce_str", "package", "partner_id", "prepay_id", "sign", "timestamp"]; readonly title: "PaymentIntentNextActionWechatPayRedirectToAndroidApp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_next_action_wechat_pay_redirect_to_ios_appSchema: { readonly description: ""; readonly properties: { readonly native_url: { readonly description: "An universal link that redirect to WeChat Pay app"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["native_url"]; readonly title: "PaymentIntentNextActionWechatPayRedirectToIOSApp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_acss_debit"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly affirm: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_affirm"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly afterpay_clearpay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_afterpay_clearpay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly alipay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_alipay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly amazon_pay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_amazon_pay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly au_becs_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_au_becs_debit"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly bacs_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_bacs_debit"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly bancontact: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_bancontact"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly blik: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_blik"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly boleto: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_boleto"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly card: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_card"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly card_present: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_card_present"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly cashapp: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_cashapp"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly customer_balance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_customer_balance"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly eps: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_eps"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly fpx: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_fpx"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly giropay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_giropay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly grabpay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_grabpay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly ideal: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_ideal"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly interac_present: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_interac_present"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly klarna: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_klarna"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly konbini: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_konbini"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly link: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_link"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly mobilepay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_mobilepay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly multibanco: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_multibanco"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly oxxo: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_oxxo"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly p24: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_p24"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly paynow: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_paynow"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly paypal: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_paypal"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly pix: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_pix"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly promptpay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_promptpay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly revolut_pay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_revolut_pay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly sepa_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_sepa_debit"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly sofort: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_sofort"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly swish: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_swish"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly twint: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_twint"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly us_bank_account: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent_payment_method_options_us_bank_account"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly wechat_pay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_wechat_pay"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; readonly zip: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_zip"; }, { readonly $ref: "#/components/schemas/payment_intent_type_specific_payment_method_options_client"; }]; }; }; readonly title: "PaymentIntentPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip"]; }; export declare const payment_intent_payment_method_options_acss_debitSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly $ref: "#/components/schemas/payment_intent_payment_method_options_mandate_options_acss_debit"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_intent_payment_method_options_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const payment_intent_payment_method_options_au_becs_debitSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_au_becs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_blikSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_intent_payment_method_options_blik"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_cardSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly installments: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_card_installments"; }]; readonly description: "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments)."; readonly nullable: true; }; readonly mandate_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_options_card_mandate_options"; }]; readonly description: "Configuration options for setting up an eMandate for cards issued in India."; readonly nullable: true; }; readonly network: { readonly description: "Selected network to process this payment intent on. Depends on the available networks of the card attached to the payment intent. Can be only set confirm-time."; readonly enum: readonly ["amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "mastercard", "unionpay", "unknown", "visa"]; readonly nullable: true; readonly type: "string"; }; readonly request_extended_authorization: { readonly description: "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent."; readonly enum: readonly ["if_available", "never"]; readonly type: "string"; }; readonly request_incremental_authorization: { readonly description: "Request ability to [increment the authorization](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent."; readonly enum: readonly ["if_available", "never"]; readonly type: "string"; }; readonly request_multicapture: { readonly description: "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent."; readonly enum: readonly ["if_available", "never"]; readonly type: "string"; }; readonly request_overcapture: { readonly description: "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent."; readonly enum: readonly ["if_available", "never"]; readonly type: "string"; }; readonly request_three_d_secure: { readonly description: "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."; readonly enum: readonly ["any", "automatic", "challenge"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly require_cvc_recollection: { readonly description: "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."; readonly type: "boolean"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly statement_descriptor_suffix_kana: { readonly description: "Provides information about a card payment that customers see on their statements. Concatenated with the Kana prefix (shortened Kana descriptor) or Kana statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 22 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 22 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly statement_descriptor_suffix_kanji: { readonly description: "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["installments", "mandate_options"]; }; export declare const payment_intent_payment_method_options_epsSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_eps"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_linkSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_mandate_options_acss_debitSchema: { readonly description: ""; readonly properties: { readonly custom_mandate_url: { readonly description: "A URL for custom mandate text"; readonly maxLength: 5000; readonly type: "string"; }; readonly interval_description: { readonly description: "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_schedule: { readonly description: "Payment schedule for the mandate."; readonly enum: readonly ["combined", "interval", "sporadic"]; readonly nullable: true; readonly type: "string"; }; readonly transaction_type: { readonly description: "Transaction type of the mandate."; readonly enum: readonly ["business", "personal"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_mandate_options_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_mandate_options_sepa_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_intent_payment_method_options_mandate_options_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_mobilepaySchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_mobilepay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_sepa_debitSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly $ref: "#/components/schemas/payment_intent_payment_method_options_mandate_options_sepa_debit"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const payment_intent_payment_method_options_swishSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "The order ID displayed in the Swish app after the payment is authorized."; readonly maxLength: 35; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_intent_payment_method_options_swish"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_payment_method_options_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly financial_connections: { readonly $ref: "#/components/schemas/linked_account_options_us_bank_account"; }; readonly mandate_options: { readonly $ref: "#/components/schemas/payment_method_options_us_bank_account_mandate_options"; }; readonly preferred_settlement_speed: { readonly description: "Preferred transaction settlement speed"; readonly enum: readonly ["fastest", "standard"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_intent_payment_method_options_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_connections", "mandate_options"]; }; export declare const payment_intent_processingSchema: { readonly description: ""; readonly properties: { readonly card: { readonly $ref: "#/components/schemas/payment_intent_card_processing"; }; readonly type: { readonly description: "Type of the payment method for which payment is in `processing` state, one of `card`."; readonly enum: readonly ["card"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentIntentProcessing"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card"]; }; export declare const payment_intent_processing_customer_notificationSchema: { readonly description: ""; readonly properties: { readonly approval_requested: { readonly description: "Whether customer approval has been requested for this payment. For payments greater than INR 15000 or mandate amount, the customer must provide explicit approval of the payment with their bank."; readonly nullable: true; readonly type: "boolean"; }; readonly completes_at: { readonly description: "If customer approval is required, they need to provide approval before this time."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PaymentIntentProcessingCustomerNotification"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_intent_type_specific_payment_method_options_clientSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual", "manual_preferred"]; readonly type: "string"; }; readonly installments: { readonly $ref: "#/components/schemas/payment_flows_installment_options"; }; readonly require_cvc_recollection: { readonly description: "When enabled, using a card that is attached to a customer will require the CVC to be provided again (i.e. using the cvc_token parameter)."; readonly type: "boolean"; }; readonly routing: { readonly $ref: "#/components/schemas/payment_method_options_card_present_routing"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "PaymentIntentTypeSpecificPaymentMethodOptionsClient"; readonly type: "object"; readonly 'x-expandableFields': readonly ["installments", "routing"]; }; export declare const payment_linkSchema: { readonly description: "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)"; readonly properties: { readonly active: { readonly description: "Whether the payment link's `url` is active. If `false`, customers visiting the URL will be shown a page saying that the link has been deactivated."; readonly type: "boolean"; }; readonly after_completion: { readonly $ref: "#/components/schemas/payment_links_resource_after_completion"; }; readonly allow_promotion_codes: { readonly description: "Whether user redeemable promotion codes are enabled."; readonly type: "boolean"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "The ID of the Connect application that created the Payment Link."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly application_fee_amount: { readonly description: "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account."; readonly nullable: true; readonly type: "integer"; }; readonly application_fee_percent: { readonly description: "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account."; readonly nullable: true; readonly type: "number"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/payment_links_resource_automatic_tax"; }; readonly billing_address_collection: { readonly description: "Configuration for collecting the customer's billing address. Defaults to `auto`."; readonly enum: readonly ["auto", "required"]; readonly type: "string"; }; readonly consent_collection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_consent_collection"; }]; readonly description: "When set, provides configuration to gather active consent from customers."; readonly nullable: true; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly custom_fields: { readonly description: "Collect additional information from your customer using custom fields. Up to 3 fields are supported."; readonly items: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields"; }; readonly type: "array"; }; readonly custom_text: { readonly $ref: "#/components/schemas/payment_links_resource_custom_text"; }; readonly customer_creation: { readonly description: "Configuration for Customer creation during checkout."; readonly enum: readonly ["always", "if_required"]; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly inactive_message: { readonly description: "The custom message to be displayed to a customer when a payment link is no longer active."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_creation: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_invoice_creation"; }]; readonly description: "Configuration for creating invoice for payment mode payment links."; readonly nullable: true; }; readonly line_items: { readonly description: "The line items representing what is being sold."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "PaymentLinksResourceListLineItems"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payment_link"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly payment_intent_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_payment_intent_data"; }]; readonly description: "Indicates the parameters to be passed to PaymentIntent creation during checkout."; readonly nullable: true; }; readonly payment_method_collection: { readonly description: "Configuration for collecting a payment method during checkout. Defaults to `always`."; readonly enum: readonly ["always", "if_required"]; readonly type: "string"; }; readonly payment_method_types: { readonly description: "The list of payment method types that customers can use. When `null`, Stripe will dynamically show relevant payment methods you've enabled in your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."; readonly items: { readonly enum: readonly ["affirm", "afterpay_clearpay", "alipay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "cashapp", "eps", "fpx", "giropay", "grabpay", "ideal", "klarna", "konbini", "link", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly phone_number_collection: { readonly $ref: "#/components/schemas/payment_links_resource_phone_number_collection"; }; readonly restrictions: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_restrictions"; }]; readonly description: "Settings that restrict the usage of a payment link."; readonly nullable: true; }; readonly shipping_address_collection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_shipping_address_collection"; }]; readonly description: "Configuration for collecting the customer's shipping address."; readonly nullable: true; }; readonly shipping_options: { readonly description: "The shipping rate options applied to the session."; readonly items: { readonly $ref: "#/components/schemas/payment_links_resource_shipping_option"; }; readonly type: "array"; }; readonly submit_type: { readonly description: "Indicates the type of transaction being performed which customizes relevant text on the page, such as the submit button."; readonly enum: readonly ["auto", "book", "donate", "pay"]; readonly type: "string"; }; readonly subscription_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_subscription_data"; }]; readonly description: "When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use `subscription_data`."; readonly nullable: true; }; readonly tax_id_collection: { readonly $ref: "#/components/schemas/payment_links_resource_tax_id_collection"; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_transfer_data"; }]; readonly description: "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to."; readonly nullable: true; }; readonly url: { readonly description: "The public URL that can be shared with customers."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["active", "after_completion", "allow_promotion_codes", "automatic_tax", "billing_address_collection", "currency", "custom_fields", "custom_text", "customer_creation", "id", "livemode", "metadata", "object", "payment_method_collection", "phone_number_collection", "shipping_options", "submit_type", "tax_id_collection", "url"]; readonly title: "PaymentLink"; readonly type: "object"; readonly 'x-expandableFields': readonly ["after_completion", "application", "automatic_tax", "consent_collection", "custom_fields", "custom_text", "invoice_creation", "line_items", "on_behalf_of", "payment_intent_data", "phone_number_collection", "restrictions", "shipping_address_collection", "shipping_options", "subscription_data", "tax_id_collection", "transfer_data"]; readonly 'x-resourceId': "payment_link"; }; export declare const payment_links_resource_after_completionSchema: { readonly description: ""; readonly properties: { readonly hosted_confirmation: { readonly $ref: "#/components/schemas/payment_links_resource_completion_behavior_confirmation_page"; }; readonly redirect: { readonly $ref: "#/components/schemas/payment_links_resource_completion_behavior_redirect"; }; readonly type: { readonly description: "The specified behavior after the purchase is complete."; readonly enum: readonly ["hosted_confirmation", "redirect"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentLinksResourceAfterCompletion"; readonly type: "object"; readonly 'x-expandableFields': readonly ["hosted_confirmation", "redirect"]; }; export declare const payment_links_resource_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "If `true`, tax will be calculated automatically using the customer's location."; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentLinksResourceAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const payment_links_resource_completed_sessionsSchema: { readonly description: ""; readonly properties: { readonly count: { readonly description: "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met."; readonly type: "integer"; }; readonly limit: { readonly description: "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met."; readonly type: "integer"; }; }; readonly required: readonly ["count", "limit"]; readonly title: "PaymentLinksResourceCompletedSessions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_completion_behavior_confirmation_pageSchema: { readonly description: ""; readonly properties: { readonly custom_message: { readonly description: "The custom message that is displayed to the customer after the purchase is complete."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentLinksResourceCompletionBehaviorConfirmationPage"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_completion_behavior_redirectSchema: { readonly description: ""; readonly properties: { readonly url: { readonly description: "The URL the customer will be redirected to after the purchase is complete."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["url"]; readonly title: "PaymentLinksResourceCompletionBehaviorRedirect"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_consent_collectionSchema: { readonly description: ""; readonly properties: { readonly payment_method_reuse_agreement: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_payment_method_reuse_agreement"; }]; readonly description: "Settings related to the payment method reuse text shown in the Checkout UI."; readonly nullable: true; }; readonly promotions: { readonly description: "If set to `auto`, enables the collection of customer consent for promotional communications."; readonly enum: readonly ["auto", "none"]; readonly nullable: true; readonly type: "string"; }; readonly terms_of_service: { readonly description: "If set to `required`, it requires cutomers to accept the terms of service before being able to pay. If set to `none`, customers won't be shown a checkbox to accept the terms of service."; readonly enum: readonly ["none", "required"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentLinksResourceConsentCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_method_reuse_agreement"]; }; export declare const payment_links_resource_custom_fieldsSchema: { readonly description: ""; readonly properties: { readonly dropdown: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields_dropdown"; }; readonly key: { readonly description: "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly label: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields_label"; }; readonly numeric: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields_numeric"; }; readonly optional: { readonly description: "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."; readonly type: "boolean"; }; readonly text: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields_text"; }; readonly type: { readonly description: "The type of the field."; readonly enum: readonly ["dropdown", "numeric", "text"]; readonly type: "string"; }; }; readonly required: readonly ["key", "label", "optional", "type"]; readonly title: "PaymentLinksResourceCustomFields"; readonly type: "object"; readonly 'x-expandableFields': readonly ["dropdown", "label", "numeric", "text"]; }; export declare const payment_links_resource_custom_fields_dropdownSchema: { readonly description: ""; readonly properties: { readonly options: { readonly description: "The options available for the customer to select. Up to 200 options allowed."; readonly items: { readonly $ref: "#/components/schemas/payment_links_resource_custom_fields_dropdown_option"; }; readonly type: "array"; }; }; readonly required: readonly ["options"]; readonly title: "PaymentLinksResourceCustomFieldsDropdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["options"]; }; export declare const payment_links_resource_custom_fields_dropdown_optionSchema: { readonly description: ""; readonly properties: { readonly label: { readonly description: "The label for the option, displayed to the customer. Up to 100 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly value: { readonly description: "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["label", "value"]; readonly title: "PaymentLinksResourceCustomFieldsDropdownOption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_custom_fields_labelSchema: { readonly description: ""; readonly properties: { readonly custom: { readonly description: "Custom text for the label, displayed to the customer. Up to 50 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "The type of the label."; readonly enum: readonly ["custom"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentLinksResourceCustomFieldsLabel"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_custom_fields_numericSchema: { readonly description: ""; readonly properties: { readonly maximum_length: { readonly description: "The maximum character length constraint for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly minimum_length: { readonly description: "The minimum character length requirement for the customer's input."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PaymentLinksResourceCustomFieldsNumeric"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_custom_fields_textSchema: { readonly description: ""; readonly properties: { readonly maximum_length: { readonly description: "The maximum character length constraint for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly minimum_length: { readonly description: "The minimum character length requirement for the customer's input."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PaymentLinksResourceCustomFieldsText"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_custom_textSchema: { readonly description: ""; readonly properties: { readonly after_submit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_custom_text_position"; }]; readonly description: "Custom text that should be displayed after the payment confirmation button."; readonly nullable: true; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_custom_text_position"; }]; readonly description: "Custom text that should be displayed alongside shipping address collection."; readonly nullable: true; }; readonly submit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_custom_text_position"; }]; readonly description: "Custom text that should be displayed alongside the payment confirmation button."; readonly nullable: true; }; readonly terms_of_service_acceptance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_custom_text_position"; }]; readonly description: "Custom text that should be displayed in place of the default terms of service agreement text."; readonly nullable: true; }; }; readonly title: "PaymentLinksResourceCustomText"; readonly type: "object"; readonly 'x-expandableFields': readonly ["after_submit", "shipping_address", "submit", "terms_of_service_acceptance"]; }; export declare const payment_links_resource_custom_text_positionSchema: { readonly description: ""; readonly properties: { readonly message: { readonly description: "Text may be up to 1200 characters in length."; readonly maxLength: 500; readonly type: "string"; }; }; readonly required: readonly ["message"]; readonly title: "PaymentLinksResourceCustomTextPosition"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_invoice_creationSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Enable creating an invoice on successful payment."; readonly type: "boolean"; }; readonly invoice_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_links_resource_invoice_settings"; }]; readonly description: "Configuration for the invoice. Default invoice values will be used if unspecified."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentLinksResourceInvoiceCreation"; readonly type: "object"; readonly 'x-expandableFields': readonly ["invoice_data"]; }; export declare const payment_links_resource_invoice_settingsSchema: { readonly description: ""; readonly properties: { readonly account_tax_ids: { readonly description: "The account tax IDs associated with the invoice."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly custom_fields: { readonly description: "A list of up to 4 custom fields to be displayed on the invoice."; readonly items: { readonly $ref: "#/components/schemas/invoice_setting_custom_field"; }; readonly nullable: true; readonly type: "array"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly footer: { readonly description: "Footer to be displayed on the invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuer: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."; readonly nullable: true; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly rendering_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_setting_rendering_options"; }]; readonly description: "Options for invoice PDF rendering."; readonly nullable: true; }; }; readonly title: "PaymentLinksResourceInvoiceSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "custom_fields", "issuer", "rendering_options"]; }; export declare const payment_links_resource_payment_intent_dataSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Indicates when the funds will be captured from the customer's account."; readonly enum: readonly ["automatic", "automatic_async", "manual"]; readonly nullable: true; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link."; readonly type: "object"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with the payment method collected during checkout."; readonly enum: readonly ["off_session", "on_session"]; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly description: "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor_suffix: { readonly description: "Provides information about the charge that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transfer_group: { readonly description: "A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/connect/separate-charges-and-transfers) for details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["metadata"]; readonly title: "PaymentLinksResourcePaymentIntentData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_payment_method_reuse_agreementSchema: { readonly description: ""; readonly properties: { readonly position: { readonly description: "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."; readonly enum: readonly ["auto", "hidden"]; readonly type: "string"; }; }; readonly required: readonly ["position"]; readonly title: "PaymentLinksResourcePaymentMethodReuseAgreement"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_phone_number_collectionSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "If `true`, a phone number will be collected during checkout."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentLinksResourcePhoneNumberCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_restrictionsSchema: { readonly description: ""; readonly properties: { readonly completed_sessions: { readonly $ref: "#/components/schemas/payment_links_resource_completed_sessions"; }; }; readonly required: readonly ["completed_sessions"]; readonly title: "PaymentLinksResourceRestrictions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["completed_sessions"]; }; export declare const payment_links_resource_shipping_address_collectionSchema: { readonly description: ""; readonly properties: { readonly allowed_countries: { readonly description: "An array of two-letter ISO country codes representing which countries Checkout should provide as options for shipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`."; readonly items: { readonly enum: readonly ["AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ"]; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["allowed_countries"]; readonly title: "PaymentLinksResourceShippingAddressCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_shipping_optionSchema: { readonly description: ""; readonly properties: { readonly shipping_amount: { readonly description: "A non-negative integer in cents representing how much to charge."; readonly type: "integer"; }; readonly shipping_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/shipping_rate"; }]; readonly description: "The ID of the Shipping Rate to use for this shipping option."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate"; }]; }; }; }; readonly required: readonly ["shipping_amount", "shipping_rate"]; readonly title: "PaymentLinksResourceShippingOption"; readonly type: "object"; readonly 'x-expandableFields': readonly ["shipping_rate"]; }; export declare const payment_links_resource_subscription_dataSchema: { readonly description: ""; readonly properties: { readonly description: { readonly description: "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_settings: { readonly $ref: "#/components/schemas/payment_links_resource_subscription_data_invoice_settings"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link."; readonly type: "object"; }; readonly trial_period_days: { readonly description: "Integer representing the number of trial period days before the customer is charged for the first time."; readonly nullable: true; readonly type: "integer"; }; readonly trial_settings: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_trials_resource_trial_settings"; }]; readonly description: "Settings related to subscription trials."; readonly nullable: true; }; }; readonly required: readonly ["invoice_settings", "metadata"]; readonly title: "PaymentLinksResourceSubscriptionData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["invoice_settings", "trial_settings"]; }; export declare const payment_links_resource_subscription_data_invoice_settingsSchema: { readonly description: ""; readonly properties: { readonly issuer: { readonly $ref: "#/components/schemas/connect_account_reference"; }; }; readonly required: readonly ["issuer"]; readonly title: "PaymentLinksResourceSubscriptionDataInvoiceSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["issuer"]; }; export declare const payment_links_resource_tax_id_collectionSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates whether tax ID collection is enabled for the session."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentLinksResourceTaxIdCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_links_resource_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount in cents (or local equivalent) that will be transferred to the destination account. By default, the entire amount is transferred to the destination."; readonly nullable: true; readonly type: "integer"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The connected account receiving the transfer."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "PaymentLinksResourceTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const payment_methodSchema: { readonly description: "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios)."; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/payment_method_acss_debit"; }; readonly affirm: { readonly $ref: "#/components/schemas/payment_method_affirm"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/payment_method_afterpay_clearpay"; }; readonly alipay: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_alipay"; }; readonly allow_redisplay: { readonly description: "This field indicates whether this payment method can be shown again to its customer in a checkout flow. Stripe products such as Checkout and Elements use this field to determine whether a payment method can be shown as a saved payment method in a checkout flow. The field defaults to “unspecified”."; readonly enum: readonly ["always", "limited", "unspecified"]; readonly type: "string"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/payment_method_amazon_pay"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/payment_method_au_becs_debit"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/payment_method_bacs_debit"; }; readonly bancontact: { readonly $ref: "#/components/schemas/payment_method_bancontact"; }; readonly billing_details: { readonly $ref: "#/components/schemas/billing_details"; }; readonly blik: { readonly $ref: "#/components/schemas/payment_method_blik"; }; readonly boleto: { readonly $ref: "#/components/schemas/payment_method_boleto"; }; readonly card: { readonly $ref: "#/components/schemas/payment_method_card"; }; readonly card_present: { readonly $ref: "#/components/schemas/payment_method_card_present"; }; readonly cashapp: { readonly $ref: "#/components/schemas/payment_method_cashapp"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly customer_balance: { readonly $ref: "#/components/schemas/payment_method_customer_balance"; }; readonly eps: { readonly $ref: "#/components/schemas/payment_method_eps"; }; readonly fpx: { readonly $ref: "#/components/schemas/payment_method_fpx"; }; readonly giropay: { readonly $ref: "#/components/schemas/payment_method_giropay"; }; readonly grabpay: { readonly $ref: "#/components/schemas/payment_method_grabpay"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly ideal: { readonly $ref: "#/components/schemas/payment_method_ideal"; }; readonly interac_present: { readonly $ref: "#/components/schemas/payment_method_interac_present"; }; readonly klarna: { readonly $ref: "#/components/schemas/payment_method_klarna"; }; readonly konbini: { readonly $ref: "#/components/schemas/payment_method_konbini"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_link"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly mobilepay: { readonly $ref: "#/components/schemas/payment_method_mobilepay"; }; readonly multibanco: { readonly $ref: "#/components/schemas/payment_method_multibanco"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payment_method"]; readonly type: "string"; }; readonly oxxo: { readonly $ref: "#/components/schemas/payment_method_oxxo"; }; readonly p24: { readonly $ref: "#/components/schemas/payment_method_p24"; }; readonly paynow: { readonly $ref: "#/components/schemas/payment_method_paynow"; }; readonly paypal: { readonly $ref: "#/components/schemas/payment_method_paypal"; }; readonly pix: { readonly $ref: "#/components/schemas/payment_method_pix"; }; readonly promptpay: { readonly $ref: "#/components/schemas/payment_method_promptpay"; }; readonly radar_options: { readonly $ref: "#/components/schemas/radar_radar_options"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/payment_method_revolut_pay"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/payment_method_sepa_debit"; }; readonly sofort: { readonly $ref: "#/components/schemas/payment_method_sofort"; }; readonly swish: { readonly $ref: "#/components/schemas/payment_method_swish"; }; readonly twint: { readonly $ref: "#/components/schemas/payment_method_twint"; }; readonly type: { readonly description: "The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type."; readonly enum: readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/payment_method_us_bank_account"; }; readonly wechat_pay: { readonly $ref: "#/components/schemas/payment_method_wechat_pay"; }; readonly zip: { readonly $ref: "#/components/schemas/payment_method_zip"; }; }; readonly required: readonly ["billing_details", "created", "id", "livemode", "object", "type"]; readonly title: "PaymentMethod"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "billing_details", "blik", "boleto", "card", "card_present", "cashapp", "customer", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "radar_options", "revolut_pay", "sepa_debit", "sofort", "swish", "twint", "us_bank_account", "wechat_pay", "zip"]; readonly 'x-resourceId': "payment_method"; }; export declare const payment_method_acss_debitSchema: { readonly description: ""; readonly properties: { readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly institution_number: { readonly description: "Institution number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transit_number: { readonly description: "Transit number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_affirmSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_affirm"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_afterpay_clearpaySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_afterpay_clearpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_amazon_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_au_becs_debitSchema: { readonly description: ""; readonly properties: { readonly bsb_number: { readonly description: "Six-digit number identifying bank and branch associated with this bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_au_becs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_bacs_debitSchema: { readonly description: ""; readonly properties: { readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sort_code: { readonly description: "Sort code of the bank account. (e.g., `10-20-30`)"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_bacs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_bancontactSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_bancontact"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_blikSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_blik"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_boletoSchema: { readonly description: ""; readonly properties: { readonly tax_id: { readonly description: "Uniquely identifies the customer tax id (CNPJ or CPF)"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["tax_id"]; readonly title: "payment_method_boleto"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_cardSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly checks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_card_checks"; }]; readonly description: "Checks on Card address and CVC if provided."; readonly nullable: true; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly display_brand: { readonly description: "The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be `american_express`, `cartes_bancaires`, `diners_club`, `discover`, `eftpos_australia`, `interac`, `jcb`, `mastercard`, `union_pay`, `visa`, or `other` and may contain more values in the future."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly generated_from: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_card_generated_card"; }]; readonly description: "Details of the original PaymentMethod that created this object."; readonly nullable: true; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly type: "string"; }; readonly networks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/networks"; }]; readonly description: "Contains information about card networks that can be used to process the payment."; readonly nullable: true; }; readonly three_d_secure_usage: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/three_d_secure_usage"; }]; readonly description: "Contains details on how this Card may be used for 3D Secure authentication."; readonly nullable: true; }; readonly wallet: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_card_wallet"; }]; readonly description: "If this Card is part of a card wallet, this contains the details of the card wallet."; readonly nullable: true; }; }; readonly required: readonly ["brand", "exp_month", "exp_year", "funding", "last4"]; readonly title: "payment_method_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["checks", "generated_from", "networks", "three_d_secure_usage", "wallet"]; }; export declare const payment_method_card_checksSchema: { readonly description: ""; readonly properties: { readonly address_line1_check: { readonly description: "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_postal_code_check: { readonly description: "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cvc_check: { readonly description: "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_card_checks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_generated_cardSchema: { readonly description: ""; readonly properties: { readonly charge: { readonly description: "The charge that created this object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_method_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/card_generated_from_payment_method_details"; }]; readonly description: "Transaction-specific details of the payment method used in the payment."; readonly nullable: true; }; readonly setup_attempt: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_attempt"; }]; readonly description: "The ID of the SetupAttempt that generated this PaymentMethod, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_attempt"; }]; }; }; }; readonly title: "payment_method_card_generated_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_method_details", "setup_attempt"]; }; export declare const payment_method_card_presentSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cardholder_name: { readonly description: "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly networks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_card_present_networks"; }]; readonly description: "Contains information about card networks that can be used to process the payment."; readonly nullable: true; }; readonly preferred_locales: { readonly description: "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly read_method: { readonly description: "How card details were read in this transaction."; readonly enum: readonly ["contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["exp_month", "exp_year"]; readonly title: "payment_method_card_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["networks"]; }; export declare const payment_method_card_present_networksSchema: { readonly description: ""; readonly properties: { readonly available: { readonly description: "All available networks for the card."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly preferred: { readonly description: "The preferred network for the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["available"]; readonly title: "payment_method_card_present_networks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_walletSchema: { readonly description: ""; readonly properties: { readonly amex_express_checkout: { readonly $ref: "#/components/schemas/payment_method_card_wallet_amex_express_checkout"; }; readonly apple_pay: { readonly $ref: "#/components/schemas/payment_method_card_wallet_apple_pay"; }; readonly dynamic_last4: { readonly description: "(For tokenized numbers only.) The last four digits of the device account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly google_pay: { readonly $ref: "#/components/schemas/payment_method_card_wallet_google_pay"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_card_wallet_link"; }; readonly masterpass: { readonly $ref: "#/components/schemas/payment_method_card_wallet_masterpass"; }; readonly samsung_pay: { readonly $ref: "#/components/schemas/payment_method_card_wallet_samsung_pay"; }; readonly type: { readonly description: "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."; readonly enum: readonly ["amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout"]; readonly type: "string"; }; readonly visa_checkout: { readonly $ref: "#/components/schemas/payment_method_card_wallet_visa_checkout"; }; }; readonly required: readonly ["type"]; readonly title: "payment_method_card_wallet"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout"]; }; export declare const payment_method_card_wallet_amex_express_checkoutSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_card_wallet_amex_express_checkout"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_wallet_apple_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_card_wallet_apple_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_wallet_google_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_card_wallet_google_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_wallet_linkSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_card_wallet_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_wallet_masterpassSchema: { readonly description: ""; readonly properties: { readonly billing_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; readonly email: { readonly description: "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; }; readonly title: "payment_method_card_wallet_masterpass"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_address", "shipping_address"]; }; export declare const payment_method_card_wallet_samsung_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_card_wallet_samsung_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_card_wallet_visa_checkoutSchema: { readonly description: ""; readonly properties: { readonly billing_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; readonly email: { readonly description: "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; }; readonly title: "payment_method_card_wallet_visa_checkout"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_address", "shipping_address"]; }; export declare const payment_method_cashappSchema: { readonly description: ""; readonly properties: { readonly buyer_id: { readonly description: "A unique and immutable identifier assigned by Cash App to every buyer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cashtag: { readonly description: "A public identifier for buyers using Cash App."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_cashapp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_config_biz_payment_method_configuration_detailsSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "ID of the payment method configuration used."; readonly maxLength: 5000; readonly type: "string"; }; readonly parent: { readonly description: "ID of the parent payment method configuration used."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["id"]; readonly title: "PaymentMethodConfigBizPaymentMethodConfigurationDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_config_resource_display_preferenceSchema: { readonly description: ""; readonly properties: { readonly overridable: { readonly description: "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used."; readonly nullable: true; readonly type: "boolean"; }; readonly preference: { readonly description: "The account's display preference."; readonly enum: readonly ["none", "off", "on"]; readonly type: "string"; }; readonly value: { readonly description: "The effective display preference value."; readonly enum: readonly ["off", "on"]; readonly type: "string"; }; }; readonly required: readonly ["preference", "value"]; readonly title: "PaymentMethodConfigResourceDisplayPreference"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_config_resource_payment_method_propertiesSchema: { readonly description: ""; readonly properties: { readonly available: { readonly description: "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active."; readonly type: "boolean"; }; readonly display_preference: { readonly $ref: "#/components/schemas/payment_method_config_resource_display_preference"; }; }; readonly required: readonly ["available", "display_preference"]; readonly title: "PaymentMethodConfigResourcePaymentMethodProperties"; readonly type: "object"; readonly 'x-expandableFields': readonly ["display_preference"]; }; export declare const payment_method_configurationSchema: { readonly description: "PaymentMethodConfigurations control which payment methods are displayed to your customers when you don't explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.\n\nThere are two types of PaymentMethodConfigurations. Which is used depends on the [charge type](https://stripe.com/docs/connect/charges):\n\n**Direct** configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.\n\n**Child** configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.\n\nChild configurations have a `parent` that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are [managed in the dashboard](https://dashboard.stripe.com/settings/payment_methods/connected_accounts) and are not available in this API.\n\nRelated guides:\n- [Payment Method Configurations API](https://stripe.com/docs/connect/payment-method-configurations)\n- [Multiple configurations on dynamic payment methods](https://stripe.com/docs/payments/multiple-payment-method-configs)\n- [Multiple configurations for your Connect accounts](https://stripe.com/docs/connect/multiple-payment-method-configurations)"; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly active: { readonly description: "Whether the configuration can be used for new payments."; readonly type: "boolean"; }; readonly affirm: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly alipay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly apple_pay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly application: { readonly description: "For child configs, the Connect application associated with the configuration."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly bancontact: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly blik: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly boleto: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly card: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly cartes_bancaires: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly cashapp: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly customer_balance: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly eps: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly fpx: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly giropay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly google_pay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly grabpay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly ideal: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly is_default: { readonly description: "The default configuration is used whenever a payment method configuration is not specified."; readonly type: "boolean"; }; readonly jcb: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly klarna: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly konbini: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly mobilepay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly multibanco: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly name: { readonly description: "The configuration's name."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payment_method_configuration"]; readonly type: "string"; }; readonly oxxo: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly p24: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly parent: { readonly description: "For child configs, the configuration's parent configuration."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly paynow: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly paypal: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly promptpay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly sofort: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly swish: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly wechat_pay: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; readonly zip: { readonly $ref: "#/components/schemas/payment_method_config_resource_payment_method_properties"; }; }; readonly required: readonly ["active", "id", "is_default", "livemode", "name", "object"]; readonly title: "PaymentMethodConfigResourcePaymentMethodConfiguration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "apple_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "cartes_bancaires", "cashapp", "customer_balance", "eps", "fpx", "giropay", "google_pay", "grabpay", "ideal", "jcb", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay", "zip"]; readonly 'x-resourceId': "payment_method_configuration"; }; export declare const payment_method_customer_balanceSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_customer_balance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly ach_credit_transfer: { readonly $ref: "#/components/schemas/payment_method_details_ach_credit_transfer"; }; readonly ach_debit: { readonly $ref: "#/components/schemas/payment_method_details_ach_debit"; }; readonly acss_debit: { readonly $ref: "#/components/schemas/payment_method_details_acss_debit"; }; readonly affirm: { readonly $ref: "#/components/schemas/payment_method_details_affirm"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/payment_method_details_afterpay_clearpay"; }; readonly alipay: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_alipay_details"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/payment_method_details_amazon_pay"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/payment_method_details_au_becs_debit"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/payment_method_details_bacs_debit"; }; readonly bancontact: { readonly $ref: "#/components/schemas/payment_method_details_bancontact"; }; readonly blik: { readonly $ref: "#/components/schemas/payment_method_details_blik"; }; readonly boleto: { readonly $ref: "#/components/schemas/payment_method_details_boleto"; }; readonly card: { readonly $ref: "#/components/schemas/payment_method_details_card"; }; readonly card_present: { readonly $ref: "#/components/schemas/payment_method_details_card_present"; }; readonly cashapp: { readonly $ref: "#/components/schemas/payment_method_details_cashapp"; }; readonly customer_balance: { readonly $ref: "#/components/schemas/payment_method_details_customer_balance"; }; readonly eps: { readonly $ref: "#/components/schemas/payment_method_details_eps"; }; readonly fpx: { readonly $ref: "#/components/schemas/payment_method_details_fpx"; }; readonly giropay: { readonly $ref: "#/components/schemas/payment_method_details_giropay"; }; readonly grabpay: { readonly $ref: "#/components/schemas/payment_method_details_grabpay"; }; readonly ideal: { readonly $ref: "#/components/schemas/payment_method_details_ideal"; }; readonly interac_present: { readonly $ref: "#/components/schemas/payment_method_details_interac_present"; }; readonly klarna: { readonly $ref: "#/components/schemas/payment_method_details_klarna"; }; readonly konbini: { readonly $ref: "#/components/schemas/payment_method_details_konbini"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_details_link"; }; readonly mobilepay: { readonly $ref: "#/components/schemas/payment_method_details_mobilepay"; }; readonly multibanco: { readonly $ref: "#/components/schemas/payment_method_details_multibanco"; }; readonly oxxo: { readonly $ref: "#/components/schemas/payment_method_details_oxxo"; }; readonly p24: { readonly $ref: "#/components/schemas/payment_method_details_p24"; }; readonly paynow: { readonly $ref: "#/components/schemas/payment_method_details_paynow"; }; readonly paypal: { readonly $ref: "#/components/schemas/payment_method_details_paypal"; }; readonly pix: { readonly $ref: "#/components/schemas/payment_method_details_pix"; }; readonly promptpay: { readonly $ref: "#/components/schemas/payment_method_details_promptpay"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/payment_method_details_revolut_pay"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/payment_method_details_sepa_debit"; }; readonly sofort: { readonly $ref: "#/components/schemas/payment_method_details_sofort"; }; readonly stripe_account: { readonly $ref: "#/components/schemas/payment_method_details_stripe_account"; }; readonly swish: { readonly $ref: "#/components/schemas/payment_method_details_swish"; }; readonly twint: { readonly $ref: "#/components/schemas/payment_method_details_twint"; }; readonly type: { readonly description: "The type of transaction-specific details of the payment method used in the payment, one of `ach_credit_transfer`, `ach_debit`, `acss_debit`, `alipay`, `au_becs_debit`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `klarna`, `multibanco`, `p24`, `sepa_debit`, `sofort`, `stripe_account`, or `wechat`.\nAn additional hash is included on `payment_method_details` with a name matching this value.\nIt contains information specific to the payment method."; readonly maxLength: 5000; readonly type: "string"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/payment_method_details_us_bank_account"; }; readonly wechat: { readonly $ref: "#/components/schemas/payment_method_details_wechat"; }; readonly wechat_pay: { readonly $ref: "#/components/schemas/payment_method_details_wechat_pay"; }; readonly zip: { readonly $ref: "#/components/schemas/payment_method_details_zip"; }; }; readonly required: readonly ["type"]; readonly title: "payment_method_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach_credit_transfer", "ach_debit", "acss_debit", "affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "blik", "boleto", "card", "card_present", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "interac_present", "klarna", "konbini", "link", "mobilepay", "multibanco", "oxxo", "p24", "paynow", "paypal", "pix", "promptpay", "revolut_pay", "sepa_debit", "sofort", "stripe_account", "swish", "twint", "us_bank_account", "wechat", "wechat_pay", "zip"]; }; export declare const payment_method_details_ach_credit_transferSchema: { readonly description: ""; readonly properties: { readonly account_number: { readonly description: "Account number to transfer funds to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the routing number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing transit number for the bank account to transfer funds to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly swift_code: { readonly description: "SWIFT code of the bank associated with the routing number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_ach_credit_transfer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_ach_debitSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Type of entity that holds the account. This can be either `individual` or `company`."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing transit number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_ach_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_acss_debitSchema: { readonly description: ""; readonly properties: { readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly institution_number: { readonly description: "Institution number of the bank account"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly description: "ID of the mandate used to make this payment."; readonly maxLength: 5000; readonly type: "string"; }; readonly transit_number: { readonly description: "Transit number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_affirmSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_affirm"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_afterpay_clearpaySchema: { readonly description: ""; readonly properties: { readonly order_id: { readonly description: "The Afterpay order ID associated with this payment intent."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "Order identifier shown to the merchant in Afterpay’s online portal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_afterpay_clearpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_amazon_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_au_becs_debitSchema: { readonly description: ""; readonly properties: { readonly bsb_number: { readonly description: "Bank-State-Branch number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly description: "ID of the mandate used to make this payment."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "payment_method_details_au_becs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_bacs_debitSchema: { readonly description: ""; readonly properties: { readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly description: "ID of the mandate used to make this payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly sort_code: { readonly description: "Sort code of the bank account. (e.g., `10-20-30`)"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_bacs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_bancontactSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "Bank Identifier Code of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly description: "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"; readonly enum: readonly ["de", "en", "fr", "nl"]; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_bancontact"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const payment_method_details_blikSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_blik"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_boletoSchema: { readonly description: ""; readonly properties: { readonly tax_id: { readonly description: "The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers)"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["tax_id"]; readonly title: "payment_method_details_boleto"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_cardSchema: { readonly description: ""; readonly properties: { readonly amount_authorized: { readonly description: "The authorized amount."; readonly nullable: true; readonly type: "integer"; }; readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly capture_before: { readonly description: "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured."; readonly format: "unix-time"; readonly type: "integer"; }; readonly checks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_checks"; }]; readonly description: "Check results by Card networks on Card address and CVC at time of payment."; readonly nullable: true; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly extended_authorization: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly incremental_authorization: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"; }; readonly installments: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_installments"; }]; readonly description: "Installment details for this payment (Mexico only).\n\nFor more information, see the [installments integration guide](https://stripe.com/docs/payments/installments)."; readonly nullable: true; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly description: "ID of the mandate used to make this payment or created by it."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly multicapture: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture"; }; readonly network: { readonly description: "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly network_token: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_network_token"; }]; readonly description: "If this card has network token credentials, this contains the details of the network token credentials."; readonly nullable: true; }; readonly overcapture: { readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"; }; readonly three_d_secure: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/three_d_secure_details_charge"; }]; readonly description: "Populated if this transaction used 3D Secure authentication."; readonly nullable: true; }; readonly wallet: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_wallet"; }]; readonly description: "If this Card is part of a card wallet, this contains the details of the card wallet."; readonly nullable: true; }; }; readonly required: readonly ["exp_month", "exp_year"]; readonly title: "payment_method_details_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["checks", "extended_authorization", "incremental_authorization", "installments", "multicapture", "network_token", "overcapture", "three_d_secure", "wallet"]; }; export declare const payment_method_details_card_checksSchema: { readonly description: ""; readonly properties: { readonly address_line1_check: { readonly description: "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_postal_code_check: { readonly description: "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cvc_check: { readonly description: "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_card_checks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_installmentsSchema: { readonly description: ""; readonly properties: { readonly plan: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_installments_plan"; }]; readonly description: "Installment plan selected for the payment."; readonly nullable: true; }; }; readonly title: "payment_method_details_card_installments"; readonly type: "object"; readonly 'x-expandableFields': readonly ["plan"]; }; export declare const payment_method_details_card_installments_planSchema: { readonly description: ""; readonly properties: { readonly count: { readonly description: "For `fixed_count` installment plans, this is the number of installment payments your customer will make to their credit card."; readonly nullable: true; readonly type: "integer"; }; readonly interval: { readonly description: "For `fixed_count` installment plans, this is the interval between installment payments your customer will make to their credit card.\nOne of `month`."; readonly enum: readonly ["month"]; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "Type of installment plan, one of `fixed_count`."; readonly enum: readonly ["fixed_count"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "payment_method_details_card_installments_plan"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_network_tokenSchema: { readonly description: ""; readonly properties: { readonly used: { readonly description: "Indicates if Stripe used a network token, either user provided or Stripe managed when processing the transaction."; readonly type: "boolean"; }; }; readonly required: readonly ["used"]; readonly title: "payment_method_details_card_network_token"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_presentSchema: { readonly description: ""; readonly properties: { readonly amount_authorized: { readonly description: "The authorized amount"; readonly nullable: true; readonly type: "integer"; }; readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly capture_before: { readonly description: "When using manual capture, a future timestamp after which the charge will be automatically refunded if uncaptured."; readonly format: "unix-time"; readonly type: "integer"; }; readonly cardholder_name: { readonly description: "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly emv_auth_data: { readonly description: "Authorization response cryptogram."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_card: { readonly description: "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly incremental_authorization_supported: { readonly description: "Whether this [PaymentIntent](https://stripe.com/docs/api/payment_intents) is eligible for incremental authorizations. Request support using [request_incremental_authorization_support](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-payment_method_options-card_present-request_incremental_authorization_support)."; readonly type: "boolean"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly network: { readonly description: "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly offline: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_present_offline"; }]; readonly description: "Details about payments collected offline."; readonly nullable: true; }; readonly overcapture_supported: { readonly description: "Defines whether the authorized amount can be over-captured or not"; readonly type: "boolean"; }; readonly preferred_locales: { readonly description: "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly read_method: { readonly description: "How card details were read in this transaction."; readonly enum: readonly ["contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2"]; readonly nullable: true; readonly type: "string"; }; readonly receipt: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_present_receipt"; }]; readonly description: "A collection of fields required to be displayed on receipts. Only required for EMV transactions."; readonly nullable: true; }; }; readonly required: readonly ["exp_month", "exp_year", "incremental_authorization_supported", "overcapture_supported"]; readonly title: "payment_method_details_card_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["offline", "receipt"]; }; export declare const payment_method_details_card_present_offlineSchema: { readonly description: ""; readonly properties: { readonly stored_at: { readonly description: "Time at which the payment was collected while offline"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "payment_method_details_card_present_offline"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_present_receiptSchema: { readonly description: ""; readonly properties: { readonly account_type: { readonly description: "The type of account being debited or credited"; readonly enum: readonly ["checking", "credit", "prepaid", "unknown"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly application_cryptogram: { readonly description: "EMV tag 9F26, cryptogram generated by the integrated circuit chip."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly application_preferred_name: { readonly description: "Mnenomic of the Application Identifier."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly authorization_code: { readonly description: "Identifier for this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly authorization_response_code: { readonly description: "EMV tag 8A. A code returned by the card issuer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cardholder_verification_method: { readonly description: "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly dedicated_file_name: { readonly description: "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly terminal_verification_results: { readonly description: "The outcome of a series of EMV functions performed by the card reader."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_status_information: { readonly description: "An indication of various EMV functions performed during the transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_card_present_receipt"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_walletSchema: { readonly description: ""; readonly properties: { readonly amex_express_checkout: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_amex_express_checkout"; }; readonly apple_pay: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_apple_pay"; }; readonly dynamic_last4: { readonly description: "(For tokenized numbers only.) The last four digits of the device account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly google_pay: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_google_pay"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_link"; }; readonly masterpass: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_masterpass"; }; readonly samsung_pay: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_samsung_pay"; }; readonly type: { readonly description: "The type of the card wallet, one of `amex_express_checkout`, `apple_pay`, `google_pay`, `masterpass`, `samsung_pay`, `visa_checkout`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."; readonly enum: readonly ["amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout"]; readonly type: "string"; }; readonly visa_checkout: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_visa_checkout"; }; }; readonly required: readonly ["type"]; readonly title: "payment_method_details_card_wallet"; readonly type: "object"; readonly 'x-expandableFields': readonly ["amex_express_checkout", "apple_pay", "google_pay", "link", "masterpass", "samsung_pay", "visa_checkout"]; }; export declare const payment_method_details_card_wallet_amex_express_checkoutSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_card_wallet_amex_express_checkout"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_wallet_apple_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_card_wallet_apple_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_wallet_google_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_card_wallet_google_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_wallet_linkSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_card_wallet_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_wallet_masterpassSchema: { readonly description: ""; readonly properties: { readonly billing_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; readonly email: { readonly description: "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; }; readonly title: "payment_method_details_card_wallet_masterpass"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_address", "shipping_address"]; }; export declare const payment_method_details_card_wallet_samsung_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_card_wallet_samsung_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_card_wallet_visa_checkoutSchema: { readonly description: ""; readonly properties: { readonly billing_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified billing address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; readonly email: { readonly description: "Owner's verified email. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Owner's verified full name. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's verified shipping address. Values are verified or provided by the wallet directly (if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; }; readonly title: "payment_method_details_card_wallet_visa_checkout"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_address", "shipping_address"]; }; export declare const payment_method_details_cashappSchema: { readonly description: ""; readonly properties: { readonly buyer_id: { readonly description: "A unique and immutable identifier assigned by Cash App to every buyer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cashtag: { readonly description: "A public identifier for buyers using Cash App."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_cashapp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_customer_balanceSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_customer_balance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_epsSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`."; readonly enum: readonly ["arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau"]; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by EPS directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nEPS rarely provides this information so the attribute is usually empty."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_eps"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_fpxSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."; readonly enum: readonly ["affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob"]; readonly type: "string"; }; readonly transaction_id: { readonly description: "Unique transaction id generated by FPX for every request from the merchant"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["bank"]; readonly title: "payment_method_details_fpx"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_giropaySchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "Bank Identifier Code of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by Giropay directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nGiropay rarely provides this information so the attribute is usually empty."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_giropay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_grabpaySchema: { readonly description: ""; readonly properties: { readonly transaction_id: { readonly description: "Unique transaction id generated by GrabPay"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_grabpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_idealSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."; readonly enum: readonly ["abn_amro", "asn_bank", "bunq", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe"]; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "The Bank Identifier Code of the customer's bank."; readonly enum: readonly ["ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U"]; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_ideal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const payment_method_details_interac_presentSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `interac`, `mastercard` or `visa`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cardholder_name: { readonly description: "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly emv_auth_data: { readonly description: "Authorization response cryptogram."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_card: { readonly description: "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly network: { readonly description: "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_locales: { readonly description: "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly read_method: { readonly description: "How card details were read in this transaction."; readonly enum: readonly ["contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2"]; readonly nullable: true; readonly type: "string"; }; readonly receipt: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_interac_present_receipt"; }]; readonly description: "A collection of fields required to be displayed on receipts. Only required for EMV transactions."; readonly nullable: true; }; }; readonly required: readonly ["exp_month", "exp_year"]; readonly title: "payment_method_details_interac_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["receipt"]; }; export declare const payment_method_details_interac_present_receiptSchema: { readonly description: ""; readonly properties: { readonly account_type: { readonly description: "The type of account being debited or credited"; readonly enum: readonly ["checking", "savings", "unknown"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly application_cryptogram: { readonly description: "EMV tag 9F26, cryptogram generated by the integrated circuit chip."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly application_preferred_name: { readonly description: "Mnenomic of the Application Identifier."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly authorization_code: { readonly description: "Identifier for this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly authorization_response_code: { readonly description: "EMV tag 8A. A code returned by the card issuer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cardholder_verification_method: { readonly description: "Describes the method used by the cardholder to verify ownership of the card. One of the following: `approval`, `failure`, `none`, `offline_pin`, `offline_pin_and_signature`, `online_pin`, or `signature`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly dedicated_file_name: { readonly description: "EMV tag 84. Similar to the application identifier stored on the integrated circuit chip."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly terminal_verification_results: { readonly description: "The outcome of a series of EMV functions performed by the card reader."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_status_information: { readonly description: "An indication of various EMV functions performed during the transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_interac_present_receipt"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_klarnaSchema: { readonly description: ""; readonly properties: { readonly payment_method_category: { readonly description: "The Klarna payment method used for this transaction.\nCan be one of `pay_later`, `pay_now`, `pay_with_financing`, or `pay_in_installments`"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_locale: { readonly description: "Preferred language of the Klarna authorization page that the customer is redirected to.\nCan be one of `de-AT`, `en-AT`, `nl-BE`, `fr-BE`, `en-BE`, `de-DE`, `en-DE`, `da-DK`, `en-DK`, `es-ES`, `en-ES`, `fi-FI`, `sv-FI`, `en-FI`, `en-GB`, `en-IE`, `it-IT`, `en-IT`, `nl-NL`, `en-NL`, `nb-NO`, `en-NO`, `sv-SE`, `en-SE`, `en-US`, `es-US`, `fr-FR`, `en-FR`, `cs-CZ`, `en-CZ`, `ro-RO`, `en-RO`, `el-GR`, `en-GR`, `en-AU`, `en-NZ`, `en-CA`, `fr-CA`, `pl-PL`, `en-PL`, `pt-PT`, `en-PT`, `de-CH`, `fr-CH`, `it-CH`, or `en-CH`"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_klarna"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_konbiniSchema: { readonly description: ""; readonly properties: { readonly store: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_konbini_store"; }]; readonly description: "If the payment succeeded, this contains the details of the convenience store where the payment was completed."; readonly nullable: true; }; }; readonly title: "payment_method_details_konbini"; readonly type: "object"; readonly 'x-expandableFields': readonly ["store"]; }; export declare const payment_method_details_konbini_storeSchema: { readonly description: ""; readonly properties: { readonly chain: { readonly description: "The name of the convenience store chain where the payment was completed."; readonly enum: readonly ["familymart", "lawson", "ministop", "seicomart"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_konbini_store"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_linkSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "Two-letter ISO code representing the funding source country beneath the Link payment.\nYou could use this attribute to get a sense of international fees."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_mobilepaySchema: { readonly description: ""; readonly properties: { readonly card: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/internal_card"; }]; readonly description: "Internal card details"; readonly nullable: true; }; }; readonly title: "payment_method_details_mobilepay"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card"]; }; export declare const payment_method_details_multibancoSchema: { readonly description: ""; readonly properties: { readonly entity: { readonly description: "Entity number associated with this Multibanco payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "Reference number associated with this Multibanco payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_multibanco"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_oxxoSchema: { readonly description: ""; readonly properties: { readonly number: { readonly description: "OXXO reference number"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_oxxo"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_p24Schema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Can be one of `ing`, `citi_handlowy`, `tmobile_usbugi_bankowe`, `plus_bank`, `etransfer_pocztowy24`, `banki_spbdzielcze`, `bank_nowy_bfg_sa`, `getin_bank`, `velobank`, `blik`, `noble_pay`, `ideabank`, `envelobank`, `santander_przelew24`, `nest_przelew`, `mbank_mtransfer`, `inteligo`, `pbac_z_ipko`, `bnp_paribas`, `credit_agricole`, `toyota_bank`, `bank_pekao_sa`, `volkswagen_bank`, `bank_millennium`, `alior_bank`, or `boz`."; readonly enum: readonly ["alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank"]; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "Unique reference for this Przelewy24 payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by Przelewy24 directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated.\nPrzelewy24 rarely provides this information so the attribute is usually empty."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_p24"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_paynowSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "Reference number associated with this PayNow payment"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_paynow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_paypalSchema: { readonly description: ""; readonly properties: { readonly payer_email: { readonly description: "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payer_id: { readonly description: "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payer_name: { readonly description: "Owner's full name. Values provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly seller_protection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/paypal_seller_protection"; }]; readonly description: "The level of protection offered as defined by PayPal Seller Protection for Merchants, for this transaction."; readonly nullable: true; }; readonly transaction_id: { readonly description: "A unique ID generated by PayPal for this transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["seller_protection"]; }; export declare const payment_method_details_pixSchema: { readonly description: ""; readonly properties: { readonly bank_transaction_id: { readonly description: "Unique transaction id generated by BCB"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_pix"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_promptpaySchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "Bill reference generated by PromptPay"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_promptpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_revolut_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_revolut_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_sepa_debitSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly branch_code: { readonly description: "Branch code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly description: "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_sofortSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "Bank Identifier Code of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly description: "Preferred language of the SOFORT authorization page that the customer is redirected to.\nCan be one of `de`, `en`, `es`, `fr`, `it`, `nl`, or `pl`"; readonly enum: readonly ["de", "en", "es", "fr", "it", "nl", "pl"]; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by SOFORT directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_sofort"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const payment_method_details_stripe_accountSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_stripe_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_swishSchema: { readonly description: ""; readonly properties: { readonly fingerprint: { readonly description: "Uniquely identifies the payer's Swish account. You can use this attribute to check whether two Swish transactions were paid for by the same payer"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_reference: { readonly description: "Payer bank reference number for the payment"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_phone_last4: { readonly description: "The last four digits of the Swish account phone number"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_swish"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_twintSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_twint"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Account holder type: individual or company."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "Account type: checkings or savings. Defaults to checking if omitted."; readonly enum: readonly ["checking", "savings"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the mandate used to make this payment."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly payment_reference: { readonly description: "Reference number to locate ACH payments with customer's bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate"]; }; export declare const payment_method_details_wechatSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_wechat"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_wechat_paySchema: { readonly description: ""; readonly properties: { readonly fingerprint: { readonly description: "Uniquely identifies this particular WeChat Pay account. You can use this attribute to check whether two WeChat accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "Transaction ID of this particular WeChat Pay transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_details_wechat_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_details_zipSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_details_zip"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_domainSchema: { readonly description: "A payment method domain represents a web domain that you have registered with Stripe.\nStripe Elements use registered payment method domains to control where certain payment methods are shown.\n\nRelated guides: [Payment method domains](https://stripe.com/docs/payments/payment-methods/pmd-registration)."; readonly properties: { readonly apple_pay: { readonly $ref: "#/components/schemas/payment_method_domain_resource_payment_method_status"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly domain_name: { readonly description: "The domain name that this payment method domain object represents."; readonly maxLength: 5000; readonly type: "string"; }; readonly enabled: { readonly description: "Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements."; readonly type: "boolean"; }; readonly google_pay: { readonly $ref: "#/components/schemas/payment_method_domain_resource_payment_method_status"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly link: { readonly $ref: "#/components/schemas/payment_method_domain_resource_payment_method_status"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payment_method_domain"]; readonly type: "string"; }; readonly paypal: { readonly $ref: "#/components/schemas/payment_method_domain_resource_payment_method_status"; }; }; readonly required: readonly ["apple_pay", "created", "domain_name", "enabled", "google_pay", "id", "link", "livemode", "object", "paypal"]; readonly title: "PaymentMethodDomainResourcePaymentMethodDomain"; readonly type: "object"; readonly 'x-expandableFields': readonly ["apple_pay", "google_pay", "link", "paypal"]; readonly 'x-resourceId': "payment_method_domain"; }; export declare const payment_method_domain_resource_payment_method_statusSchema: { readonly description: "Indicates the status of a specific payment method on a payment method domain."; readonly properties: { readonly status: { readonly description: "The status of the payment method on the domain."; readonly enum: readonly ["active", "inactive"]; readonly type: "string"; }; readonly status_details: { readonly $ref: "#/components/schemas/payment_method_domain_resource_payment_method_status_details"; }; }; readonly required: readonly ["status"]; readonly title: "PaymentMethodDomainResourcePaymentMethodStatus"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_details"]; }; export declare const payment_method_domain_resource_payment_method_status_detailsSchema: { readonly description: "Contains additional details about the status of a payment method for a specific payment method domain."; readonly properties: { readonly error_message: { readonly description: "The error message associated with the status of the payment method on the domain."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["error_message"]; readonly title: "PaymentMethodDomainResourcePaymentMethodStatusDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_epsSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Should be one of `arzte_und_apotheker_bank`, `austrian_anadi_bank_ag`, `bank_austria`, `bankhaus_carl_spangler`, `bankhaus_schelhammer_und_schattera_ag`, `bawag_psk_ag`, `bks_bank_ag`, `brull_kallmus_bank_ag`, `btv_vier_lander_bank`, `capital_bank_grawe_gruppe_ag`, `deutsche_bank_ag`, `dolomitenbank`, `easybank_ag`, `erste_bank_und_sparkassen`, `hypo_alpeadriabank_international_ag`, `hypo_noe_lb_fur_niederosterreich_u_wien`, `hypo_oberosterreich_salzburg_steiermark`, `hypo_tirol_bank_ag`, `hypo_vorarlberg_bank_ag`, `hypo_bank_burgenland_aktiengesellschaft`, `marchfelder_bank`, `oberbank_ag`, `raiffeisen_bankengruppe_osterreich`, `schoellerbank_ag`, `sparda_bank_wien`, `volksbank_gruppe`, `volkskreditbank_ag`, or `vr_bank_braunau`."; readonly enum: readonly ["arzte_und_apotheker_bank", "austrian_anadi_bank_ag", "bank_austria", "bankhaus_carl_spangler", "bankhaus_schelhammer_und_schattera_ag", "bawag_psk_ag", "bks_bank_ag", "brull_kallmus_bank_ag", "btv_vier_lander_bank", "capital_bank_grawe_gruppe_ag", "deutsche_bank_ag", "dolomitenbank", "easybank_ag", "erste_bank_und_sparkassen", "hypo_alpeadriabank_international_ag", "hypo_bank_burgenland_aktiengesellschaft", "hypo_noe_lb_fur_niederosterreich_u_wien", "hypo_oberosterreich_salzburg_steiermark", "hypo_tirol_bank_ag", "hypo_vorarlberg_bank_ag", "marchfelder_bank", "oberbank_ag", "raiffeisen_bankengruppe_osterreich", "schoellerbank_ag", "sparda_bank_wien", "volksbank_gruppe", "volkskreditbank_ag", "vr_bank_braunau"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_eps"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_fpxSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank, if provided. Can be one of `affin_bank`, `agrobank`, `alliance_bank`, `ambank`, `bank_islam`, `bank_muamalat`, `bank_rakyat`, `bsn`, `cimb`, `hong_leong_bank`, `hsbc`, `kfh`, `maybank2u`, `ocbc`, `public_bank`, `rhb`, `standard_chartered`, `uob`, `deutsche_bank`, `maybank2e`, `pb_enterprise`, or `bank_of_china`."; readonly enum: readonly ["affin_bank", "agrobank", "alliance_bank", "ambank", "bank_islam", "bank_muamalat", "bank_of_china", "bank_rakyat", "bsn", "cimb", "deutsche_bank", "hong_leong_bank", "hsbc", "kfh", "maybank2e", "maybank2u", "ocbc", "pb_enterprise", "public_bank", "rhb", "standard_chartered", "uob"]; readonly type: "string"; }; }; readonly required: readonly ["bank"]; readonly title: "payment_method_fpx"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_giropaySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_giropay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_grabpaySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_grabpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_idealSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."; readonly enum: readonly ["abn_amro", "asn_bank", "bunq", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe"]; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "The Bank Identifier Code of the customer's bank, if the bank was provided."; readonly enum: readonly ["ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_ideal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_interac_presentSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `interac`, `mastercard` or `visa`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cardholder_name: { readonly description: "The cardholder name as read from the card, in [ISO 7813](https://en.wikipedia.org/wiki/ISO/IEC_7813) format. May include alphanumeric characters, special characters and first/last name separator (`/`). In some cases, the cardholder name may not be available depending on how the issuer has configured the card. Cardholder name is typically not available on swipe or contactless payments, such as those made with Apple Pay and Google Pay."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly networks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_card_present_networks"; }]; readonly description: "Contains information about card networks that can be used to process the payment."; readonly nullable: true; }; readonly preferred_locales: { readonly description: "EMV tag 5F2D. Preferred languages specified by the integrated circuit chip."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly read_method: { readonly description: "How card details were read in this transaction."; readonly enum: readonly ["contact_emv", "contactless_emv", "contactless_magstripe_mode", "magnetic_stripe_fallback", "magnetic_stripe_track2"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["exp_month", "exp_year"]; readonly title: "payment_method_interac_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["networks"]; }; export declare const payment_method_klarnaSchema: { readonly description: ""; readonly properties: { readonly dob: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_flows_private_payment_methods_klarna_dob"; }]; readonly description: "The customer's date of birth, if provided."; readonly nullable: true; }; }; readonly title: "payment_method_klarna"; readonly type: "object"; readonly 'x-expandableFields': readonly ["dob"]; }; export declare const payment_method_konbiniSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_konbini"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_linkSchema: { readonly description: ""; readonly properties: { readonly email: { readonly description: "Account owner's email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_mobilepaySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_mobilepay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_multibancoSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_multibanco"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_affirmSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly preferred_locale: { readonly description: "Preferred language of the Affirm authorization page that the customer is redirected to."; readonly maxLength: 30; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_affirm"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_afterpay_clearpaySchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly reference: { readonly description: "An internal identifier or reference that this payment corresponds to. You must limit the identifier to 128 characters, and it can only contain letters, numbers, underscores, backslashes, and dashes.\nThis field differs from the statement descriptor and item name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_method_options_afterpay_clearpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_alipaySchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_alipay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_amazon_paySchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_bacs_debitSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_bacs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_bancontactSchema: { readonly description: ""; readonly properties: { readonly preferred_language: { readonly description: "Preferred language of the Bancontact authorization page that the customer is redirected to."; readonly enum: readonly ["de", "en", "fr", "nl"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly required: readonly ["preferred_language"]; readonly title: "payment_method_options_bancontact"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_boletoSchema: { readonly description: ""; readonly properties: { readonly expires_after_days: { readonly description: "The number of calendar days before a Boleto voucher expires. For example, if you create a Boleto voucher on Monday and you set expires_after_days to 2, the Boleto voucher will expire on Wednesday at 23:59 America/Sao_Paulo time."; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly required: readonly ["expires_after_days"]; readonly title: "payment_method_options_boleto"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_card_installmentsSchema: { readonly description: ""; readonly properties: { readonly available_plans: { readonly description: "Installment plans that may be selected for this PaymentIntent."; readonly items: { readonly $ref: "#/components/schemas/payment_method_details_card_installments_plan"; }; readonly nullable: true; readonly type: "array"; }; readonly enabled: { readonly description: "Whether Installments are enabled for this PaymentIntent."; readonly type: "boolean"; }; readonly plan: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_installments_plan"; }]; readonly description: "Installment plan selected for this PaymentIntent."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "payment_method_options_card_installments"; readonly type: "object"; readonly 'x-expandableFields': readonly ["available_plans", "plan"]; }; export declare const payment_method_options_card_mandate_optionsSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount to be charged for future payments."; readonly type: "integer"; }; readonly amount_type: { readonly description: "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."; readonly enum: readonly ["fixed", "maximum"]; readonly type: "string"; }; readonly description: { readonly description: "A description of the mandate or subscription that is meant to be displayed to the customer."; readonly maxLength: 200; readonly nullable: true; readonly type: "string"; }; readonly end_date: { readonly description: "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly interval: { readonly description: "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."; readonly enum: readonly ["day", "month", "sporadic", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."; readonly nullable: true; readonly type: "integer"; }; readonly reference: { readonly description: "Unique identifier for the mandate or subscription."; readonly maxLength: 80; readonly type: "string"; }; readonly start_date: { readonly description: "Start date of the mandate or subscription. Start date should not be lesser than yesterday."; readonly format: "unix-time"; readonly type: "integer"; }; readonly supported_types: { readonly description: "Specifies the type of mandates supported. Possible values are `india`."; readonly items: { readonly enum: readonly ["india"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly required: readonly ["amount", "amount_type", "interval", "reference", "start_date"]; readonly title: "payment_method_options_card_mandate_options"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_card_presentSchema: { readonly description: ""; readonly properties: { readonly request_extended_authorization: { readonly description: "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)"; readonly nullable: true; readonly type: "boolean"; }; readonly request_incremental_authorization_support: { readonly description: "Request ability to [increment](https://stripe.com/docs/terminal/features/incremental-authorizations) this PaymentIntent if the combination of MCC and card brand is eligible. Check [incremental_authorization_supported](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-card_present-incremental_authorization_supported) in the [Confirm](https://stripe.com/docs/api/payment_intents/confirm) response to verify support."; readonly nullable: true; readonly type: "boolean"; }; readonly routing: { readonly $ref: "#/components/schemas/payment_method_options_card_present_routing"; }; }; readonly title: "payment_method_options_card_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["routing"]; }; export declare const payment_method_options_card_present_routingSchema: { readonly description: ""; readonly properties: { readonly requested_priority: { readonly description: "Requested routing priority"; readonly enum: readonly ["domestic", "international"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_options_card_present_routing"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_cashappSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session", "on_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_cashapp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_customer_balanceSchema: { readonly description: ""; readonly properties: { readonly bank_transfer: { readonly $ref: "#/components/schemas/payment_method_options_customer_balance_bank_transfer"; }; readonly funding_type: { readonly description: "The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`."; readonly enum: readonly ["bank_transfer"]; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_customer_balance"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_transfer"]; }; export declare const payment_method_options_customer_balance_bank_transferSchema: { readonly description: ""; readonly properties: { readonly eu_bank_transfer: { readonly $ref: "#/components/schemas/payment_method_options_customer_balance_eu_bank_account"; }; readonly requested_address_types: { readonly description: "List of address types that should be returned in the financial_addresses response. If not specified, all valid types will be returned.\n\nPermitted values include: `sort_code`, `zengin`, `iban`, or `spei`."; readonly items: { readonly enum: readonly ["aba", "iban", "sepa", "sort_code", "spei", "swift", "zengin"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly type: { readonly description: "The bank transfer type that this PaymentIntent is allowed to use for funding Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`."; readonly enum: readonly ["eu_bank_transfer", "gb_bank_transfer", "jp_bank_transfer", "mx_bank_transfer", "us_bank_transfer"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_method_options_customer_balance_bank_transfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["eu_bank_transfer"]; }; export declare const payment_method_options_customer_balance_eu_bank_accountSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`."; readonly enum: readonly ["BE", "DE", "ES", "FR", "IE", "NL"]; readonly type: "string"; }; }; readonly required: readonly ["country"]; readonly title: "payment_method_options_customer_balance_eu_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_fpxSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_fpx"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_giropaySchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_giropay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_grabpaySchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_grabpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_idealSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_ideal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_interac_presentSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_options_interac_present"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_klarnaSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly preferred_locale: { readonly description: "Preferred locale of the Klarna checkout page that the customer is redirected to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_method_options_klarna"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_konbiniSchema: { readonly description: ""; readonly properties: { readonly confirmation_number: { readonly description: "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly expires_after_days: { readonly description: "The number of calendar days (between 1 and 60) after which Konbini payment instructions will expire. For example, if a PaymentIntent is confirmed with Konbini and `expires_after_days` set to 2 on Monday JST, the instructions will expire on Wednesday 23:59:59 JST."; readonly nullable: true; readonly type: "integer"; }; readonly expires_at: { readonly description: "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly product_description: { readonly description: "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_konbini"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_multibancoSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_multibanco"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_oxxoSchema: { readonly description: ""; readonly properties: { readonly expires_after_days: { readonly description: "The number of calendar days before an OXXO invoice expires. For example, if you create an OXXO invoice on Monday and you set expires_after_days to 2, the OXXO invoice will expire on Wednesday at 23:59 America/Mexico_City time."; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly required: readonly ["expires_after_days"]; readonly title: "payment_method_options_oxxo"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_p24Schema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_p24"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_paynowSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_paynow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_paypalSchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly preferred_locale: { readonly description: "Preferred locale of the PayPal checkout page that the customer is redirected to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly description: "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_pixSchema: { readonly description: ""; readonly properties: { readonly expires_after_seconds: { readonly description: "The number of seconds (between 10 and 1209600) after which Pix payment will expire."; readonly nullable: true; readonly type: "integer"; }; readonly expires_at: { readonly description: "The timestamp at which the Pix expires."; readonly nullable: true; readonly type: "integer"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_pix"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_promptpaySchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_promptpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_revolut_paySchema: { readonly description: ""; readonly properties: { readonly capture_method: { readonly description: "Controls when the funds will be captured from the customer's account."; readonly enum: readonly ["manual"]; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_revolut_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_sofortSchema: { readonly description: ""; readonly properties: { readonly preferred_language: { readonly description: "Preferred language of the SOFORT authorization page that the customer is redirected to."; readonly enum: readonly ["de", "en", "es", "fr", "it", "nl", "pl"]; readonly nullable: true; readonly type: "string"; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none", "off_session"]; readonly type: "string"; }; }; readonly title: "payment_method_options_sofort"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_twintSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_twint"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_us_bank_account_mandate_optionsSchema: { readonly description: ""; readonly properties: { readonly collection_method: { readonly description: "Mandate collection method"; readonly enum: readonly ["paper"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_method_options_us_bank_account_mandate_options"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_wechat_paySchema: { readonly description: ""; readonly properties: { readonly app_id: { readonly description: "The app ID registered with WeChat Pay. Only required when client is ios or android."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly client: { readonly description: "The client type that the end customer will pay from"; readonly enum: readonly ["android", "ios", "web"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_wechat_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_options_zipSchema: { readonly description: ""; readonly properties: { readonly setup_future_usage: { readonly description: "Indicates that you intend to make future payments with this PaymentIntent's payment method.\n\nProviding this parameter will [attach the payment method](https://stripe.com/docs/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://stripe.com/docs/api/payment_methods/attach) to a Customer after the transaction completes.\n\nWhen processing card payments, Stripe also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://stripe.com/docs/strong-customer-authentication)."; readonly enum: readonly ["none"]; readonly type: "string"; }; }; readonly title: "payment_method_options_zip"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_oxxoSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_oxxo"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_p24Schema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank, if provided."; readonly enum: readonly ["alior_bank", "bank_millennium", "bank_nowy_bfg_sa", "bank_pekao_sa", "banki_spbdzielcze", "blik", "bnp_paribas", "boz", "citi_handlowy", "credit_agricole", "envelobank", "etransfer_pocztowy24", "getin_bank", "ideabank", "ing", "inteligo", "mbank_mtransfer", "nest_przelew", "noble_pay", "pbac_z_ipko", "plus_bank", "santander_przelew24", "tmobile_usbugi_bankowe", "toyota_bank", "velobank", "volkswagen_bank"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "payment_method_p24"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_paynowSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_paynow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_paypalSchema: { readonly description: ""; readonly properties: { readonly payer_email: { readonly description: "Owner's email. Values are provided by PayPal directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payer_id: { readonly description: "PayPal account PayerID. This identifier uniquely identifies the PayPal customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_pixSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_pix"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_promptpaySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_promptpay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_revolut_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_revolut_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_sepa_debitSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly branch_code: { readonly description: "Branch code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_from: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/sepa_debit_generated_from"; }]; readonly description: "Information about the object that generated this PaymentMethod."; readonly nullable: true; }; readonly last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_from"]; }; export declare const payment_method_sofortSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "Two-letter ISO code representing the country the bank account is located in."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_sofort"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_swishSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_swish"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_twintSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_twint"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly account_holder_type: { readonly description: "Account holder type: individual or company."; readonly enum: readonly ["company", "individual"]; readonly nullable: true; readonly type: "string"; }; readonly account_type: { readonly description: "Account type: checkings or savings. Defaults to checking if omitted."; readonly enum: readonly ["checking", "savings"]; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "The name of the bank."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly financial_connections_account: { readonly description: "The ID of the Financial Connections Account used to create the payment method."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "Last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly networks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/us_bank_account_networks"; }]; readonly description: "Contains information about US bank account networks that can be used."; readonly nullable: true; }; readonly routing_number: { readonly description: "Routing number of the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_us_bank_account_status_details"; }]; readonly description: "Contains information about the future reusability of this PaymentMethod."; readonly nullable: true; }; }; readonly title: "payment_method_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["networks", "status_details"]; }; export declare const payment_method_us_bank_account_blockedSchema: { readonly description: ""; readonly properties: { readonly network_code: { readonly description: "The ACH network code that resulted in this block."; readonly enum: readonly ["R02", "R03", "R04", "R05", "R07", "R08", "R10", "R11", "R16", "R20", "R29", "R31"]; readonly nullable: true; readonly type: "string"; }; readonly reason: { readonly description: "The reason why this PaymentMethod's fingerprint has been blocked"; readonly enum: readonly ["bank_account_closed", "bank_account_frozen", "bank_account_invalid_details", "bank_account_restricted", "bank_account_unusable", "debit_not_authorized"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "payment_method_us_bank_account_blocked"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_us_bank_account_status_detailsSchema: { readonly description: ""; readonly properties: { readonly blocked: { readonly $ref: "#/components/schemas/payment_method_us_bank_account_blocked"; }; }; readonly title: "payment_method_us_bank_account_status_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["blocked"]; }; export declare const payment_method_wechat_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_wechat_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_method_zipSchema: { readonly description: ""; readonly properties: {}; readonly title: "payment_method_zip"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_after_expirationSchema: { readonly description: ""; readonly properties: { readonly recovery: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_after_expiration_recovery"; }]; readonly description: "When set, configuration used to recover the Checkout Session on expiry."; readonly nullable: true; }; }; readonly title: "PaymentPagesCheckoutSessionAfterExpiration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["recovery"]; }; export declare const payment_pages_checkout_session_after_expiration_recoverySchema: { readonly description: ""; readonly properties: { readonly allow_promotion_codes: { readonly description: "Enables user redeemable promotion codes on the recovered Checkout Sessions. Defaults to `false`"; readonly type: "boolean"; }; readonly enabled: { readonly description: "If `true`, a recovery url will be generated to recover this Checkout Session if it\nexpires before a transaction is completed. It will be attached to the\nCheckout Session object upon expiration."; readonly type: "boolean"; }; readonly expires_at: { readonly description: "The timestamp at which the recovery URL will expire."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly url: { readonly description: "URL that creates a new Checkout Session when clicked that is a copy of this expired Checkout Session"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["allow_promotion_codes", "enabled"]; readonly title: "PaymentPagesCheckoutSessionAfterExpirationRecovery"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates whether automatic tax is enabled for the session"; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; readonly status: { readonly description: "The status of the most recent automated tax calculation for this session."; readonly enum: readonly ["complete", "failed", "requires_location_inputs"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentPagesCheckoutSessionAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const payment_pages_checkout_session_consentSchema: { readonly description: ""; readonly properties: { readonly promotions: { readonly description: "If `opt_in`, the customer consents to receiving promotional communications\nfrom the merchant about this Checkout Session."; readonly enum: readonly ["opt_in", "opt_out"]; readonly nullable: true; readonly type: "string"; }; readonly terms_of_service: { readonly description: "If `accepted`, the customer in this Checkout Session has agreed to the merchant's terms of service."; readonly enum: readonly ["accepted"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "PaymentPagesCheckoutSessionConsent"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_consent_collectionSchema: { readonly description: ""; readonly properties: { readonly payment_method_reuse_agreement: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement"; }]; readonly description: "If set to `hidden`, it will hide legal text related to the reuse of a payment method."; readonly nullable: true; }; readonly promotions: { readonly description: "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants."; readonly enum: readonly ["auto", "none"]; readonly nullable: true; readonly type: "string"; }; readonly terms_of_service: { readonly description: "If set to `required`, it requires customers to accept the terms of service before being able to pay."; readonly enum: readonly ["none", "required"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentPagesCheckoutSessionConsentCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_method_reuse_agreement"]; }; export declare const payment_pages_checkout_session_currency_conversionSchema: { readonly description: ""; readonly properties: { readonly amount_subtotal: { readonly description: "Total of all items in source currency before discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total of all items in source currency after discounts and taxes are applied."; readonly type: "integer"; }; readonly fx_rate: { readonly description: "Exchange rate used to convert source currency amounts to customer currency amounts"; readonly format: "decimal"; readonly type: "string"; }; readonly source_currency: { readonly description: "Creation currency of the CheckoutSession before localization"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount_subtotal", "amount_total", "fx_rate", "source_currency"]; readonly title: "PaymentPagesCheckoutSessionCurrencyConversion"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_custom_fieldsSchema: { readonly description: ""; readonly properties: { readonly dropdown: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"; }; readonly key: { readonly description: "String of your choice that your integration can use to reconcile this field. Must be unique to this field, alphanumeric, and up to 200 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly label: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields_label"; }; readonly numeric: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"; }; readonly optional: { readonly description: "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`."; readonly type: "boolean"; }; readonly text: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields_text"; }; readonly type: { readonly description: "The type of the field."; readonly enum: readonly ["dropdown", "numeric", "text"]; readonly type: "string"; }; }; readonly required: readonly ["key", "label", "optional", "type"]; readonly title: "PaymentPagesCheckoutSessionCustomFields"; readonly type: "object"; readonly 'x-expandableFields': readonly ["dropdown", "label", "numeric", "text"]; }; export declare const payment_pages_checkout_session_custom_fields_dropdownSchema: { readonly description: ""; readonly properties: { readonly default_value: { readonly description: "The value that will pre-fill on the payment page."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly options: { readonly description: "The options available for the customer to select. Up to 200 options allowed."; readonly items: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_fields_option"; }; readonly type: "array"; }; readonly value: { readonly description: "The option selected by the customer. This will be the `value` for the option."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["options"]; readonly title: "PaymentPagesCheckoutSessionCustomFieldsDropdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["options"]; }; export declare const payment_pages_checkout_session_custom_fields_labelSchema: { readonly description: ""; readonly properties: { readonly custom: { readonly description: "Custom text for the label, displayed to the customer. Up to 50 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly type: { readonly description: "The type of the label."; readonly enum: readonly ["custom"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentPagesCheckoutSessionCustomFieldsLabel"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_custom_fields_numericSchema: { readonly description: ""; readonly properties: { readonly default_value: { readonly description: "The value that will pre-fill the field on the payment page."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly maximum_length: { readonly description: "The maximum character length constraint for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly minimum_length: { readonly description: "The minimum character length requirement for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly value: { readonly description: "The value entered by the customer, containing only digits."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentPagesCheckoutSessionCustomFieldsNumeric"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_custom_fields_optionSchema: { readonly description: ""; readonly properties: { readonly label: { readonly description: "The label for the option, displayed to the customer. Up to 100 characters."; readonly maxLength: 5000; readonly type: "string"; }; readonly value: { readonly description: "The value for this option, not displayed to the customer, used by your integration to reconcile the option selected by the customer. Must be unique to this option, alphanumeric, and up to 100 characters."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["label", "value"]; readonly title: "PaymentPagesCheckoutSessionCustomFieldsOption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_custom_fields_textSchema: { readonly description: ""; readonly properties: { readonly default_value: { readonly description: "The value that will pre-fill the field on the payment page."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly maximum_length: { readonly description: "The maximum character length constraint for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly minimum_length: { readonly description: "The minimum character length requirement for the customer's input."; readonly nullable: true; readonly type: "integer"; }; readonly value: { readonly description: "The value entered by the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentPagesCheckoutSessionCustomFieldsText"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_custom_textSchema: { readonly description: ""; readonly properties: { readonly after_submit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_text_position"; }]; readonly description: "Custom text that should be displayed after the payment confirmation button."; readonly nullable: true; }; readonly shipping_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_text_position"; }]; readonly description: "Custom text that should be displayed alongside shipping address collection."; readonly nullable: true; }; readonly submit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_text_position"; }]; readonly description: "Custom text that should be displayed alongside the payment confirmation button."; readonly nullable: true; }; readonly terms_of_service_acceptance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_pages_checkout_session_custom_text_position"; }]; readonly description: "Custom text that should be displayed in place of the default terms of service agreement text."; readonly nullable: true; }; }; readonly title: "PaymentPagesCheckoutSessionCustomText"; readonly type: "object"; readonly 'x-expandableFields': readonly ["after_submit", "shipping_address", "submit", "terms_of_service_acceptance"]; }; export declare const payment_pages_checkout_session_custom_text_positionSchema: { readonly description: ""; readonly properties: { readonly message: { readonly description: "Text may be up to 1200 characters in length."; readonly maxLength: 500; readonly type: "string"; }; }; readonly required: readonly ["message"]; readonly title: "PaymentPagesCheckoutSessionCustomTextPosition"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_customer_detailsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "The customer's address after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."; readonly nullable: true; }; readonly email: { readonly description: "The email associated with the Customer, if one exists, on the Checkout Session after a completed Checkout Session or at time of session expiry.\nOtherwise, if the customer has consented to promotional content, this value is the most recent valid email provided by the customer on the Checkout form."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "The customer's name after a completed Checkout Session. Note: This property is populated only for sessions on or after March 30, 2022."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly phone: { readonly description: "The customer's phone number after a completed Checkout Session."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_exempt: { readonly description: "The customer’s tax exempt status after a completed Checkout Session."; readonly enum: readonly ["exempt", "none", "reverse"]; readonly nullable: true; readonly type: "string"; }; readonly tax_ids: { readonly description: "The customer’s tax IDs after a completed Checkout Session."; readonly items: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_tax_id"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "PaymentPagesCheckoutSessionCustomerDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "tax_ids"]; }; export declare const payment_pages_checkout_session_invoice_creationSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates whether invoice creation is enabled for the Checkout Session."; readonly type: "boolean"; }; readonly invoice_data: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_invoice_settings"; }; }; readonly required: readonly ["enabled", "invoice_data"]; readonly title: "PaymentPagesCheckoutSessionInvoiceCreation"; readonly type: "object"; readonly 'x-expandableFields': readonly ["invoice_data"]; }; export declare const payment_pages_checkout_session_invoice_settingsSchema: { readonly description: ""; readonly properties: { readonly account_tax_ids: { readonly description: "The account tax IDs associated with the invoice."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly custom_fields: { readonly description: "Custom fields displayed on the invoice."; readonly items: { readonly $ref: "#/components/schemas/invoice_setting_custom_field"; }; readonly nullable: true; readonly type: "array"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly footer: { readonly description: "Footer displayed on the invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuer: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The connected account that issues the invoice. The invoice is presented with the branding and support information of the specified account."; readonly nullable: true; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly rendering_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_setting_rendering_options"; }]; readonly description: "Options for invoice PDF rendering."; readonly nullable: true; }; }; readonly title: "PaymentPagesCheckoutSessionInvoiceSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "custom_fields", "issuer", "rendering_options"]; }; export declare const payment_pages_checkout_session_payment_method_reuse_agreementSchema: { readonly description: ""; readonly properties: { readonly position: { readonly description: "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI."; readonly enum: readonly ["auto", "hidden"]; readonly type: "string"; }; }; readonly required: readonly ["position"]; readonly title: "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_phone_number_collectionSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates whether phone number collection is enabled for the session"; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentPagesCheckoutSessionPhoneNumberCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_saved_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly allow_redisplay_filters: { readonly description: "Uses the `allow_redisplay` value of each saved payment method to filter the set presented to a returning customer. By default, only saved payment methods with ’allow_redisplay: ‘always’ are shown in Checkout."; readonly items: { readonly enum: readonly ["always", "limited", "unspecified"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly payment_method_remove: { readonly description: "Enable customers to choose if they wish to remove their saved payment methods. Disabled by default."; readonly enum: readonly ["disabled", "enabled"]; readonly nullable: true; readonly type: "string"; }; readonly payment_method_save: { readonly description: "Enable customers to choose if they wish to save their payment method for future use. Disabled by default."; readonly enum: readonly ["disabled", "enabled"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PaymentPagesCheckoutSessionSavedPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_shipping_address_collectionSchema: { readonly description: ""; readonly properties: { readonly allowed_countries: { readonly description: "An array of two-letter ISO country codes representing which countries Checkout should provide as options for\nshipping locations. Unsupported country codes: `AS, CX, CC, CU, HM, IR, KP, MH, FM, NF, MP, PW, SD, SY, UM, VI`."; readonly items: { readonly enum: readonly ["AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MK", "ML", "MM", "MN", "MO", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SZ", "TA", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW", "ZZ"]; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["allowed_countries"]; readonly title: "PaymentPagesCheckoutSessionShippingAddressCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_shipping_costSchema: { readonly description: ""; readonly properties: { readonly amount_subtotal: { readonly description: "Total shipping cost before any discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "Total tax amount applied due to shipping costs. If no tax was applied, defaults to 0."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total shipping cost after discounts and taxes are applied."; readonly type: "integer"; }; readonly shipping_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/shipping_rate"; }]; readonly description: "The ID of the ShippingRate for this order."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate"; }]; }; }; readonly taxes: { readonly description: "The taxes applied to the shipping rate."; readonly items: { readonly $ref: "#/components/schemas/line_items_tax_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["amount_subtotal", "amount_tax", "amount_total"]; readonly title: "PaymentPagesCheckoutSessionShippingCost"; readonly type: "object"; readonly 'x-expandableFields': readonly ["shipping_rate", "taxes"]; }; export declare const payment_pages_checkout_session_shipping_optionSchema: { readonly description: ""; readonly properties: { readonly shipping_amount: { readonly description: "A non-negative integer in cents representing how much to charge."; readonly type: "integer"; }; readonly shipping_rate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/shipping_rate"; }]; readonly description: "The shipping rate."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate"; }]; }; }; }; readonly required: readonly ["shipping_amount", "shipping_rate"]; readonly title: "PaymentPagesCheckoutSessionShippingOption"; readonly type: "object"; readonly 'x-expandableFields': readonly ["shipping_rate"]; }; export declare const payment_pages_checkout_session_tax_idSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`"; readonly enum: readonly ["ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat"]; readonly type: "string"; }; readonly value: { readonly description: "The value of the tax ID."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PaymentPagesCheckoutSessionTaxID"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_tax_id_collectionSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Indicates whether tax ID collection is enabled for the session"; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PaymentPagesCheckoutSessionTaxIDCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const payment_pages_checkout_session_total_detailsSchema: { readonly description: ""; readonly properties: { readonly amount_discount: { readonly description: "This is the sum of all the discounts."; readonly type: "integer"; }; readonly amount_shipping: { readonly description: "This is the sum of all the shipping amounts."; readonly nullable: true; readonly type: "integer"; }; readonly amount_tax: { readonly description: "This is the sum of all the tax amounts."; readonly type: "integer"; }; readonly breakdown: { readonly $ref: "#/components/schemas/payment_pages_checkout_session_total_details_resource_breakdown"; }; }; readonly required: readonly ["amount_discount", "amount_tax"]; readonly title: "PaymentPagesCheckoutSessionTotalDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["breakdown"]; }; export declare const payment_pages_checkout_session_total_details_resource_breakdownSchema: { readonly description: ""; readonly properties: { readonly discounts: { readonly description: "The aggregated discounts."; readonly items: { readonly $ref: "#/components/schemas/line_items_discount_amount"; }; readonly type: "array"; }; readonly taxes: { readonly description: "The aggregated tax amounts by rate."; readonly items: { readonly $ref: "#/components/schemas/line_items_tax_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["discounts", "taxes"]; readonly title: "PaymentPagesCheckoutSessionTotalDetailsResourceBreakdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discounts", "taxes"]; }; export declare const payment_sourceSchema: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/account"; }, { readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly title: "Polymorphic"; readonly 'x-resourceId': "payment_source"; readonly 'x-stripeBypassValidation': true; }; export declare const payoutSchema: { readonly description: "A `Payout` object is created when you receive funds from Stripe, or when you\ninitiate a payout to either a bank account or debit card of a [connected\nStripe account](/docs/connect/bank-debit-card-payouts). You can retrieve individual payouts,\nand list all payouts. Payouts are made on [varying\nschedules](/docs/connect/manage-payout-schedule), depending on your country and\nindustry.\n\nRelated guide: [Receiving payouts](https://stripe.com/docs/payouts)"; readonly properties: { readonly amount: { readonly description: "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card."; readonly type: "integer"; }; readonly application_fee: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application_fee"; }]; readonly description: "The application fee (if any) for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application_fee"; }]; }; }; readonly application_fee_amount: { readonly description: "The amount of the application fee (if any) requested for the payout. [See the Connect documentation](https://stripe.com/docs/connect/instant-payouts#monetization-and-fees) for details."; readonly nullable: true; readonly type: "integer"; }; readonly arrival_date: { readonly description: "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays."; readonly format: "unix-time"; readonly type: "integer"; }; readonly automatic: { readonly description: "Returns `true` if the payout is created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule) and `false` if it's [requested manually](https://stripe.com/docs/payouts#manual-payouts)."; readonly type: "boolean"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "ID of the balance transaction that describes the impact of this payout on your account balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/deleted_bank_account"; }, { readonly $ref: "#/components/schemas/deleted_card"; }]; readonly description: "ID of the bank account or card the payout is sent to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/deleted_bank_account"; }, { readonly $ref: "#/components/schemas/deleted_card"; }]; }; readonly 'x-stripeBypassValidation': true; }; readonly failure_balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly failure_code: { readonly description: "Error code that provides a reason for a payout failure, if available. View our [list of failure codes](https://stripe.com/docs/api#payout_failures)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly failure_message: { readonly description: "Message that provides the reason for a payout failure, if available."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly method: { readonly description: "The method used to send this payout, which can be `standard` or `instant`. `instant` is supported for payouts to debit cards and bank accounts in certain countries. Learn more about [bank support for Instant Payouts](https://stripe.com/docs/payouts/instant-payouts-banks)."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["payout"]; readonly type: "string"; }; readonly original_payout: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payout"; }]; readonly description: "If the payout reverses another, this is the ID of the original payout."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payout"; }]; }; }; readonly reconciliation_status: { readonly description: "If `completed`, you can use the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) to list all balance transactions that are paid out in this payout."; readonly enum: readonly ["completed", "in_progress", "not_applicable"]; readonly type: "string"; }; readonly reversed_by: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payout"; }]; readonly description: "If the payout reverses, this is the ID of the payout that reverses this payout."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payout"; }]; }; }; readonly source_type: { readonly description: "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`."; readonly maxLength: 5000; readonly type: "string"; }; readonly statement_descriptor: { readonly description: "Extra information about a payout that displays on the user's bank statement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it's submitted to the bank, when it becomes `in_transit`. The status changes to `paid` if the transaction succeeds, or to `failed` or `canceled` (within 5 business days). Some payouts that fail might initially show as `paid`, then change to `failed`."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "Can be `bank_account` or `card`."; readonly enum: readonly ["bank_account", "card"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["amount", "arrival_date", "automatic", "created", "currency", "id", "livemode", "method", "object", "reconciliation_status", "source_type", "status", "type"]; readonly title: "Payout"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application_fee", "balance_transaction", "destination", "failure_balance_transaction", "original_payout", "reversed_by"]; readonly 'x-resourceId': "payout"; }; export declare const paypal_seller_protectionSchema: { readonly description: ""; readonly properties: { readonly dispute_categories: { readonly description: "An array of conditions that are covered for the transaction, if applicable."; readonly items: { readonly enum: readonly ["fraudulent", "product_not_received"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly status: { readonly description: "Indicates whether the transaction is eligible for PayPal's seller protection."; readonly enum: readonly ["eligible", "not_eligible", "partially_eligible"]; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "paypal_seller_protection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const periodSchema: { readonly description: ""; readonly properties: { readonly end: { readonly description: "The end date of this usage period. All usage up to and including this point in time is included."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly start: { readonly description: "The start date of this usage period. All usage after this point in time is included."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "Period"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const personSchema: { readonly description: "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a person for an account where [account.controller.requirement_collection](/api/accounts/object#account_object-controller-requirement_collection) is `stripe`, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.\n\nSee the [Standard onboarding](/connect/standard-accounts) or [Express onboarding](/connect/express-accounts) documentation for information about prefilling information and account onboarding steps. Learn more about [handling identity verification with the API](/connect/handling-api-verification#person-information)."; readonly properties: { readonly account: { readonly description: "The account the person is associated with."; readonly maxLength: 5000; readonly type: "string"; }; readonly additional_tos_acceptances: { readonly $ref: "#/components/schemas/person_additional_tos_acceptances"; }; readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly address_kana: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_japan_address"; }]; readonly nullable: true; }; readonly address_kanji: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/legal_entity_japan_address"; }]; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly dob: { readonly $ref: "#/components/schemas/legal_entity_dob"; }; readonly email: { readonly description: "The person's email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly first_name: { readonly description: "The person's first name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly first_name_kana: { readonly description: "The Kana variation of the person's first name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly first_name_kanji: { readonly description: "The Kanji variation of the person's first name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly full_name_aliases: { readonly description: "A list of alternate names or aliases that the person is known by."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly future_requirements: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/person_future_requirements"; }]; readonly nullable: true; }; readonly gender: { readonly description: "The person's gender (International regulations require either \"male\" or \"female\")."; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly id_number_provided: { readonly description: "Whether the person's `id_number` was provided. True if either the full ID number was provided or if only the required part of the ID number was provided (ex. last four of an individual's SSN for the US indicated by `ssn_last_4_provided`)."; readonly type: "boolean"; }; readonly id_number_secondary_provided: { readonly description: "Whether the person's `id_number_secondary` was provided."; readonly type: "boolean"; }; readonly last_name: { readonly description: "The person's last name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last_name_kana: { readonly description: "The Kana variation of the person's last name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last_name_kanji: { readonly description: "The Kanji variation of the person's last name (Japan only)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly maiden_name: { readonly description: "The person's maiden name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly nationality: { readonly description: "The country where the person is a national."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["person"]; readonly type: "string"; }; readonly phone: { readonly description: "The person's phone number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly political_exposure: { readonly description: "Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction."; readonly enum: readonly ["existing", "none"]; readonly type: "string"; }; readonly registered_address: { readonly $ref: "#/components/schemas/address"; }; readonly relationship: { readonly $ref: "#/components/schemas/person_relationship"; }; readonly requirements: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/person_requirements"; }]; readonly nullable: true; }; readonly ssn_last_4_provided: { readonly description: "Whether the last four digits of the person's Social Security number have been provided (U.S. only)."; readonly type: "boolean"; }; readonly verification: { readonly $ref: "#/components/schemas/legal_entity_person_verification"; }; }; readonly required: readonly ["account", "created", "id", "object"]; readonly title: "Person"; readonly type: "object"; readonly 'x-expandableFields': readonly ["additional_tos_acceptances", "address", "address_kana", "address_kanji", "dob", "future_requirements", "registered_address", "relationship", "requirements", "verification"]; readonly 'x-resourceId': "person"; }; export declare const person_additional_tos_acceptanceSchema: { readonly description: ""; readonly properties: { readonly date: { readonly description: "The Unix timestamp marking when the legal guardian accepted the service agreement."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly ip: { readonly description: "The IP address from which the legal guardian accepted the service agreement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly user_agent: { readonly description: "The user agent of the browser from which the legal guardian accepted the service agreement."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PersonAdditionalTOSAcceptance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const person_additional_tos_acceptancesSchema: { readonly description: ""; readonly properties: { readonly account: { readonly $ref: "#/components/schemas/person_additional_tos_acceptance"; }; }; readonly required: readonly ["account"]; readonly title: "PersonAdditionalTOSAcceptances"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account"]; }; export declare const person_future_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `future_requirements[current_deadline]`, these fields will transition to the main `requirements` hash, and may immediately become `past_due`, but the account may also be given a grace period depending on the account's enablement state prior to transition."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `future_requirements[current_deadline]` becomes set."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by the account's `requirements.current_deadline`. These fields need to be collected to enable the person's account. New fields will never appear here; `future_requirements.past_due` will always be a subset of `requirements.past_due`."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due` or `currently_due`. Fields might appear in `eventually_due` or `currently_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["currently_due", "errors", "eventually_due", "past_due", "pending_verification"]; readonly title: "PersonFutureRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const person_relationshipSchema: { readonly description: ""; readonly properties: { readonly director: { readonly description: "Whether the person is a director of the account's legal entity. Directors are typically members of the governing board of the company, or responsible for ensuring the company meets its regulatory obligations."; readonly nullable: true; readonly type: "boolean"; }; readonly executive: { readonly description: "Whether the person has significant responsibility to control, manage, or direct the organization."; readonly nullable: true; readonly type: "boolean"; }; readonly legal_guardian: { readonly description: "Whether the person is the legal guardian of the account's representative."; readonly nullable: true; readonly type: "boolean"; }; readonly owner: { readonly description: "Whether the person is an owner of the account’s legal entity."; readonly nullable: true; readonly type: "boolean"; }; readonly percent_ownership: { readonly description: "The percent owned by the person of the account's legal entity."; readonly nullable: true; readonly type: "number"; }; readonly representative: { readonly description: "Whether the person is authorized as the primary representative of the account. This is the person nominated by the business to provide information about themselves, and general information about the account. There can only be one representative at any given time. At the time the account is created, this person should be set to the person responsible for opening the account."; readonly nullable: true; readonly type: "boolean"; }; readonly title: { readonly description: "The person's title (e.g., CEO, Support Engineer)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PersonRelationship"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const person_requirementsSchema: { readonly description: ""; readonly properties: { readonly alternatives: { readonly description: "Fields that are due and can be satisfied by providing the corresponding alternative fields instead."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_alternative"; }; readonly nullable: true; readonly type: "array"; }; readonly currently_due: { readonly description: "Fields that need to be collected to keep the person's account enabled. If not collected by the account's `current_deadline`, these fields appear in `past_due` as well, and the account is disabled."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly errors: { readonly description: "Fields that are `currently_due` and need to be collected again because validation or verification failed."; readonly items: { readonly $ref: "#/components/schemas/account_requirements_error"; }; readonly type: "array"; }; readonly eventually_due: { readonly description: "Fields that need to be collected assuming all volume thresholds are reached. As they become required, they appear in `currently_due` as well, and the account's `current_deadline` becomes set."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly past_due: { readonly description: "Fields that weren't collected by the account's `current_deadline`. These fields need to be collected to enable the person's account."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly pending_verification: { readonly description: "Fields that might become required depending on the results of verification or review. It's an empty array unless an asynchronous verification is pending. If verification fails, these fields move to `eventually_due`, `currently_due`, or `past_due`. Fields might appear in `eventually_due`, `currently_due`, or `past_due` and in `pending_verification` if verification fails but another verification is still pending."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["currently_due", "errors", "eventually_due", "past_due", "pending_verification"]; readonly title: "PersonRequirements"; readonly type: "object"; readonly 'x-expandableFields': readonly ["alternatives", "errors"]; }; export declare const planSchema: { readonly description: "You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview)."; readonly properties: { readonly active: { readonly description: "Whether the plan can be used for new purchases."; readonly type: "boolean"; }; readonly aggregate_usage: { readonly description: "Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`."; readonly enum: readonly ["last_during_period", "last_ever", "max", "sum"]; readonly nullable: true; readonly type: "string"; }; readonly amount: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."; readonly nullable: true; readonly type: "integer"; }; readonly amount_decimal: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly billing_scheme: { readonly description: "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes."; readonly enum: readonly ["per_unit", "tiered"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly interval: { readonly description: "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."; readonly enum: readonly ["day", "month", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."; readonly type: "integer"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly meter: { readonly description: "The meter tracking the usage of a metered price"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly nickname: { readonly description: "A brief description of the plan, hidden from customers."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["plan"]; readonly type: "string"; }; readonly product: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/product"; }, { readonly $ref: "#/components/schemas/deleted_product"; }]; readonly description: "The product whose pricing this plan determines."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/product"; }, { readonly $ref: "#/components/schemas/deleted_product"; }]; }; }; readonly tiers: { readonly description: "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."; readonly items: { readonly $ref: "#/components/schemas/plan_tier"; }; readonly type: "array"; }; readonly tiers_mode: { readonly description: "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows."; readonly enum: readonly ["graduated", "volume"]; readonly nullable: true; readonly type: "string"; }; readonly transform_usage: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/transform_usage"; }]; readonly description: "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`."; readonly nullable: true; }; readonly trial_period_days: { readonly description: "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](https://stripe.com/docs/api#create_subscription-trial_from_plan)."; readonly nullable: true; readonly type: "integer"; }; readonly usage_type: { readonly description: "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`."; readonly enum: readonly ["licensed", "metered"]; readonly type: "string"; }; }; readonly required: readonly ["active", "billing_scheme", "created", "currency", "id", "interval", "interval_count", "livemode", "object", "usage_type"]; readonly title: "Plan"; readonly type: "object"; readonly 'x-expandableFields': readonly ["product", "tiers", "transform_usage"]; readonly 'x-resourceId': "plan"; }; export declare const plan_tierSchema: { readonly description: ""; readonly properties: { readonly flat_amount: { readonly description: "Price for the entire tier."; readonly nullable: true; readonly type: "integer"; }; readonly flat_amount_decimal: { readonly description: "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly unit_amount: { readonly description: "Per unit price for units relevant to the tier."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly up_to: { readonly description: "Up to and including to this quantity will be contained in the tier."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PlanTier"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const platform_earning_fee_sourceSchema: { readonly description: ""; readonly properties: { readonly charge: { readonly description: "Charge ID that created this application fee."; readonly maxLength: 5000; readonly type: "string"; }; readonly payout: { readonly description: "Payout ID that created this application fee."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "Type of object that created the application fee, either `charge` or `payout`."; readonly enum: readonly ["charge", "payout"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PlatformEarningFeeSource"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_business_profileSchema: { readonly description: ""; readonly properties: { readonly headline: { readonly description: "The messaging shown to customers in the portal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly privacy_policy_url: { readonly description: "A link to the business’s publicly available privacy policy."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly terms_of_service_url: { readonly description: "A link to the business’s publicly available terms of service."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PortalBusinessProfile"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_customer_updateSchema: { readonly description: ""; readonly properties: { readonly allowed_updates: { readonly description: "The types of customer updates that are supported. When empty, customers are not updateable."; readonly items: { readonly enum: readonly ["address", "email", "name", "phone", "shipping", "tax_id"]; readonly type: "string"; }; readonly type: "array"; }; readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; }; readonly required: readonly ["allowed_updates", "enabled"]; readonly title: "PortalCustomerUpdate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_featuresSchema: { readonly description: ""; readonly properties: { readonly customer_update: { readonly $ref: "#/components/schemas/portal_customer_update"; }; readonly invoice_history: { readonly $ref: "#/components/schemas/portal_invoice_list"; }; readonly payment_method_update: { readonly $ref: "#/components/schemas/portal_payment_method_update"; }; readonly subscription_cancel: { readonly $ref: "#/components/schemas/portal_subscription_cancel"; }; readonly subscription_update: { readonly $ref: "#/components/schemas/portal_subscription_update"; }; }; readonly required: readonly ["customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update"]; readonly title: "PortalFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_update", "invoice_history", "payment_method_update", "subscription_cancel", "subscription_update"]; }; export declare const portal_flows_after_completion_hosted_confirmationSchema: { readonly description: ""; readonly properties: { readonly custom_message: { readonly description: "A custom message to display to the customer after the flow is completed."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PortalFlowsAfterCompletionHostedConfirmation"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_flows_after_completion_redirectSchema: { readonly description: ""; readonly properties: { readonly return_url: { readonly description: "The URL the customer will be redirected to after the flow is completed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["return_url"]; readonly title: "PortalFlowsAfterCompletionRedirect"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_flows_coupon_offerSchema: { readonly description: ""; readonly properties: { readonly coupon: { readonly description: "The ID of the coupon to be offered."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["coupon"]; readonly title: "PortalFlowsCouponOffer"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_flows_flowSchema: { readonly description: ""; readonly properties: { readonly after_completion: { readonly $ref: "#/components/schemas/portal_flows_flow_after_completion"; }; readonly subscription_cancel: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_flow_subscription_cancel"; }]; readonly description: "Configuration when `flow.type=subscription_cancel`."; readonly nullable: true; }; readonly subscription_update: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_flow_subscription_update"; }]; readonly description: "Configuration when `flow.type=subscription_update`."; readonly nullable: true; }; readonly subscription_update_confirm: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_flow_subscription_update_confirm"; }]; readonly description: "Configuration when `flow.type=subscription_update_confirm`."; readonly nullable: true; }; readonly type: { readonly description: "Type of flow that the customer will go through."; readonly enum: readonly ["payment_method_update", "subscription_cancel", "subscription_update", "subscription_update_confirm"]; readonly type: "string"; }; }; readonly required: readonly ["after_completion", "type"]; readonly title: "PortalFlowsFlow"; readonly type: "object"; readonly 'x-expandableFields': readonly ["after_completion", "subscription_cancel", "subscription_update", "subscription_update_confirm"]; }; export declare const portal_flows_flow_after_completionSchema: { readonly description: ""; readonly properties: { readonly hosted_confirmation: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_after_completion_hosted_confirmation"; }]; readonly description: "Configuration when `after_completion.type=hosted_confirmation`."; readonly nullable: true; }; readonly redirect: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_after_completion_redirect"; }]; readonly description: "Configuration when `after_completion.type=redirect`."; readonly nullable: true; }; readonly type: { readonly description: "The specified type of behavior after the flow is completed."; readonly enum: readonly ["hosted_confirmation", "portal_homepage", "redirect"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PortalFlowsFlowAfterCompletion"; readonly type: "object"; readonly 'x-expandableFields': readonly ["hosted_confirmation", "redirect"]; }; export declare const portal_flows_flow_subscription_cancelSchema: { readonly description: ""; readonly properties: { readonly retention: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_retention"; }]; readonly description: "Specify a retention strategy to be used in the cancellation flow."; readonly nullable: true; }; readonly subscription: { readonly description: "The ID of the subscription to be canceled."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["subscription"]; readonly title: "PortalFlowsFlowSubscriptionCancel"; readonly type: "object"; readonly 'x-expandableFields': readonly ["retention"]; }; export declare const portal_flows_flow_subscription_updateSchema: { readonly description: ""; readonly properties: { readonly subscription: { readonly description: "The ID of the subscription to be updated."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["subscription"]; readonly title: "PortalFlowsFlowSubscriptionUpdate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_flows_flow_subscription_update_confirmSchema: { readonly description: ""; readonly properties: { readonly discounts: { readonly description: "The coupon or promotion code to apply to this subscription update. Currently, only up to one may be specified."; readonly items: { readonly $ref: "#/components/schemas/portal_flows_subscription_update_confirm_discount"; }; readonly nullable: true; readonly type: "array"; }; readonly items: { readonly description: "The [subscription item](https://stripe.com/docs/api/subscription_items) to be updated through this flow. Currently, only up to one may be specified and subscriptions with multiple items are not updatable."; readonly items: { readonly $ref: "#/components/schemas/portal_flows_subscription_update_confirm_item"; }; readonly type: "array"; }; readonly subscription: { readonly description: "The ID of the subscription to be updated."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["items", "subscription"]; readonly title: "PortalFlowsFlowSubscriptionUpdateConfirm"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discounts", "items"]; }; export declare const portal_flows_retentionSchema: { readonly description: ""; readonly properties: { readonly coupon_offer: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/portal_flows_coupon_offer"; }]; readonly description: "Configuration when `retention.type=coupon_offer`."; readonly nullable: true; }; readonly type: { readonly description: "Type of retention strategy that will be used."; readonly enum: readonly ["coupon_offer"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "PortalFlowsRetention"; readonly type: "object"; readonly 'x-expandableFields': readonly ["coupon_offer"]; }; export declare const portal_flows_subscription_update_confirm_discountSchema: { readonly description: ""; readonly properties: { readonly coupon: { readonly description: "The ID of the coupon to apply to this subscription update."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly promotion_code: { readonly description: "The ID of a promotion code to apply to this subscription update."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "PortalFlowsSubscriptionUpdateConfirmDiscount"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_flows_subscription_update_confirm_itemSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "The ID of the [subscription item](https://stripe.com/docs/api/subscriptions/object#subscription_object-items-data-id) to be updated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly price: { readonly description: "The price the customer should subscribe to through this flow. The price must also be included in the configuration's [`features.subscription_update.products`](https://stripe.com/docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly quantity: { readonly description: "[Quantity](https://stripe.com/docs/subscriptions/quantities) for this item that the customer should subscribe to through this flow."; readonly type: "integer"; }; }; readonly title: "PortalFlowsSubscriptionUpdateConfirmItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_invoice_listSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PortalInvoiceList"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_login_pageSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "If `true`, a shareable `url` will be generated that will take your customers to a hosted login page for the customer portal.\n\nIf `false`, the previously generated `url`, if any, will be deactivated."; readonly type: "boolean"; }; readonly url: { readonly description: "A shareable URL to the hosted portal login page. Your customers will be able to log in with their [email](https://stripe.com/docs/api/customers/object#customer_object-email) and receive a link to their customer portal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["enabled"]; readonly title: "PortalLoginPage"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_payment_method_updateSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; }; readonly required: readonly ["enabled"]; readonly title: "PortalPaymentMethodUpdate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_subscription_cancelSchema: { readonly description: ""; readonly properties: { readonly cancellation_reason: { readonly $ref: "#/components/schemas/portal_subscription_cancellation_reason"; }; readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; readonly mode: { readonly description: "Whether to cancel subscriptions immediately or at the end of the billing period."; readonly enum: readonly ["at_period_end", "immediately"]; readonly type: "string"; }; readonly proration_behavior: { readonly description: "Whether to create prorations when canceling subscriptions. Possible values are `none` and `create_prorations`."; readonly enum: readonly ["always_invoice", "create_prorations", "none"]; readonly type: "string"; }; }; readonly required: readonly ["cancellation_reason", "enabled", "mode", "proration_behavior"]; readonly title: "PortalSubscriptionCancel"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cancellation_reason"]; }; export declare const portal_subscription_cancellation_reasonSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; readonly options: { readonly description: "Which cancellation reasons will be given as options to the customer."; readonly items: { readonly enum: readonly ["customer_service", "low_quality", "missing_features", "other", "switched_service", "too_complex", "too_expensive", "unused"]; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["enabled", "options"]; readonly title: "PortalSubscriptionCancellationReason"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const portal_subscription_updateSchema: { readonly description: ""; readonly properties: { readonly default_allowed_updates: { readonly description: "The types of subscription updates that are supported for items listed in the `products` attribute. When empty, subscriptions are not updateable."; readonly items: { readonly enum: readonly ["price", "promotion_code", "quantity"]; readonly type: "string"; }; readonly type: "array"; }; readonly enabled: { readonly description: "Whether the feature is enabled."; readonly type: "boolean"; }; readonly products: { readonly description: "The list of up to 10 products that support subscription updates."; readonly items: { readonly $ref: "#/components/schemas/portal_subscription_update_product"; }; readonly nullable: true; readonly type: "array"; }; readonly proration_behavior: { readonly description: "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`. Defaults to a value of `none` if you don't set it during creation."; readonly enum: readonly ["always_invoice", "create_prorations", "none"]; readonly type: "string"; }; }; readonly required: readonly ["default_allowed_updates", "enabled", "proration_behavior"]; readonly title: "PortalSubscriptionUpdate"; readonly type: "object"; readonly 'x-expandableFields': readonly ["products"]; }; export declare const portal_subscription_update_productSchema: { readonly description: ""; readonly properties: { readonly prices: { readonly description: "The list of price IDs which, when subscribed to, a subscription can be updated."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly product: { readonly description: "The product ID."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["prices", "product"]; readonly title: "PortalSubscriptionUpdateProduct"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const priceSchema: { readonly description: "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview)."; readonly properties: { readonly active: { readonly description: "Whether the price can be used for new purchases."; readonly type: "boolean"; }; readonly billing_scheme: { readonly description: "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `unit_amount` or `unit_amount_decimal`) will be charged per unit in `quantity` (for prices with `usage_type=licensed`), or per unit of total usage (for prices with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes."; readonly enum: readonly ["per_unit", "tiered"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly currency_options: { readonly additionalProperties: { readonly $ref: "#/components/schemas/currency_option"; }; readonly description: "Prices defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."; readonly type: "object"; }; readonly custom_unit_amount: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/custom_unit_amount"; }]; readonly description: "When set, provides configuration for the amount to be adjusted by the customer during Checkout Sessions and Payment Links."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly lookup_key: { readonly description: "A lookup key used to retrieve prices dynamically from a static string. This may be up to 200 characters."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly nickname: { readonly description: "A brief description of the price, hidden from customers."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["price"]; readonly type: "string"; }; readonly product: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/product"; }, { readonly $ref: "#/components/schemas/deleted_product"; }]; readonly description: "The ID of the product this price is associated with."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/product"; }, { readonly $ref: "#/components/schemas/deleted_product"; }]; }; }; readonly recurring: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/recurring"; }]; readonly description: "The recurring components of a price such as `interval` and `usage_type`."; readonly nullable: true; }; readonly tax_behavior: { readonly description: "Only required if a [default tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#setting-a-default-tax-behavior-(recommended)) was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`. Once specified as either `inclusive` or `exclusive`, it cannot be changed."; readonly enum: readonly ["exclusive", "inclusive", "unspecified"]; readonly nullable: true; readonly type: "string"; }; readonly tiers: { readonly description: "Each element represents a pricing tier. This parameter requires `billing_scheme` to be set to `tiered`. See also the documentation for `billing_scheme`."; readonly items: { readonly $ref: "#/components/schemas/price_tier"; }; readonly type: "array"; }; readonly tiers_mode: { readonly description: "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price. In `graduated` tiering, pricing can change as the quantity grows."; readonly enum: readonly ["graduated", "volume"]; readonly nullable: true; readonly type: "string"; }; readonly transform_quantity: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/transform_quantity"; }]; readonly description: "Apply a transformation to the reported usage or set quantity before computing the amount billed. Cannot be combined with `tiers`."; readonly nullable: true; }; readonly type: { readonly description: "One of `one_time` or `recurring` depending on whether the price is for a one-time purchase or a recurring (subscription) purchase."; readonly enum: readonly ["one_time", "recurring"]; readonly type: "string"; }; readonly unit_amount: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "The unit amount in cents (or local equivalent) to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["active", "billing_scheme", "created", "currency", "id", "livemode", "metadata", "object", "product", "type"]; readonly title: "Price"; readonly type: "object"; readonly 'x-expandableFields': readonly ["currency_options", "custom_unit_amount", "product", "recurring", "tiers", "transform_quantity"]; readonly 'x-resourceId': "price"; }; export declare const price_tierSchema: { readonly description: ""; readonly properties: { readonly flat_amount: { readonly description: "Price for the entire tier."; readonly nullable: true; readonly type: "integer"; }; readonly flat_amount_decimal: { readonly description: "Same as `flat_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly unit_amount: { readonly description: "Per unit price for units relevant to the tier."; readonly nullable: true; readonly type: "integer"; }; readonly unit_amount_decimal: { readonly description: "Same as `unit_amount`, but contains a decimal value with at most 12 decimal places."; readonly format: "decimal"; readonly nullable: true; readonly type: "string"; }; readonly up_to: { readonly description: "Up to and including to this quantity will be contained in the tier."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "PriceTier"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const productSchema: { readonly description: "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)"; readonly properties: { readonly active: { readonly description: "Whether the product is currently available for purchase."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly default_price: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/price"; }]; readonly description: "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/price"; }]; }; }; readonly description: { readonly description: "The product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly images: { readonly description: "A list of up to 8 URLs of images for this product, meant to be displayable to the customer."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly marketing_features: { readonly description: "A list of up to 15 marketing features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)."; readonly items: { readonly $ref: "#/components/schemas/product_marketing_feature"; }; readonly type: "array"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly name: { readonly description: "The product's name, meant to be displayable to the customer."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["product"]; readonly type: "string"; }; readonly package_dimensions: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/package_dimensions"; }]; readonly description: "The dimensions of this product for shipping purposes."; readonly nullable: true; }; readonly shippable: { readonly description: "Whether this product is shipped (i.e., physical goods)."; readonly nullable: true; readonly type: "boolean"; }; readonly statement_descriptor: { readonly description: "Extra information about a product which will appear on your customer's credit card statement. In the case that multiple products are billed at once, the first statement descriptor will be used. Only used for subscription payments."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_code: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_code"; }]; readonly description: "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_code"; }]; }; }; readonly unit_label: { readonly description: "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly updated: { readonly description: "Time at which the object was last updated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly url: { readonly description: "A URL of a publicly-accessible webpage for this product."; readonly maxLength: 2048; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["active", "created", "id", "images", "livemode", "marketing_features", "metadata", "name", "object", "updated"]; readonly title: "Product"; readonly type: "object"; readonly 'x-expandableFields': readonly ["default_price", "marketing_features", "package_dimensions", "tax_code"]; readonly 'x-resourceId': "product"; }; export declare const product_featureSchema: { readonly description: "A product_feature represents an attachment between a feature and a product.\nWhen a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer."; readonly properties: { readonly entitlement_feature: { readonly $ref: "#/components/schemas/entitlements.feature"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["product_feature"]; readonly type: "string"; }; }; readonly required: readonly ["entitlement_feature", "id", "livemode", "object"]; readonly title: "ProductFeature"; readonly type: "object"; readonly 'x-expandableFields': readonly ["entitlement_feature"]; readonly 'x-resourceId': "product_feature"; }; export declare const product_marketing_featureSchema: { readonly description: ""; readonly properties: { readonly name: { readonly description: "The marketing feature name. Up to 80 characters long."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "ProductMarketingFeature"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const promotion_codeSchema: { readonly description: "A Promotion Code represents a customer-redeemable code for a [coupon](https://stripe.com/docs/api#coupons). It can be used to\ncreate multiple codes for a single coupon."; readonly properties: { readonly active: { readonly description: "Whether the promotion code is currently active. A promotion code is only active if the coupon is also valid."; readonly type: "boolean"; }; readonly code: { readonly description: "The customer-facing code. Regardless of case, this code must be unique across all active promotion codes for each customer."; readonly maxLength: 5000; readonly type: "string"; }; readonly coupon: { readonly $ref: "#/components/schemas/coupon"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The customer that this promotion code can be used by."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly expires_at: { readonly description: "Date at which the promotion code can no longer be redeemed."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly max_redemptions: { readonly description: "Maximum number of times this promotion code can be redeemed."; readonly nullable: true; readonly type: "integer"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["promotion_code"]; readonly type: "string"; }; readonly restrictions: { readonly $ref: "#/components/schemas/promotion_codes_resource_restrictions"; }; readonly times_redeemed: { readonly description: "Number of times this promotion code has been used."; readonly type: "integer"; }; }; readonly required: readonly ["active", "code", "coupon", "created", "id", "livemode", "object", "restrictions", "times_redeemed"]; readonly title: "PromotionCode"; readonly type: "object"; readonly 'x-expandableFields': readonly ["coupon", "customer", "restrictions"]; readonly 'x-resourceId': "promotion_code"; }; export declare const promotion_code_currency_optionSchema: { readonly description: ""; readonly properties: { readonly minimum_amount: { readonly description: "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."; readonly type: "integer"; }; }; readonly required: readonly ["minimum_amount"]; readonly title: "PromotionCodeCurrencyOption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const promotion_codes_resource_restrictionsSchema: { readonly description: ""; readonly properties: { readonly currency_options: { readonly additionalProperties: { readonly $ref: "#/components/schemas/promotion_code_currency_option"; }; readonly description: "Promotion code restrictions defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."; readonly type: "object"; }; readonly first_time_transaction: { readonly description: "A Boolean indicating if the Promotion Code should only be redeemed for Customers without any successful payments or invoices"; readonly type: "boolean"; }; readonly minimum_amount: { readonly description: "Minimum amount required to redeem this Promotion Code into a Coupon (e.g., a purchase must be $100 or more to work)."; readonly nullable: true; readonly type: "integer"; }; readonly minimum_amount_currency: { readonly description: "Three-letter [ISO code](https://stripe.com/docs/currencies) for minimum_amount"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["first_time_transaction"]; readonly title: "PromotionCodesResourceRestrictions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["currency_options"]; }; export declare const quoteSchema: { readonly description: "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule."; readonly properties: { readonly amount_subtotal: { readonly description: "Total before any discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total after discounts and taxes are applied."; readonly type: "integer"; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "ID of the Connect Application that created the quote."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly application_fee_amount: { readonly description: "The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's Stripe account. Only applicable if there are no line items with recurring prices on the quote."; readonly nullable: true; readonly type: "integer"; }; readonly application_fee_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote."; readonly nullable: true; readonly type: "number"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/quotes_resource_automatic_tax"; }; readonly collection_method: { readonly description: "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay invoices at the end of the subscription cycle or on finalization using the default payment method attached to the subscription or customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`. Defaults to `charge_automatically`."; readonly enum: readonly ["charge_automatically", "send_invoice"]; readonly type: "string"; }; readonly computed: { readonly $ref: "#/components/schemas/quotes_resource_computed"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The customer which this quote belongs to. A customer is required before finalizing the quote. Once specified, it cannot be changed."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly default_tax_rates: { readonly description: "The tax rates applied to this quote."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_rate"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_rate"; }]; }; }; readonly type: "array"; }; readonly description: { readonly description: "A description that will be displayed on the quote PDF."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discounts: { readonly description: "The discounts applied to this quote."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly type: "array"; }; readonly expires_at: { readonly description: "The date on which the quote will be canceled if in `open` or `draft` status. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly footer: { readonly description: "A footer that will be displayed on the quote PDF."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly from_quote: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/quotes_resource_from_quote"; }]; readonly description: "Details of the quote that was cloned. See the [cloning documentation](https://stripe.com/docs/quotes/clone) for more details."; readonly nullable: true; }; readonly header: { readonly description: "A header that will be displayed on the quote PDF."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }, { readonly $ref: "#/components/schemas/deleted_invoice"; }]; readonly description: "The invoice that was created from this quote."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }, { readonly $ref: "#/components/schemas/deleted_invoice"; }]; }; }; readonly invoice_settings: { readonly $ref: "#/components/schemas/invoice_setting_quote_setting"; }; readonly line_items: { readonly description: "A list of items the customer is being quoted for."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "QuotesResourceListLineItems"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly number: { readonly description: "A unique number that identifies this particular quote. This number is assigned once the quote is [finalized](https://stripe.com/docs/quotes/overview#finalize)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["quote"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account on behalf of which to charge. See the [Connect documentation](https://support.stripe.com/questions/sending-invoices-on-behalf-of-connected-accounts) for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly status: { readonly description: "The status of the quote."; readonly enum: readonly ["accepted", "canceled", "draft", "open"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly status_transitions: { readonly $ref: "#/components/schemas/quotes_resource_status_transitions"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "The subscription that was created or updated from this quote."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly subscription_data: { readonly $ref: "#/components/schemas/quotes_resource_subscription_data_subscription_data"; }; readonly subscription_schedule: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription_schedule"; }]; readonly description: "The subscription schedule that was created or updated from this quote."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription_schedule"; }]; }; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock this quote belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; readonly total_details: { readonly $ref: "#/components/schemas/quotes_resource_total_details"; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/quotes_resource_transfer_data"; }]; readonly description: "The account (if any) the payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the invoices."; readonly nullable: true; }; }; readonly required: readonly ["amount_subtotal", "amount_total", "automatic_tax", "collection_method", "computed", "created", "discounts", "expires_at", "id", "invoice_settings", "livemode", "metadata", "object", "status", "status_transitions", "subscription_data", "total_details"]; readonly title: "Quote"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "automatic_tax", "computed", "customer", "default_tax_rates", "discounts", "from_quote", "invoice", "invoice_settings", "line_items", "on_behalf_of", "status_transitions", "subscription", "subscription_data", "subscription_schedule", "test_clock", "total_details", "transfer_data"]; readonly 'x-resourceId': "quote"; }; export declare const quotes_resource_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Automatically calculate taxes"; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; readonly status: { readonly description: "The status of the most recent automated tax calculation for this quote."; readonly enum: readonly ["complete", "failed", "requires_location_inputs"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["enabled"]; readonly title: "QuotesResourceAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const quotes_resource_computedSchema: { readonly description: ""; readonly properties: { readonly recurring: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/quotes_resource_recurring"; }]; readonly description: "The definitive totals and line items the customer will be charged on a recurring basis. Takes into account the line items with recurring prices and discounts with `duration=forever` coupons only. Defaults to `null` if no inputted line items with recurring prices."; readonly nullable: true; }; readonly upfront: { readonly $ref: "#/components/schemas/quotes_resource_upfront"; }; }; readonly required: readonly ["upfront"]; readonly title: "QuotesResourceComputed"; readonly type: "object"; readonly 'x-expandableFields': readonly ["recurring", "upfront"]; }; export declare const quotes_resource_from_quoteSchema: { readonly description: ""; readonly properties: { readonly is_revision: { readonly description: "Whether this quote is a revision of a different quote."; readonly type: "boolean"; }; readonly quote: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/quote"; }]; readonly description: "The quote that was cloned."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/quote"; }]; }; }; }; readonly required: readonly ["is_revision", "quote"]; readonly title: "QuotesResourceFromQuote"; readonly type: "object"; readonly 'x-expandableFields': readonly ["quote"]; }; export declare const quotes_resource_recurringSchema: { readonly description: ""; readonly properties: { readonly amount_subtotal: { readonly description: "Total before any discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total after discounts and taxes are applied."; readonly type: "integer"; }; readonly interval: { readonly description: "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."; readonly enum: readonly ["day", "month", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."; readonly type: "integer"; }; readonly total_details: { readonly $ref: "#/components/schemas/quotes_resource_total_details"; }; }; readonly required: readonly ["amount_subtotal", "amount_total", "interval", "interval_count", "total_details"]; readonly title: "QuotesResourceRecurring"; readonly type: "object"; readonly 'x-expandableFields': readonly ["total_details"]; }; export declare const quotes_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly accepted_at: { readonly description: "The time that the quote was accepted. Measured in seconds since Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly canceled_at: { readonly description: "The time that the quote was canceled. Measured in seconds since Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly finalized_at: { readonly description: "The time that the quote was finalized. Measured in seconds since Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "QuotesResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const quotes_resource_subscription_data_subscription_dataSchema: { readonly description: ""; readonly properties: { readonly description: { readonly description: "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly effective_date: { readonly description: "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. This date is ignored if it is in the past when the quote is accepted. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values."; readonly nullable: true; readonly type: "object"; }; readonly trial_period_days: { readonly description: "Integer representing the number of trial period days before the customer is charged for the first time."; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "QuotesResourceSubscriptionDataSubscriptionData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const quotes_resource_total_detailsSchema: { readonly description: ""; readonly properties: { readonly amount_discount: { readonly description: "This is the sum of all the discounts."; readonly type: "integer"; }; readonly amount_shipping: { readonly description: "This is the sum of all the shipping amounts."; readonly nullable: true; readonly type: "integer"; }; readonly amount_tax: { readonly description: "This is the sum of all the tax amounts."; readonly type: "integer"; }; readonly breakdown: { readonly $ref: "#/components/schemas/quotes_resource_total_details_resource_breakdown"; }; }; readonly required: readonly ["amount_discount", "amount_tax"]; readonly title: "QuotesResourceTotalDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["breakdown"]; }; export declare const quotes_resource_total_details_resource_breakdownSchema: { readonly description: ""; readonly properties: { readonly discounts: { readonly description: "The aggregated discounts."; readonly items: { readonly $ref: "#/components/schemas/line_items_discount_amount"; }; readonly type: "array"; }; readonly taxes: { readonly description: "The aggregated tax amounts by rate."; readonly items: { readonly $ref: "#/components/schemas/line_items_tax_amount"; }; readonly type: "array"; }; }; readonly required: readonly ["discounts", "taxes"]; readonly title: "QuotesResourceTotalDetailsResourceBreakdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discounts", "taxes"]; }; export declare const quotes_resource_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount in cents (or local equivalent) that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination."; readonly nullable: true; readonly type: "integer"; }; readonly amount_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount will be transferred to the destination."; readonly nullable: true; readonly type: "number"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account where funds from the payment will be transferred to upon payment success."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "QuotesResourceTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const quotes_resource_upfrontSchema: { readonly description: ""; readonly properties: { readonly amount_subtotal: { readonly description: "Total before any discounts or taxes are applied."; readonly type: "integer"; }; readonly amount_total: { readonly description: "Total after discounts and taxes are applied."; readonly type: "integer"; }; readonly line_items: { readonly description: "The line items that will appear on the next invoice after this quote is accepted. This does not include pending invoice items that exist on the customer but may still be included in the next invoice."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "QuotesResourceListLineItems"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly total_details: { readonly $ref: "#/components/schemas/quotes_resource_total_details"; }; }; readonly required: readonly ["amount_subtotal", "amount_total", "total_details"]; readonly title: "QuotesResourceUpfront"; readonly type: "object"; readonly 'x-expandableFields': readonly ["line_items", "total_details"]; }; export declare const radar_early_fraud_warningSchema: { readonly description: "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)"; readonly properties: { readonly actionable: { readonly description: "An EFW is actionable if it has not received a dispute and has not been fully refunded. You may wish to proactively refund a charge that receives an EFW, in order to avoid receiving a dispute later."; readonly type: "boolean"; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the charge this early fraud warning is for, optionally expanded."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly fraud_type: { readonly description: "The type of fraud labelled by the issuer. One of `card_never_received`, `fraudulent_card_application`, `made_with_counterfeit_card`, `made_with_lost_card`, `made_with_stolen_card`, `misc`, `unauthorized_use_of_card`."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["radar.early_fraud_warning"]; readonly type: "string"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "ID of the Payment Intent this early fraud warning is for, optionally expanded."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; }; readonly required: readonly ["actionable", "charge", "created", "fraud_type", "id", "livemode", "object"]; readonly title: "RadarEarlyFraudWarning"; readonly type: "object"; readonly 'x-expandableFields': readonly ["charge", "payment_intent"]; readonly 'x-resourceId': "radar.early_fraud_warning"; }; export declare const radar_value_listSchema: { readonly description: "Value lists allow you to group values together which can then be referenced in rules.\n\nRelated guide: [Default Stripe lists](https://stripe.com/docs/radar/lists#managing-list-items)"; readonly properties: { readonly alias: { readonly description: "The name of the value list for use in rules."; readonly maxLength: 5000; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly created_by: { readonly description: "The name or email address of the user who created this value list."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly item_type: { readonly description: "The type of items in the value list. One of `card_fingerprint`, `us_bank_account_fingerprint`, `sepa_debit_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`."; readonly enum: readonly ["card_bin", "card_fingerprint", "case_sensitive_string", "country", "customer_id", "email", "ip_address", "sepa_debit_fingerprint", "string", "us_bank_account_fingerprint"]; readonly type: "string"; }; readonly list_items: { readonly description: "List of items contained within this value list."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/radar.value_list_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "RadarListListItemList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly name: { readonly description: "The name of the value list."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["radar.value_list"]; readonly type: "string"; }; }; readonly required: readonly ["alias", "created", "created_by", "id", "item_type", "list_items", "livemode", "metadata", "name", "object"]; readonly title: "RadarListList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["list_items"]; readonly 'x-resourceId': "radar.value_list"; }; export declare const radar_value_list_itemSchema: { readonly description: "Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.\n\nRelated guide: [Managing list items](https://stripe.com/docs/radar/lists#managing-list-items)"; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly created_by: { readonly description: "The name or email address of the user who added this item to the value list."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["radar.value_list_item"]; readonly type: "string"; }; readonly value: { readonly description: "The value of the item."; readonly maxLength: 5000; readonly type: "string"; }; readonly value_list: { readonly description: "The identifier of the value list this item belongs to."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "created_by", "id", "livemode", "object", "value", "value_list"]; readonly title: "RadarListListItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "radar.value_list_item"; }; export declare const radar_radar_optionsSchema: { readonly description: "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information."; readonly properties: { readonly session: { readonly description: "A [Radar Session](https://stripe.com/docs/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "RadarRadarOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const radar_review_resource_locationSchema: { readonly description: ""; readonly properties: { readonly city: { readonly description: "The city where the payment originated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter ISO code representing the country where the payment originated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly latitude: { readonly description: "The geographic latitude where the payment originated."; readonly nullable: true; readonly type: "number"; }; readonly longitude: { readonly description: "The geographic longitude where the payment originated."; readonly nullable: true; readonly type: "number"; }; readonly region: { readonly description: "The state/county/province/region where the payment originated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "RadarReviewResourceLocation"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const radar_review_resource_sessionSchema: { readonly description: ""; readonly properties: { readonly browser: { readonly description: "The browser used in this browser session (e.g., `Chrome`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly device: { readonly description: "Information about the device used for the browser session (e.g., `Samsung SM-G930T`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly platform: { readonly description: "The platform for the browser session (e.g., `Macintosh`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly version: { readonly description: "The version for the browser session (e.g., `61.0.3163.100`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "RadarReviewResourceSession"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const received_payment_method_details_financial_accountSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "The FinancialAccount ID."; readonly maxLength: 5000; readonly type: "string"; }; readonly network: { readonly description: "The rails the ReceivedCredit was sent over. A FinancialAccount can only send funds over `stripe`."; readonly enum: readonly ["stripe"]; readonly type: "string"; }; }; readonly required: readonly ["id", "network"]; readonly title: "received_payment_method_details_financial_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const recurringSchema: { readonly description: ""; readonly properties: { readonly aggregate_usage: { readonly description: "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`."; readonly enum: readonly ["last_during_period", "last_ever", "max", "sum"]; readonly nullable: true; readonly type: "string"; }; readonly interval: { readonly description: "The frequency at which a subscription is billed. One of `day`, `week`, `month` or `year`."; readonly enum: readonly ["day", "month", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals (specified in the `interval` attribute) between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months."; readonly type: "integer"; }; readonly meter: { readonly description: "The meter tracking the usage of a metered price"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly usage_type: { readonly description: "Configures how the quantity per period should be determined. Can be either `metered` or `licensed`. `licensed` automatically bills the `quantity` set when adding it to a subscription. `metered` aggregates the total usage based on usage records. Defaults to `licensed`."; readonly enum: readonly ["licensed", "metered"]; readonly type: "string"; }; }; readonly required: readonly ["interval", "interval_count", "usage_type"]; readonly title: "Recurring"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const refundSchema: { readonly description: "Refund objects allow you to refund a previously created charge that isn't\nrefunded yet. Funds are refunded to the credit or debit card that's\ninitially charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)"; readonly properties: { readonly amount: { readonly description: "Amount, in cents (or local equivalent)."; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "Balance transaction that describes the impact on your account balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the charge that's refunded."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only)."; readonly maxLength: 5000; readonly type: "string"; }; readonly destination_details: { readonly $ref: "#/components/schemas/refund_destination_details"; }; readonly failure_balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly failure_reason: { readonly description: "Provides the reason for the refund failure. Possible values are: `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request`, or `unknown`."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly instructions_email: { readonly description: "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly next_action: { readonly $ref: "#/components/schemas/refund_next_action"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["refund"]; readonly type: "string"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "ID of the PaymentIntent that's refunded."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly reason: { readonly description: "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`)."; readonly enum: readonly ["duplicate", "expired_uncaptured_charge", "fraudulent", "requested_by_customer"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly receipt_number: { readonly description: "This is the transaction number that appears on email receipts sent for this refund."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly source_transfer_reversal: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/transfer_reversal"; }]; readonly description: "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/transfer_reversal"; }]; }; }; readonly status: { readonly description: "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly transfer_reversal: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/transfer_reversal"; }]; readonly description: "This refers to the transfer reversal object if the accompanying transfer reverses. This is only applicable if the charge was created using the destination parameter."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/transfer_reversal"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "id", "object"]; readonly title: "Refund"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "charge", "destination_details", "failure_balance_transaction", "next_action", "payment_intent", "source_transfer_reversal", "transfer_reversal"]; readonly 'x-resourceId': "refund"; }; export declare const refund_destination_detailsSchema: { readonly description: ""; readonly properties: { readonly affirm: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly afterpay_clearpay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly alipay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly au_bank_transfer: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly blik: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly br_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly card: { readonly $ref: "#/components/schemas/refund_destination_details_card"; }; readonly cashapp: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly customer_cash_balance: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly eps: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly eu_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly gb_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly giropay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly grabpay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly jp_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly klarna: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly multibanco: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly mx_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly p24: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly paynow: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly paypal: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly pix: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly revolut: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly sofort: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly swish: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly th_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly type: { readonly description: "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction."; readonly maxLength: 5000; readonly type: "string"; }; readonly us_bank_transfer: { readonly $ref: "#/components/schemas/refund_destination_details_generic"; }; readonly wechat_pay: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; readonly zip: { readonly $ref: "#/components/schemas/destination_details_unimplemented"; }; }; readonly required: readonly ["type"]; readonly title: "refund_destination_details"; readonly type: "object"; readonly 'x-expandableFields': readonly ["affirm", "afterpay_clearpay", "alipay", "amazon_pay", "au_bank_transfer", "blik", "br_bank_transfer", "card", "cashapp", "customer_cash_balance", "eps", "eu_bank_transfer", "gb_bank_transfer", "giropay", "grabpay", "jp_bank_transfer", "klarna", "multibanco", "mx_bank_transfer", "p24", "paynow", "paypal", "pix", "revolut", "sofort", "swish", "th_bank_transfer", "us_bank_transfer", "wechat_pay", "zip"]; }; export declare const refund_destination_details_cardSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "Value of the reference number assigned to the refund."; readonly maxLength: 5000; readonly type: "string"; }; readonly reference_status: { readonly description: "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`."; readonly maxLength: 5000; readonly type: "string"; }; readonly reference_type: { readonly description: "Type of the reference number assigned to the refund."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "The type of refund. This can be `refund`, `reversal`, or `pending`."; readonly enum: readonly ["pending", "refund", "reversal"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "refund_destination_details_card"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const refund_destination_details_genericSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "The reference assigned to the refund."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly reference_status: { readonly description: "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "refund_destination_details_generic"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const refund_next_actionSchema: { readonly description: ""; readonly properties: { readonly display_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/refund_next_action_display_details"; }]; readonly description: "Contains the refund details."; readonly nullable: true; }; readonly type: { readonly description: "Type of the next action to perform."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "RefundNextAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["display_details"]; }; export declare const refund_next_action_display_detailsSchema: { readonly description: ""; readonly properties: { readonly email_sent: { readonly $ref: "#/components/schemas/email_sent"; }; readonly expires_at: { readonly description: "The expiry timestamp."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["email_sent", "expires_at"]; readonly title: "RefundNextActionDisplayDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["email_sent"]; }; export declare const reporting_report_runSchema: { readonly description: "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes)."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly error: { readonly description: "If something should go wrong during the run, a message about the failure (populated when\n `status=failed`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "`true` if the report is run on live mode data and `false` if it is run on test mode data."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["reporting.report_run"]; readonly type: "string"; }; readonly parameters: { readonly $ref: "#/components/schemas/financial_reporting_finance_report_run_run_parameters"; }; readonly report_type: { readonly description: "The ID of the [report type](https://stripe.com/docs/reports/report-types) to run, such as `\"balance.summary.1\"`."; readonly maxLength: 5000; readonly type: "string"; }; readonly result: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; readonly description: "The file object representing the result of the report run (populated when\n `status=succeeded`)."; readonly nullable: true; }; readonly status: { readonly description: "Status of this report run. This will be `pending` when the run is initially created.\n When the run finishes, this will be set to `succeeded` and the `result` field will be populated.\n Rarely, we may encounter an error, at which point this will be set to `failed` and the `error` field will be populated."; readonly maxLength: 5000; readonly type: "string"; }; readonly succeeded_at: { readonly description: "Timestamp at which this run successfully finished (populated when\n `status=succeeded`). Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "parameters", "report_type", "status"]; readonly title: "reporting_report_run"; readonly type: "object"; readonly 'x-expandableFields': readonly ["parameters", "result"]; readonly 'x-resourceId': "reporting.report_run"; }; export declare const reporting_report_typeSchema: { readonly description: "The Report Type resource corresponds to a particular type of report, such as\nthe \"Activity summary\" or \"Itemized payouts\" reports. These objects are\nidentified by an ID belonging to a set of enumerated values. See\n[API Access to Reports documentation](https://stripe.com/docs/reporting/statements/api)\nfor those Report Type IDs, along with required and optional parameters.\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes)."; readonly properties: { readonly data_available_end: { readonly description: "Most recent time for which this Report Type is available. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly data_available_start: { readonly description: "Earliest time for which this Report Type is available. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly default_columns: { readonly description: "List of column names that are included by default when this Report Type gets run. (If the Report Type doesn't support the `columns` parameter, this will be null.)"; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly id: { readonly description: "The [ID of the Report Type](https://stripe.com/docs/reporting/statements/api#available-report-types), such as `balance.summary.1`."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly name: { readonly description: "Human-readable name of the Report Type"; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["reporting.report_type"]; readonly type: "string"; }; readonly updated: { readonly description: "When this Report Type was latest updated. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly version: { readonly description: "Version of the Report Type. Different versions report with the same ID will have the same purpose, but may take different run parameters or have different result schemas."; readonly type: "integer"; }; }; readonly required: readonly ["data_available_end", "data_available_start", "id", "livemode", "name", "object", "updated", "version"]; readonly title: "reporting_report_type"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "reporting.report_type"; }; export declare const reserve_transactionSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["reserve_transaction"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "currency", "id", "object"]; readonly title: "ReserveTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const reviewSchema: { readonly description: "Reviews can be used to supplement automated fraud detection with human expertise.\n\nLearn more about [Radar](/radar) and reviewing payments\n[here](https://stripe.com/docs/radar/reviews)."; readonly properties: { readonly billing_zip: { readonly description: "The ZIP or postal code of the card used, if applicable."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "The charge associated with this review."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly closed_reason: { readonly description: "The reason the review was closed, or null if it has not yet been closed. One of `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`."; readonly enum: readonly ["approved", "disputed", "redacted", "refunded", "refunded_as_fraud"]; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly ip_address: { readonly description: "The IP address where the payment originated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly ip_address_location: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/radar_review_resource_location"; }]; readonly description: "Information related to the location of the payment. Note that this information is an approximation and attempts to locate the nearest population center - it should not be used to determine a specific address."; readonly nullable: true; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["review"]; readonly type: "string"; }; readonly open: { readonly description: "If `true`, the review needs action."; readonly type: "boolean"; }; readonly opened_reason: { readonly description: "The reason the review was opened. One of `rule` or `manual`."; readonly enum: readonly ["manual", "rule"]; readonly type: "string"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "The PaymentIntent ID associated with this review, if one exists."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly reason: { readonly description: "The reason the review is currently open or closed. One of `rule`, `manual`, `approved`, `refunded`, `refunded_as_fraud`, `disputed`, or `redacted`."; readonly maxLength: 5000; readonly type: "string"; }; readonly session: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/radar_review_resource_session"; }]; readonly description: "Information related to the browsing session of the user who initiated the payment."; readonly nullable: true; }; }; readonly required: readonly ["created", "id", "livemode", "object", "open", "opened_reason", "reason"]; readonly title: "RadarReview"; readonly type: "object"; readonly 'x-expandableFields': readonly ["charge", "ip_address_location", "payment_intent", "session"]; readonly 'x-resourceId': "review"; }; export declare const ruleSchema: { readonly description: ""; readonly properties: { readonly action: { readonly description: "The action taken on the payment."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly predicate: { readonly description: "The predicate to evaluate the payment against."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["action", "id", "predicate"]; readonly title: "RadarRule"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const scheduled_query_runSchema: { readonly description: "If you have [scheduled a Sigma query](https://stripe.com/docs/sigma/scheduled-queries), you'll\nreceive a `sigma.scheduled_query_run.created` webhook each time the query\nruns. The webhook contains a `ScheduledQueryRun` object, which you can use to\nretrieve the query results."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly data_load_time: { readonly description: "When the query was run, Sigma contained a snapshot of your Stripe data at this time."; readonly format: "unix-time"; readonly type: "integer"; }; readonly error: { readonly $ref: "#/components/schemas/sigma_scheduled_query_run_error"; }; readonly file: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; readonly description: "The file object representing the results of the query."; readonly nullable: true; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["scheduled_query_run"]; readonly type: "string"; }; readonly result_available_until: { readonly description: "Time at which the result expires and is no longer available for download."; readonly format: "unix-time"; readonly type: "integer"; }; readonly sql: { readonly description: "SQL for the query."; readonly maxLength: 100000; readonly type: "string"; }; readonly status: { readonly description: "The query's execution status, which will be `completed` for successful runs, and `canceled`, `failed`, or `timed_out` otherwise."; readonly maxLength: 5000; readonly type: "string"; }; readonly title: { readonly description: "Title of the query."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "data_load_time", "id", "livemode", "object", "result_available_until", "sql", "status", "title"]; readonly title: "ScheduledQueryRun"; readonly type: "object"; readonly 'x-expandableFields': readonly ["error", "file"]; readonly 'x-resourceId': "scheduled_query_run"; }; export declare const schedules_phase_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether Stripe automatically computes tax on invoices created during this phase."; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "SchedulesPhaseAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const secret_service_resource_scopeSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "The secret scope type."; readonly enum: readonly ["account", "user"]; readonly type: "string"; }; readonly user: { readonly description: "The user ID, if type is set to \"user\""; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "SecretServiceResourceScope"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const sepa_debit_generated_fromSchema: { readonly description: ""; readonly properties: { readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "The ID of the Charge that generated this PaymentMethod, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly setup_attempt: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_attempt"; }]; readonly description: "The ID of the SetupAttempt that generated this PaymentMethod, if any."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_attempt"; }]; }; }; }; readonly title: "sepa_debit_generated_from"; readonly type: "object"; readonly 'x-expandableFields': readonly ["charge", "setup_attempt"]; }; export declare const setup_attemptSchema: { readonly description: "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation is successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent."; readonly properties: { readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "The value of [application](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-application) on the SetupIntent at the time of this confirmation."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly attach_to_self: { readonly description: "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "The value of [customer](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-customer) on the SetupIntent at the time of this confirmation."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly flow_directions: { readonly description: "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."; readonly items: { readonly enum: readonly ["inbound", "outbound"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["setup_attempt"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The value of [on_behalf_of](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-on_behalf_of) on the SetupIntent at the time of this confirmation."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the payment method used with this SetupAttempt."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly payment_method_details: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details"; }; readonly setup_error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/api_errors"; }]; readonly description: "The error encountered during this attempt to confirm the SetupIntent, if any."; readonly nullable: true; }; readonly setup_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_intent"; }]; readonly description: "ID of the SetupIntent that this attempt belongs to."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent"; }]; }; }; readonly status: { readonly description: "Status of this SetupAttempt, one of `requires_confirmation`, `requires_action`, `processing`, `succeeded`, `failed`, or `abandoned`."; readonly maxLength: 5000; readonly type: "string"; }; readonly usage: { readonly description: "The value of [usage](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-usage) on the SetupIntent at the time of this confirmation, one of `off_session` or `on_session`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "payment_method", "payment_method_details", "setup_intent", "status", "usage"]; readonly title: "PaymentFlowsSetupIntentSetupAttempt"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "customer", "on_behalf_of", "payment_method", "payment_method_details", "setup_error", "setup_intent"]; readonly 'x-resourceId': "setup_attempt"; }; export declare const setup_attempt_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_acss_debit"; }; readonly amazon_pay: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_amazon_pay"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_au_becs_debit"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_bacs_debit"; }; readonly bancontact: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_bancontact"; }; readonly boleto: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_boleto"; }; readonly card: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_card"; }; readonly card_present: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_card_present"; }; readonly cashapp: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_cashapp"; }; readonly ideal: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_ideal"; }; readonly klarna: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_klarna"; }; readonly link: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_link"; }; readonly paypal: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_paypal"; }; readonly revolut_pay: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_revolut_pay"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_sepa_debit"; }; readonly sofort: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_sofort"; }; readonly type: { readonly description: "The type of the payment method used in the SetupIntent (e.g., `card`). An additional hash is included on `payment_method_details` with a name matching this value. It contains confirmation-specific information for the payment method."; readonly maxLength: 5000; readonly type: "string"; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_us_bank_account"; }; }; readonly required: readonly ["type"]; readonly title: "SetupAttemptPaymentMethodDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "card_present", "cashapp", "ideal", "klarna", "link", "paypal", "revolut_pay", "sepa_debit", "sofort", "us_bank_account"]; }; export declare const setup_attempt_payment_method_details_acss_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_amazon_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_au_becs_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_au_becs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_bacs_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_bacs_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_bancontactSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "Bank Identifier Code of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly description: "Preferred language of the Bancontact authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"; readonly enum: readonly ["de", "en", "fr", "nl"]; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by Bancontact directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_attempt_payment_method_details_bancontact"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const setup_attempt_payment_method_details_boletoSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_boleto"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_cardSchema: { readonly description: ""; readonly properties: { readonly brand: { readonly description: "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly checks: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_card_checks"; }]; readonly description: "Check results by Card networks on Card address and CVC at the time of authorization"; readonly nullable: true; }; readonly country: { readonly description: "Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly description: "Two-digit number representing the card's expiration month."; readonly nullable: true; readonly type: "integer"; }; readonly exp_year: { readonly description: "Four-digit number representing the card's expiration year."; readonly nullable: true; readonly type: "integer"; }; readonly fingerprint: { readonly description: "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*As of May 1, 2021, card fingerprint in India for Connect changed to allow two fingerprints for the same card---one for India and one for the rest of the world.*"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly funding: { readonly description: "Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly network: { readonly description: "Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly three_d_secure: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/three_d_secure_details"; }]; readonly description: "Populated if this authorization used 3D Secure authentication."; readonly nullable: true; }; readonly wallet: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_attempt_payment_method_details_card_wallet"; }]; readonly description: "If this Card is part of a card wallet, this contains the details of the card wallet."; readonly nullable: true; }; }; readonly title: "setup_attempt_payment_method_details_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["checks", "three_d_secure", "wallet"]; }; export declare const setup_attempt_payment_method_details_card_checksSchema: { readonly description: ""; readonly properties: { readonly address_line1_check: { readonly description: "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly address_postal_code_check: { readonly description: "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly cvc_check: { readonly description: "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_attempt_payment_method_details_card_checks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_card_presentSchema: { readonly description: ""; readonly properties: { readonly generated_card: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the Card PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly offline: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_details_card_present_offline"; }]; readonly description: "Details about payments collected offline."; readonly nullable: true; }; }; readonly title: "setup_attempt_payment_method_details_card_present"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_card", "offline"]; }; export declare const setup_attempt_payment_method_details_card_walletSchema: { readonly description: ""; readonly properties: { readonly apple_pay: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_apple_pay"; }; readonly google_pay: { readonly $ref: "#/components/schemas/payment_method_details_card_wallet_google_pay"; }; readonly type: { readonly description: "The type of the card wallet, one of `apple_pay`, `google_pay`, or `link`. An additional hash is included on the Wallet subhash with a name matching this value. It contains additional information specific to the card wallet type."; readonly enum: readonly ["apple_pay", "google_pay", "link"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "setup_attempt_payment_method_details_card_wallet"; readonly type: "object"; readonly 'x-expandableFields': readonly ["apple_pay", "google_pay"]; }; export declare const setup_attempt_payment_method_details_cashappSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_cashapp"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_idealSchema: { readonly description: ""; readonly properties: { readonly bank: { readonly description: "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `nn`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`."; readonly enum: readonly ["abn_amro", "asn_bank", "bunq", "handelsbanken", "ing", "knab", "moneyou", "n26", "nn", "rabobank", "regiobank", "revolut", "sns_bank", "triodos_bank", "van_lanschot", "yoursafe"]; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "The Bank Identifier Code of the customer's bank."; readonly enum: readonly ["ABNANL2A", "ASNBNL21", "BITSNL2A", "BUNQNL2A", "FVLBNL22", "HANDNL2A", "INGBNL2A", "KNABNL2H", "MOYONL21", "NNBANL2G", "NTSBDEB1", "RABONL2U", "RBRBNL21", "REVOIE23", "REVOLT21", "SNSBNL2A", "TRIONL2U"]; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by iDEAL directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_attempt_payment_method_details_ideal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const setup_attempt_payment_method_details_klarnaSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_klarna"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_linkSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_paypalSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_revolut_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_revolut_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_sepa_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_attempt_payment_method_details_sofortSchema: { readonly description: ""; readonly properties: { readonly bank_code: { readonly description: "Bank code of bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly description: "Bank Identifier Code of the bank associated with the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly generated_sepa_debit: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "The ID of the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly generated_sepa_debit_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "The mandate for the SEPA Direct Debit PaymentMethod which was generated by this SetupAttempt."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly iban_last4: { readonly description: "Last four characters of the IBAN."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly description: "Preferred language of the Sofort authorization page that the customer is redirected to.\nCan be one of `en`, `de`, `fr`, or `nl`"; readonly enum: readonly ["de", "en", "fr", "nl"]; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Owner's verified full name. Values are verified or provided by Sofort directly\n(if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_attempt_payment_method_details_sofort"; readonly type: "object"; readonly 'x-expandableFields': readonly ["generated_sepa_debit", "generated_sepa_debit_mandate"]; }; export declare const setup_attempt_payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_attempt_payment_method_details_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intentSchema: { readonly description: "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you can use a SetupIntent to set up and save your customer's card without immediately collecting a payment.\nLater, you can use [PaymentIntents](https://stripe.com/docs/api#payment_intents) to drive the payment flow.\n\nCreate a SetupIntent when you're ready to collect your customer's payment credentials.\nDon't maintain long-lived, unconfirmed SetupIntents because they might not be valid.\nThe SetupIntent transitions through multiple [statuses](https://docs.stripe.com/payments/intents#intent-statuses) as it guides\nyou through the setup process.\n\nSuccessful SetupIntents result in payment credentials that are optimized for future payments.\nFor example, cardholders in [certain regions](https://stripe.com/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://docs.stripe.com/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://docs.stripe.com/payments/setup-intents).\nIf you use the SetupIntent with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer),\nit automatically attaches the resulting payment method to that Customer after successful setup.\nWe recommend using SetupIntents or [setup_future_usage](https://stripe.com/docs/api#payment_intent_object-setup_future_usage) on\nPaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you can reduce friction for your customers, even as regulations change over time.\n\nRelated guide: [Setup Intents API](https://docs.stripe.com/payments/setup-intents)"; readonly properties: { readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "ID of the Connect application that created the SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly attach_to_self: { readonly description: "If present, the SetupIntent's payment method will be attached to the in-context Stripe Account.\n\nIt can only be used for this Stripe Account’s own money movement flows like InboundTransfer and OutboundTransfers. It cannot be set to true when setting up a PaymentMethod for a Customer, and defaults to false when attaching a PaymentMethod to a Customer."; readonly type: "boolean"; }; readonly automatic_payment_methods: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent"; }]; readonly description: "Settings for dynamic payment methods compatible with this Setup Intent"; readonly nullable: true; }; readonly cancellation_reason: { readonly description: "Reason for cancellation of this SetupIntent, one of `abandoned`, `requested_by_customer`, or `duplicate`."; readonly enum: readonly ["abandoned", "duplicate", "requested_by_customer"]; readonly nullable: true; readonly type: "string"; }; readonly client_secret: { readonly description: "The client secret of this SetupIntent. Used for client-side retrieval using a publishable key.\n\nThe client secret can be used to complete payment setup from your frontend. It should not be stored, logged, or exposed to anyone other than the customer. Make sure that you have TLS enabled on any page that includes the client secret."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the Customer this SetupIntent belongs to, if one exists.\n\nIf present, the SetupIntent's payment method will be attached to the Customer on successful setup. Payment methods attached to other Customers cannot be used with this SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly flow_directions: { readonly description: "Indicates the directions of money movement for which this payment method is intended to be used.\n\nInclude `inbound` if you intend to use the payment method as the origin to pull funds from. Include `outbound` if you intend to use the payment method as the destination to send funds to. You can include both if you intend to use the payment method for both purposes."; readonly items: { readonly enum: readonly ["inbound", "outbound"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly last_setup_error: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/api_errors"; }]; readonly description: "The error encountered in the previous SetupIntent confirmation."; readonly nullable: true; }; readonly latest_attempt: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_attempt"; }]; readonly description: "The most recent SetupAttempt for this SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_attempt"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the multi use Mandate generated by the SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly next_action: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_next_action"; }]; readonly description: "If present, this property tells you what actions you need to take in order for your customer to continue payment setup."; readonly nullable: true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["setup_intent"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) for which the setup is intended."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the payment method used with this SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly payment_method_configuration_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"; }]; readonly description: "Information about the payment method configuration used for this Setup Intent."; readonly nullable: true; }; readonly payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options"; }]; readonly description: "Payment method-specific configuration for this SetupIntent."; readonly nullable: true; }; readonly payment_method_types: { readonly description: "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly single_use_mandate: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/mandate"; }]; readonly description: "ID of the single_use Mandate generated by the SetupIntent."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/mandate"; }]; }; }; readonly status: { readonly description: "[Status](https://stripe.com/docs/payments/intents#intent-statuses) of this SetupIntent, one of `requires_payment_method`, `requires_confirmation`, `requires_action`, `processing`, `canceled`, or `succeeded`."; readonly enum: readonly ["canceled", "processing", "requires_action", "requires_confirmation", "requires_payment_method", "succeeded"]; readonly type: "string"; }; readonly usage: { readonly description: "Indicates how the payment method is intended to be used in the future.\n\nUse `on_session` if you intend to only reuse the payment method when the customer is in your checkout flow. Use `off_session` if your customer may or may not be in your checkout flow. If not provided, this value defaults to `off_session`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "payment_method_types", "status", "usage"]; readonly title: "SetupIntent"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "automatic_payment_methods", "customer", "last_setup_error", "latest_attempt", "mandate", "next_action", "on_behalf_of", "payment_method", "payment_method_configuration_details", "payment_method_options", "single_use_mandate"]; readonly 'x-resourceId': "setup_intent"; }; export declare const setup_intent_next_actionSchema: { readonly description: ""; readonly properties: { readonly cashapp_handle_redirect_or_display_qr_code: { readonly $ref: "#/components/schemas/payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code"; }; readonly redirect_to_url: { readonly $ref: "#/components/schemas/setup_intent_next_action_redirect_to_url"; }; readonly type: { readonly description: "Type of the next action to perform, one of `redirect_to_url`, `use_stripe_sdk`, `alipay_handle_redirect`, `oxxo_display_details`, or `verify_with_microdeposits`."; readonly maxLength: 5000; readonly type: "string"; }; readonly use_stripe_sdk: { readonly description: "When confirming a SetupIntent with Stripe.js, Stripe.js depends on the contents of this dictionary to invoke authentication flows. The shape of the contents is subject to change and is only intended to be used by Stripe.js."; readonly type: "object"; }; readonly verify_with_microdeposits: { readonly $ref: "#/components/schemas/setup_intent_next_action_verify_with_microdeposits"; }; }; readonly required: readonly ["type"]; readonly title: "SetupIntentNextAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cashapp_handle_redirect_or_display_qr_code", "redirect_to_url", "verify_with_microdeposits"]; }; export declare const setup_intent_next_action_redirect_to_urlSchema: { readonly description: ""; readonly properties: { readonly return_url: { readonly description: "If the customer does not exit their browser while authenticating, they will be redirected to this specified URL after completion."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly url: { readonly description: "The URL you must redirect your customer to in order to authenticate."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "SetupIntentNextActionRedirectToUrl"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_next_action_verify_with_microdepositsSchema: { readonly description: ""; readonly properties: { readonly arrival_date: { readonly description: "The timestamp when the microdeposits are expected to land."; readonly format: "unix-time"; readonly type: "integer"; }; readonly hosted_verification_url: { readonly description: "The URL for the hosted verification page, which allows customers to verify their bank account."; readonly maxLength: 5000; readonly type: "string"; }; readonly microdeposit_type: { readonly description: "The type of the microdeposit sent to the customer. Used to distinguish between different verification methods."; readonly enum: readonly ["amounts", "descriptor_code"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["arrival_date", "hosted_verification_url"]; readonly title: "SetupIntentNextActionVerifyWithMicrodeposits"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_acss_debit"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly amazon_pay: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_amazon_pay"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly card: { readonly $ref: "#/components/schemas/setup_intent_payment_method_options_card"; }; readonly card_present: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_card_present"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly link: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_link"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly paypal: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_paypal"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly sepa_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_sepa_debit"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; readonly us_bank_account: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_us_bank_account"; }, { readonly $ref: "#/components/schemas/setup_intent_type_specific_payment_method_options_client"; }]; }; }; readonly title: "SetupIntentPaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "amazon_pay", "card", "card_present", "link", "paypal", "sepa_debit", "us_bank_account"]; }; export declare const setup_intent_payment_method_options_acss_debitSchema: { readonly description: ""; readonly properties: { readonly currency: { readonly description: "Currency supported by the bank account"; readonly enum: readonly ["cad", "usd"]; readonly nullable: true; readonly type: "string"; }; readonly mandate_options: { readonly $ref: "#/components/schemas/setup_intent_payment_method_options_mandate_options_acss_debit"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "setup_intent_payment_method_options_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const setup_intent_payment_method_options_amazon_paySchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_intent_payment_method_options_amazon_pay"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_cardSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent_payment_method_options_card_mandate_options"; }]; readonly description: "Configuration options for setting up an eMandate for cards issued in India."; readonly nullable: true; }; readonly network: { readonly description: "Selected network to process this SetupIntent on. Depends on the available networks of the card attached to the setup intent. Can be only set confirm-time."; readonly enum: readonly ["amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "mastercard", "unionpay", "unknown", "visa"]; readonly nullable: true; readonly type: "string"; }; readonly request_three_d_secure: { readonly description: "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."; readonly enum: readonly ["any", "automatic", "challenge"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "setup_intent_payment_method_options_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const setup_intent_payment_method_options_card_mandate_optionsSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount to be charged for future payments."; readonly type: "integer"; }; readonly amount_type: { readonly description: "One of `fixed` or `maximum`. If `fixed`, the `amount` param refers to the exact amount to be charged in future payments. If `maximum`, the amount charged can be up to the value passed for the `amount` param."; readonly enum: readonly ["fixed", "maximum"]; readonly type: "string"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "A description of the mandate or subscription that is meant to be displayed to the customer."; readonly maxLength: 200; readonly nullable: true; readonly type: "string"; }; readonly end_date: { readonly description: "End date of the mandate or subscription. If not provided, the mandate will be active until canceled. If provided, end date should be after start date."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly interval: { readonly description: "Specifies payment frequency. One of `day`, `week`, `month`, `year`, or `sporadic`."; readonly enum: readonly ["day", "month", "sporadic", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals between payments. For example, `interval=month` and `interval_count=3` indicates one payment every three months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks). This parameter is optional when `interval=sporadic`."; readonly nullable: true; readonly type: "integer"; }; readonly reference: { readonly description: "Unique identifier for the mandate or subscription."; readonly maxLength: 80; readonly type: "string"; }; readonly start_date: { readonly description: "Start date of the mandate or subscription. Start date should not be lesser than yesterday."; readonly format: "unix-time"; readonly type: "integer"; }; readonly supported_types: { readonly description: "Specifies the type of mandates supported. Possible values are `india`."; readonly items: { readonly enum: readonly ["india"]; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly required: readonly ["amount", "amount_type", "currency", "interval", "reference", "start_date"]; readonly title: "setup_intent_payment_method_options_card_mandate_options"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_card_presentSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_intent_payment_method_options_card_present"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_linkSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_intent_payment_method_options_link"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_mandate_options_acss_debitSchema: { readonly description: ""; readonly properties: { readonly custom_mandate_url: { readonly description: "A URL for custom mandate text"; readonly maxLength: 5000; readonly type: "string"; }; readonly default_for: { readonly description: "List of Stripe products where this mandate can be selected automatically."; readonly items: { readonly enum: readonly ["invoice", "subscription"]; readonly type: "string"; }; readonly type: "array"; }; readonly interval_description: { readonly description: "Description of the interval. Only required if the 'payment_schedule' parameter is 'interval' or 'combined'."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payment_schedule: { readonly description: "Payment schedule for the mandate."; readonly enum: readonly ["combined", "interval", "sporadic"]; readonly nullable: true; readonly type: "string"; }; readonly transaction_type: { readonly description: "Transaction type of the mandate."; readonly enum: readonly ["business", "personal"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_intent_payment_method_options_mandate_options_acss_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_mandate_options_sepa_debitSchema: { readonly description: ""; readonly properties: {}; readonly title: "setup_intent_payment_method_options_mandate_options_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_paypalSchema: { readonly description: ""; readonly properties: { readonly billing_agreement_id: { readonly description: "The PayPal Billing Agreement ID (BAID). This is an ID generated by PayPal which represents the mandate between the merchant and the customer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "setup_intent_payment_method_options_paypal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const setup_intent_payment_method_options_sepa_debitSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly $ref: "#/components/schemas/setup_intent_payment_method_options_mandate_options_sepa_debit"; }; }; readonly title: "setup_intent_payment_method_options_sepa_debit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const setup_intent_payment_method_options_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly financial_connections: { readonly $ref: "#/components/schemas/linked_account_options_us_bank_account"; }; readonly mandate_options: { readonly $ref: "#/components/schemas/payment_method_options_us_bank_account_mandate_options"; }; readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "setup_intent_payment_method_options_us_bank_account"; readonly type: "object"; readonly 'x-expandableFields': readonly ["financial_connections", "mandate_options"]; }; export declare const setup_intent_type_specific_payment_method_options_clientSchema: { readonly description: ""; readonly properties: { readonly verification_method: { readonly description: "Bank account verification method."; readonly enum: readonly ["automatic", "instant", "microdeposits"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "SetupIntentTypeSpecificPaymentMethodOptionsClient"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const shippingSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly carrier: { readonly description: "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Recipient name."; readonly maxLength: 5000; readonly type: "string"; }; readonly phone: { readonly description: "Recipient phone (including extension)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tracking_number: { readonly description: "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "Shipping"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const shipping_rateSchema: { readonly description: "Shipping rates describe the price of shipping presented to your customers and\napplied to a purchase. For more information, see [Charge for shipping](https://stripe.com/docs/payments/during-payment/charge-shipping)."; readonly properties: { readonly active: { readonly description: "Whether the shipping rate can be used for new purchases. Defaults to `true`."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly delivery_estimate: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate_delivery_estimate"; }]; readonly description: "The estimated range for how long shipping will take, meant to be displayable to the customer. This will appear on CheckoutSessions."; readonly nullable: true; }; readonly display_name: { readonly description: "The name of the shipping rate, meant to be displayable to the customer. This will appear on CheckoutSessions."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly fixed_amount: { readonly $ref: "#/components/schemas/shipping_rate_fixed_amount"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["shipping_rate"]; readonly type: "string"; }; readonly tax_behavior: { readonly description: "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."; readonly enum: readonly ["exclusive", "inclusive", "unspecified"]; readonly nullable: true; readonly type: "string"; }; readonly tax_code: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_code"; }]; readonly description: "A [tax code](https://stripe.com/docs/tax/tax-categories) ID. The Shipping tax code is `txcd_92010001`."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_code"; }]; }; }; readonly type: { readonly description: "The type of calculation to use on the shipping rate."; readonly enum: readonly ["fixed_amount"]; readonly type: "string"; }; }; readonly required: readonly ["active", "created", "id", "livemode", "metadata", "object", "type"]; readonly title: "ShippingRate"; readonly type: "object"; readonly 'x-expandableFields': readonly ["delivery_estimate", "fixed_amount", "tax_code"]; readonly 'x-resourceId': "shipping_rate"; }; export declare const shipping_rate_currency_optionSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "A non-negative integer in cents representing how much to charge."; readonly type: "integer"; }; readonly tax_behavior: { readonly description: "Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of `inclusive`, `exclusive`, or `unspecified`."; readonly enum: readonly ["exclusive", "inclusive", "unspecified"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "tax_behavior"]; readonly title: "ShippingRateCurrencyOption"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const shipping_rate_delivery_estimateSchema: { readonly description: ""; readonly properties: { readonly maximum: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate_delivery_estimate_bound"; }]; readonly description: "The upper bound of the estimated range. If empty, represents no upper bound i.e., infinite."; readonly nullable: true; }; readonly minimum: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/shipping_rate_delivery_estimate_bound"; }]; readonly description: "The lower bound of the estimated range. If empty, represents no lower bound."; readonly nullable: true; }; }; readonly title: "ShippingRateDeliveryEstimate"; readonly type: "object"; readonly 'x-expandableFields': readonly ["maximum", "minimum"]; }; export declare const shipping_rate_delivery_estimate_boundSchema: { readonly description: ""; readonly properties: { readonly unit: { readonly description: "A unit of time."; readonly enum: readonly ["business_day", "day", "hour", "month", "week"]; readonly type: "string"; }; readonly value: { readonly description: "Must be greater than 0."; readonly type: "integer"; }; }; readonly required: readonly ["unit", "value"]; readonly title: "ShippingRateDeliveryEstimateBound"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const shipping_rate_fixed_amountSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "A non-negative integer in cents representing how much to charge."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly currency_options: { readonly additionalProperties: { readonly $ref: "#/components/schemas/shipping_rate_currency_option"; }; readonly description: "Shipping rates defined in each available currency option. Each key must be a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) and a [supported currency](https://stripe.com/docs/currencies)."; readonly type: "object"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "ShippingRateFixedAmount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["currency_options"]; }; export declare const sigma_scheduled_query_run_errorSchema: { readonly description: ""; readonly properties: { readonly message: { readonly description: "Information about the run failure."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["message"]; readonly title: "SigmaScheduledQueryRunError"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const sourceSchema: { readonly description: "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers)."; readonly properties: { readonly ach_credit_transfer: { readonly $ref: "#/components/schemas/source_type_ach_credit_transfer"; }; readonly ach_debit: { readonly $ref: "#/components/schemas/source_type_ach_debit"; }; readonly acss_debit: { readonly $ref: "#/components/schemas/source_type_acss_debit"; }; readonly alipay: { readonly $ref: "#/components/schemas/source_type_alipay"; }; readonly amount: { readonly description: "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources."; readonly nullable: true; readonly type: "integer"; }; readonly au_becs_debit: { readonly $ref: "#/components/schemas/source_type_au_becs_debit"; }; readonly bancontact: { readonly $ref: "#/components/schemas/source_type_bancontact"; }; readonly card: { readonly $ref: "#/components/schemas/source_type_card"; }; readonly card_present: { readonly $ref: "#/components/schemas/source_type_card_present"; }; readonly client_secret: { readonly description: "The client secret of the source. Used for client-side retrieval using a publishable key."; readonly maxLength: 5000; readonly type: "string"; }; readonly code_verification: { readonly $ref: "#/components/schemas/source_code_verification_flow"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly description: "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready. Required for `single_use` sources."; readonly nullable: true; readonly type: "string"; }; readonly customer: { readonly description: "The ID of the customer to which this source is attached. This will not be present when the source has not been attached to a customer."; readonly maxLength: 5000; readonly type: "string"; }; readonly eps: { readonly $ref: "#/components/schemas/source_type_eps"; }; readonly flow: { readonly description: "The authentication `flow` of the source. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`."; readonly maxLength: 5000; readonly type: "string"; }; readonly giropay: { readonly $ref: "#/components/schemas/source_type_giropay"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly ideal: { readonly $ref: "#/components/schemas/source_type_ideal"; }; readonly klarna: { readonly $ref: "#/components/schemas/source_type_klarna"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly multibanco: { readonly $ref: "#/components/schemas/source_type_multibanco"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["source"]; readonly type: "string"; }; readonly owner: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/source_owner"; }]; readonly description: "Information about the owner of the payment instrument that may be used or required by particular source types."; readonly nullable: true; }; readonly p24: { readonly $ref: "#/components/schemas/source_type_p24"; }; readonly receiver: { readonly $ref: "#/components/schemas/source_receiver_flow"; }; readonly redirect: { readonly $ref: "#/components/schemas/source_redirect_flow"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/source_type_sepa_debit"; }; readonly sofort: { readonly $ref: "#/components/schemas/source_type_sofort"; }; readonly source_order: { readonly $ref: "#/components/schemas/source_order"; }; readonly statement_descriptor: { readonly description: "Extra information about a source. This will appear on your customer's statement every time you charge the source."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "The status of the source, one of `canceled`, `chargeable`, `consumed`, `failed`, or `pending`. Only `chargeable` sources can be used to create a charge."; readonly maxLength: 5000; readonly type: "string"; }; readonly three_d_secure: { readonly $ref: "#/components/schemas/source_type_three_d_secure"; }; readonly type: { readonly description: "The `type` of the source. The `type` is a payment method, one of `ach_credit_transfer`, `ach_debit`, `alipay`, `bancontact`, `card`, `card_present`, `eps`, `giropay`, `ideal`, `multibanco`, `klarna`, `p24`, `sepa_debit`, `sofort`, `three_d_secure`, or `wechat`. An additional hash is included on the source with a name matching this value. It contains additional information specific to the [payment method](https://stripe.com/docs/sources) used."; readonly enum: readonly ["ach_credit_transfer", "ach_debit", "acss_debit", "alipay", "au_becs_debit", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "sepa_debit", "sofort", "three_d_secure", "wechat"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly usage: { readonly description: "Either `reusable` or `single_use`. Whether this source should be reusable or not. Some source types may or may not be reusable by construction, while others may leave the option at creation. If an incompatible value is passed, an error will be returned."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly wechat: { readonly $ref: "#/components/schemas/source_type_wechat"; }; }; readonly required: readonly ["client_secret", "created", "flow", "id", "livemode", "object", "status", "type"]; readonly title: "Source"; readonly type: "object"; readonly 'x-expandableFields': readonly ["code_verification", "owner", "receiver", "redirect", "source_order"]; readonly 'x-resourceId': "source"; }; export declare const source_code_verification_flowSchema: { readonly description: ""; readonly properties: { readonly attempts_remaining: { readonly description: "The number of attempts remaining to authenticate the source object with a verification code."; readonly type: "integer"; }; readonly status: { readonly description: "The status of the code verification, either `pending` (awaiting verification, `attempts_remaining` should be greater than 0), `succeeded` (successful verification) or `failed` (failed verification, cannot be verified anymore as `attempts_remaining` should be 0)."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["attempts_remaining", "status"]; readonly title: "SourceCodeVerificationFlow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_mandate_notificationSchema: { readonly description: "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer."; readonly properties: { readonly acss_debit: { readonly $ref: "#/components/schemas/source_mandate_notification_acss_debit_data"; }; readonly amount: { readonly description: "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount associated with the mandate notification. The amount is expressed in the currency of the underlying source. Required if the notification type is `debit_initiated`."; readonly nullable: true; readonly type: "integer"; }; readonly bacs_debit: { readonly $ref: "#/components/schemas/source_mandate_notification_bacs_debit_data"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["source_mandate_notification"]; readonly type: "string"; }; readonly reason: { readonly description: "The reason of the mandate notification. Valid reasons are `mandate_confirmed` or `debit_initiated`."; readonly maxLength: 5000; readonly type: "string"; }; readonly sepa_debit: { readonly $ref: "#/components/schemas/source_mandate_notification_sepa_debit_data"; }; readonly source: { readonly $ref: "#/components/schemas/source"; }; readonly status: { readonly description: "The status of the mandate notification. Valid statuses are `pending` or `submitted`."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "The type of source this mandate notification is attached to. Should be the source type identifier code for the payment method, such as `three_d_secure`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "reason", "source", "status", "type"]; readonly title: "SourceMandateNotification"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "bacs_debit", "sepa_debit", "source"]; readonly 'x-resourceId': "source_mandate_notification"; }; export declare const source_mandate_notification_acss_debit_dataSchema: { readonly description: ""; readonly properties: { readonly statement_descriptor: { readonly description: "The statement descriptor associate with the debit."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceMandateNotificationAcssDebitData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_mandate_notification_bacs_debit_dataSchema: { readonly description: ""; readonly properties: { readonly last4: { readonly description: "Last 4 digits of the account number associated with the debit."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceMandateNotificationBacsDebitData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_mandate_notification_sepa_debit_dataSchema: { readonly description: ""; readonly properties: { readonly creditor_identifier: { readonly description: "SEPA creditor ID."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "Last 4 digits of the account number associated with the debit."; readonly maxLength: 5000; readonly type: "string"; }; readonly mandate_reference: { readonly description: "Mandate reference associated with the debit."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceMandateNotificationSepaDebitData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_orderSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the total amount for the order."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly email: { readonly description: "The email address of the customer placing the order."; readonly maxLength: 5000; readonly type: "string"; }; readonly items: { readonly description: "List of items constituting the order."; readonly items: { readonly $ref: "#/components/schemas/source_order_item"; }; readonly nullable: true; readonly type: "array"; }; readonly shipping: { readonly $ref: "#/components/schemas/shipping"; }; }; readonly required: readonly ["amount", "currency"]; readonly title: "SourceOrder"; readonly type: "object"; readonly 'x-expandableFields': readonly ["items", "shipping"]; }; export declare const source_order_itemSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount (price) for this order item."; readonly nullable: true; readonly type: "integer"; }; readonly currency: { readonly description: "This currency of this order item. Required when `amount` is present."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly description: { readonly description: "Human-readable description for this order item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly parent: { readonly description: "The ID of the associated object for this line item. Expandable if not null (e.g., expandable to a SKU)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly quantity: { readonly description: "The quantity of this order item. When type is `sku`, this is the number of instances of the SKU to be ordered."; readonly type: "integer"; }; readonly type: { readonly description: "The type of this order item. Must be `sku`, `tax`, or `shipping`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "SourceOrderItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_ownerSchema: { readonly description: ""; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Owner's address."; readonly nullable: true; }; readonly email: { readonly description: "Owner's email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Owner's full name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly phone: { readonly description: "Owner's phone number (including extension)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/address"; }]; readonly description: "Verified owner's address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly nullable: true; }; readonly verified_email: { readonly description: "Verified owner's email address. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Verified owner's full name. Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_phone: { readonly description: "Verified owner's phone number (including extension). Verified values are verified or provided by the payment method directly (and if supported) at the time of authorization or settlement. They cannot be set or mutated."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "SourceOwner"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "verified_address"]; }; export declare const source_receiver_flowSchema: { readonly description: ""; readonly properties: { readonly address: { readonly description: "The address of the receiver source. This is the value that should be communicated to the customer to send their funds to."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly amount_charged: { readonly description: "The total amount that was moved to your balance. This is almost always equal to the amount charged. In rare cases when customers deposit excess funds and we are unable to refund those, those funds get moved to your balance and show up in amount_charged as well. The amount charged is expressed in the source's currency."; readonly type: "integer"; }; readonly amount_received: { readonly description: "The total amount received by the receiver source. `amount_received = amount_returned + amount_charged` should be true for consumed sources unless customers deposit excess funds. The amount received is expressed in the source's currency."; readonly type: "integer"; }; readonly amount_returned: { readonly description: "The total amount that was returned to the customer. The amount returned is expressed in the source's currency."; readonly type: "integer"; }; readonly refund_attributes_method: { readonly description: "Type of refund attribute method, one of `email`, `manual`, or `none`."; readonly maxLength: 5000; readonly type: "string"; }; readonly refund_attributes_status: { readonly description: "Type of refund attribute status, one of `missing`, `requested`, or `available`."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount_charged", "amount_received", "amount_returned", "refund_attributes_method", "refund_attributes_status"]; readonly title: "SourceReceiverFlow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_redirect_flowSchema: { readonly description: ""; readonly properties: { readonly failure_reason: { readonly description: "The failure reason for the redirect, either `user_abort` (the customer aborted or dropped out of the redirect flow), `declined` (the authentication failed or the transaction was declined), or `processing_error` (the redirect failed due to a technical error). Present only if the redirect status is `failed`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly return_url: { readonly description: "The URL you provide to redirect the customer to after they authenticated their payment."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "The status of the redirect, either `pending` (ready to be used by your customer to authenticate the transaction), `succeeded` (succesful authentication, cannot be reused) or `not_required` (redirect should not be used) or `failed` (failed authentication, cannot be reused)."; readonly maxLength: 5000; readonly type: "string"; }; readonly url: { readonly description: "The URL provided to you to redirect a customer to as part of a `redirect` authentication flow."; readonly maxLength: 2048; readonly type: "string"; }; }; readonly required: readonly ["return_url", "status", "url"]; readonly title: "SourceRedirectFlow"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_transactionSchema: { readonly description: "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions."; readonly properties: { readonly ach_credit_transfer: { readonly $ref: "#/components/schemas/source_transaction_ach_credit_transfer_data"; }; readonly amount: { readonly description: "A positive integer in the smallest currency unit (that is, 100 cents for $1.00, or 1 for ¥1, Japanese Yen being a zero-decimal currency) representing the amount your customer has pushed to the receiver."; readonly type: "integer"; }; readonly chf_credit_transfer: { readonly $ref: "#/components/schemas/source_transaction_chf_credit_transfer_data"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly gbp_credit_transfer: { readonly $ref: "#/components/schemas/source_transaction_gbp_credit_transfer_data"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["source_transaction"]; readonly type: "string"; }; readonly paper_check: { readonly $ref: "#/components/schemas/source_transaction_paper_check_data"; }; readonly sepa_credit_transfer: { readonly $ref: "#/components/schemas/source_transaction_sepa_credit_transfer_data"; }; readonly source: { readonly description: "The ID of the source this transaction is attached to."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "The status of the transaction, one of `succeeded`, `pending`, or `failed`."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "The type of source this transaction is attached to."; readonly enum: readonly ["ach_credit_transfer", "ach_debit", "alipay", "bancontact", "card", "card_present", "eps", "giropay", "ideal", "klarna", "multibanco", "p24", "sepa_debit", "sofort", "three_d_secure", "wechat"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "created", "currency", "id", "livemode", "object", "source", "status", "type"]; readonly title: "SourceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach_credit_transfer", "chf_credit_transfer", "gbp_credit_transfer", "paper_check", "sepa_credit_transfer"]; readonly 'x-resourceId': "source_transaction"; }; export declare const source_transaction_ach_credit_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly customer_data: { readonly description: "Customer data associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly fingerprint: { readonly description: "Bank account fingerprint associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "Last 4 digits of the account number associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceTransactionAchCreditTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_transaction_chf_credit_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "Reference associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_address_country: { readonly description: "Sender's country address."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_address_line1: { readonly description: "Sender's line 1 address."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_iban: { readonly description: "Sender's bank account IBAN."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_name: { readonly description: "Sender's name."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceTransactionChfCreditTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_transaction_gbp_credit_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly fingerprint: { readonly description: "Bank account fingerprint associated with the Stripe owned bank account receiving the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly funding_method: { readonly description: "The credit transfer rails the sender used to push this transfer. The possible rails are: Faster Payments, BACS, CHAPS, and wire transfers. Currently only Faster Payments is supported."; readonly maxLength: 5000; readonly type: "string"; }; readonly last4: { readonly description: "Last 4 digits of sender account number associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly reference: { readonly description: "Sender entered arbitrary information about the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_account_number: { readonly description: "Sender account number associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_name: { readonly description: "Sender name associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_sort_code: { readonly description: "Sender sort code associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceTransactionGbpCreditTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_transaction_paper_check_dataSchema: { readonly description: ""; readonly properties: { readonly available_at: { readonly description: "Time at which the deposited funds will be available for use. Measured in seconds since the Unix epoch."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoices: { readonly description: "Comma-separated list of invoice IDs associated with the paper check."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceTransactionPaperCheckData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_transaction_sepa_credit_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly reference: { readonly description: "Reference associated with the transfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_iban: { readonly description: "Sender's bank account IBAN."; readonly maxLength: 5000; readonly type: "string"; }; readonly sender_name: { readonly description: "Sender's name."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly title: "SourceTransactionSepaCreditTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const source_type_ach_credit_transferSchema: { readonly properties: { readonly account_number: { readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_name: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_type: { readonly nullable: true; readonly type: "string"; }; readonly refund_routing_number: { readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly nullable: true; readonly type: "string"; }; readonly swift_code: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_ach_debitSchema: { readonly properties: { readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly nullable: true; readonly type: "string"; }; readonly type: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_acss_debitSchema: { readonly properties: { readonly bank_address_city: { readonly nullable: true; readonly type: "string"; }; readonly bank_address_line_1: { readonly nullable: true; readonly type: "string"; }; readonly bank_address_line_2: { readonly nullable: true; readonly type: "string"; }; readonly bank_address_postal_code: { readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly category: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_alipaySchema: { readonly properties: { readonly data_string: { readonly nullable: true; readonly type: "string"; }; readonly native_url: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_au_becs_debitSchema: { readonly properties: { readonly bsb_number: { readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_bancontactSchema: { readonly properties: { readonly bank_code: { readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly nullable: true; readonly type: "string"; }; readonly iban_last4: { readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_cardSchema: { readonly properties: { readonly address_line1_check: { readonly nullable: true; readonly type: "string"; }; readonly address_zip_check: { readonly nullable: true; readonly type: "string"; }; readonly brand: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly cvc_check: { readonly nullable: true; readonly type: "string"; }; readonly dynamic_last4: { readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly nullable: true; readonly type: "integer"; }; readonly exp_year: { readonly nullable: true; readonly type: "integer"; }; readonly fingerprint: { readonly type: "string"; }; readonly funding: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly name: { readonly nullable: true; readonly type: "string"; }; readonly three_d_secure: { readonly type: "string"; }; readonly tokenization_method: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_card_presentSchema: { readonly properties: { readonly application_cryptogram: { readonly type: "string"; }; readonly application_preferred_name: { readonly type: "string"; }; readonly authorization_code: { readonly nullable: true; readonly type: "string"; }; readonly authorization_response_code: { readonly type: "string"; }; readonly brand: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly cvm_type: { readonly type: "string"; }; readonly data_type: { readonly nullable: true; readonly type: "string"; }; readonly dedicated_file_name: { readonly type: "string"; }; readonly emv_auth_data: { readonly type: "string"; }; readonly evidence_customer_signature: { readonly nullable: true; readonly type: "string"; }; readonly evidence_transaction_certificate: { readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly nullable: true; readonly type: "integer"; }; readonly exp_year: { readonly nullable: true; readonly type: "integer"; }; readonly fingerprint: { readonly type: "string"; }; readonly funding: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly pos_device_id: { readonly nullable: true; readonly type: "string"; }; readonly pos_entry_mode: { readonly type: "string"; }; readonly read_method: { readonly nullable: true; readonly type: "string"; }; readonly reader: { readonly nullable: true; readonly type: "string"; }; readonly terminal_verification_results: { readonly type: "string"; }; readonly transaction_status_information: { readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_epsSchema: { readonly properties: { readonly reference: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_giropaySchema: { readonly properties: { readonly bank_code: { readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_idealSchema: { readonly properties: { readonly bank: { readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly nullable: true; readonly type: "string"; }; readonly iban_last4: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_klarnaSchema: { readonly properties: { readonly background_image_url: { readonly type: "string"; }; readonly client_token: { readonly nullable: true; readonly type: "string"; }; readonly first_name: { readonly type: "string"; }; readonly last_name: { readonly type: "string"; }; readonly locale: { readonly type: "string"; }; readonly logo_url: { readonly type: "string"; }; readonly page_title: { readonly type: "string"; }; readonly pay_later_asset_urls_descriptive: { readonly type: "string"; }; readonly pay_later_asset_urls_standard: { readonly type: "string"; }; readonly pay_later_name: { readonly type: "string"; }; readonly pay_later_redirect_url: { readonly type: "string"; }; readonly pay_now_asset_urls_descriptive: { readonly type: "string"; }; readonly pay_now_asset_urls_standard: { readonly type: "string"; }; readonly pay_now_name: { readonly type: "string"; }; readonly pay_now_redirect_url: { readonly type: "string"; }; readonly pay_over_time_asset_urls_descriptive: { readonly type: "string"; }; readonly pay_over_time_asset_urls_standard: { readonly type: "string"; }; readonly pay_over_time_name: { readonly type: "string"; }; readonly pay_over_time_redirect_url: { readonly type: "string"; }; readonly payment_method_categories: { readonly type: "string"; }; readonly purchase_country: { readonly type: "string"; }; readonly purchase_type: { readonly type: "string"; }; readonly redirect_url: { readonly type: "string"; }; readonly shipping_delay: { readonly type: "integer"; }; readonly shipping_first_name: { readonly type: "string"; }; readonly shipping_last_name: { readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_multibancoSchema: { readonly properties: { readonly entity: { readonly nullable: true; readonly type: "string"; }; readonly reference: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_city: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_country: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_line1: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_line2: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_postal_code: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_address_state: { readonly nullable: true; readonly type: "string"; }; readonly refund_account_holder_name: { readonly nullable: true; readonly type: "string"; }; readonly refund_iban: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_p24Schema: { readonly properties: { readonly reference: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_sepa_debitSchema: { readonly properties: { readonly bank_code: { readonly nullable: true; readonly type: "string"; }; readonly branch_code: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly fingerprint: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly mandate_reference: { readonly nullable: true; readonly type: "string"; }; readonly mandate_url: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_sofortSchema: { readonly properties: { readonly bank_code: { readonly nullable: true; readonly type: "string"; }; readonly bank_name: { readonly nullable: true; readonly type: "string"; }; readonly bic: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly iban_last4: { readonly nullable: true; readonly type: "string"; }; readonly preferred_language: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_three_d_secureSchema: { readonly properties: { readonly address_line1_check: { readonly nullable: true; readonly type: "string"; }; readonly address_zip_check: { readonly nullable: true; readonly type: "string"; }; readonly authenticated: { readonly nullable: true; readonly type: "boolean"; }; readonly brand: { readonly nullable: true; readonly type: "string"; }; readonly card: { readonly nullable: true; readonly type: "string"; }; readonly country: { readonly nullable: true; readonly type: "string"; }; readonly customer: { readonly nullable: true; readonly type: "string"; }; readonly cvc_check: { readonly nullable: true; readonly type: "string"; }; readonly dynamic_last4: { readonly nullable: true; readonly type: "string"; }; readonly exp_month: { readonly nullable: true; readonly type: "integer"; }; readonly exp_year: { readonly nullable: true; readonly type: "integer"; }; readonly fingerprint: { readonly type: "string"; }; readonly funding: { readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly nullable: true; readonly type: "string"; }; readonly name: { readonly nullable: true; readonly type: "string"; }; readonly three_d_secure: { readonly type: "string"; }; readonly tokenization_method: { readonly nullable: true; readonly type: "string"; }; }; readonly type: "object"; }; export declare const source_type_wechatSchema: { readonly properties: { readonly prepay_id: { readonly type: "string"; }; readonly qr_code_url: { readonly nullable: true; readonly type: "string"; }; readonly statement_descriptor: { readonly type: "string"; }; }; readonly type: "object"; }; export declare const subscriptionSchema: { readonly description: "Subscriptions allow you to charge a customer on a recurring basis.\n\nRelated guide: [Creating subscriptions](https://stripe.com/docs/billing/subscriptions/creating)"; readonly properties: { readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "ID of the Connect Application that created the subscription."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly application_fee_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account."; readonly nullable: true; readonly type: "number"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/subscription_automatic_tax"; }; readonly billing_cycle_anchor: { readonly description: "The reference point that aligns future [billing cycle](https://stripe.com/docs/subscriptions/billing-cycle) dates. It sets the day of week for `week` intervals, the day of month for `month` and `year` intervals, and the month of year for `year` intervals. The timestamp is in UTC format."; readonly format: "unix-time"; readonly type: "integer"; }; readonly billing_cycle_anchor_config: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_resource_billing_cycle_anchor_config"; }]; readonly description: "The fixed values used to calculate the `billing_cycle_anchor`."; readonly nullable: true; }; readonly billing_thresholds: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_billing_thresholds"; }]; readonly description: "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"; readonly nullable: true; }; readonly cancel_at: { readonly description: "A date in the future at which the subscription will automatically get canceled"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancel_at_period_end: { readonly description: "If the subscription has been canceled with the `at_period_end` flag set to `true`, `cancel_at_period_end` on the subscription will be true. You can use this attribute to determine whether a subscription that has a status of active is scheduled to be canceled at the end of the current period."; readonly type: "boolean"; }; readonly canceled_at: { readonly description: "If the subscription has been canceled, the date of that cancellation. If the subscription was canceled with `cancel_at_period_end`, `canceled_at` will reflect the time of the most recent update request, not the end of the subscription period when the subscription is automatically moved to a canceled state."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly cancellation_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/cancellation_details"; }]; readonly description: "Details about why this subscription was cancelled"; readonly nullable: true; }; readonly collection_method: { readonly description: "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."; readonly enum: readonly ["charge_automatically", "send_invoice"]; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly current_period_end: { readonly description: "End of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created."; readonly format: "unix-time"; readonly type: "integer"; }; readonly current_period_start: { readonly description: "Start of the current period that the subscription has been invoiced for."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the customer who owns the subscription."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly days_until_due: { readonly description: "Number of days a customer has to pay invoices generated by this subscription. This value will be `null` for subscriptions where `collection_method=charge_automatically`."; readonly nullable: true; readonly type: "integer"; }; readonly default_payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over `default_source`. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly default_source: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; readonly description: "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source)."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/bank_account"; }, { readonly $ref: "#/components/schemas/card"; }, { readonly $ref: "#/components/schemas/source"; }]; }; readonly 'x-stripeBypassValidation': true; }; readonly default_tax_rates: { readonly description: "The tax rates that will apply to any subscription item that does not have `tax_rates` set. Invoices created will have their `default_tax_rates` populated from the subscription."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; readonly description: { readonly description: "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."; readonly maxLength: 500; readonly nullable: true; readonly type: "string"; }; readonly discount: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; readonly description: "Describes the current discount applied to this subscription, if there is one. When billing, a discount applied to a subscription overrides a discount applied on a customer-wide basis. This field has been deprecated and will be removed in a future API version. Use `discounts` instead."; readonly nullable: true; }; readonly discounts: { readonly description: "The discounts applied to the subscription. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly type: "array"; }; readonly ended_at: { readonly description: "If the subscription has ended, the date the subscription ended."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice_settings: { readonly $ref: "#/components/schemas/subscriptions_resource_subscription_invoice_settings"; }; readonly items: { readonly description: "List of subscription items, each with an attached price."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/subscription_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "SubscriptionItemList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly latest_invoice: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/invoice"; }]; readonly description: "The most recent invoice this subscription has generated."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/invoice"; }]; }; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly next_pending_invoice_item_invoice: { readonly description: "Specifies the approximate timestamp on which any pending invoice items will be billed according to the schedule provided at `pending_invoice_item_interval`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["subscription"]; readonly type: "string"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) the charge was made on behalf of for charges associated with this subscription. See the Connect documentation for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly pause_collection: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_resource_pause_collection"; }]; readonly description: "If specified, payment collection for this subscription will be paused. Note that the subscription status will be unchanged and will not be updated to `paused`. Learn more about [pausing collection](/billing/subscriptions/pause-payment)."; readonly nullable: true; }; readonly payment_settings: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_resource_payment_settings"; }]; readonly description: "Payment settings passed on to invoices created by the subscription."; readonly nullable: true; }; readonly pending_invoice_item_interval: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_pending_invoice_item_interval"; }]; readonly description: "Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling [Create an invoice](https://stripe.com/docs/api#create_invoice) for the given subscription at the specified interval."; readonly nullable: true; }; readonly pending_setup_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_intent"; }]; readonly description: "You can use this [SetupIntent](https://stripe.com/docs/api/setup_intents) to collect user authentication when creating a subscription without immediate payment or updating a subscription's payment method, allowing you to optimize for off-session payments. Learn more in the [SCA Migration Guide](https://stripe.com/docs/billing/migration/strong-customer-authentication#scenario-2)."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent"; }]; }; }; readonly pending_update: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_resource_pending_update"; }]; readonly description: "If specified, [pending updates](https://stripe.com/docs/billing/subscriptions/pending-updates) that will be applied to the subscription once the `latest_invoice` has been paid."; readonly nullable: true; }; readonly schedule: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription_schedule"; }]; readonly description: "The schedule attached to the subscription"; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription_schedule"; }]; }; }; readonly start_date: { readonly description: "Date when the subscription was first created. The date might differ from the `created` date due to backdating."; readonly format: "unix-time"; readonly type: "integer"; }; readonly status: { readonly description: "Possible values are `incomplete`, `incomplete_expired`, `trialing`, `active`, `past_due`, `canceled`, `unpaid`, or `paused`. \n\nFor `collection_method=charge_automatically` a subscription moves into `incomplete` if the initial payment attempt fails. A subscription in this status can only have metadata and default_source updated. Once the first invoice is paid, the subscription moves into an `active` status. If the first invoice is not paid within 23 hours, the subscription transitions to `incomplete_expired`. This is a terminal status, the open invoice will be voided and no further invoices will be generated. \n\nA subscription that is currently in a trial period is `trialing` and moves to `active` when the trial period is over. \n\nA subscription can only enter a `paused` status [when a trial ends without a payment method](/billing/subscriptions/trials#create-free-trials-without-payment). A `paused` subscription doesn't generate invoices and can be resumed after your customer adds their payment method. The `paused` status is different from [pausing collection](/billing/subscriptions/pause-payment), which still generates invoices and leaves the subscription's status unchanged. \n\nIf subscription `collection_method=charge_automatically`, it becomes `past_due` when payment is required but cannot be paid (due to failed payment or awaiting additional user actions). Once Stripe has exhausted all payment retry attempts, the subscription will become `canceled` or `unpaid` (depending on your subscriptions settings). \n\nIf subscription `collection_method=send_invoice` it becomes `past_due` when its invoice is not paid by the due date, and `canceled` or `unpaid` if it is still not paid by an additional deadline after that. Note that when a subscription has a status of `unpaid`, no subsequent invoices will be attempted (invoices will be created, but then immediately automatically closed). After receiving updated payment information from a customer, you may choose to reopen and pay their closed invoices."; readonly enum: readonly ["active", "canceled", "incomplete", "incomplete_expired", "past_due", "paused", "trialing", "unpaid"]; readonly type: "string"; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock this subscription belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_transfer_data"; }]; readonly description: "The account (if any) the subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."; readonly nullable: true; }; readonly trial_end: { readonly description: "If the subscription has a trial, the end of that trial."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly trial_settings: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_trials_resource_trial_settings"; }]; readonly description: "Settings related to subscription trials."; readonly nullable: true; }; readonly trial_start: { readonly description: "If the subscription has a trial, the beginning of that trial."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["automatic_tax", "billing_cycle_anchor", "cancel_at_period_end", "collection_method", "created", "currency", "current_period_end", "current_period_start", "customer", "discounts", "id", "invoice_settings", "items", "livemode", "metadata", "object", "start_date", "status"]; readonly title: "Subscription"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "automatic_tax", "billing_cycle_anchor_config", "billing_thresholds", "cancellation_details", "customer", "default_payment_method", "default_source", "default_tax_rates", "discount", "discounts", "invoice_settings", "items", "latest_invoice", "on_behalf_of", "pause_collection", "payment_settings", "pending_invoice_item_interval", "pending_setup_intent", "pending_update", "schedule", "test_clock", "transfer_data", "trial_settings"]; readonly 'x-resourceId': "subscription"; }; export declare const subscription_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether Stripe automatically computes tax on this subscription."; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "SubscriptionAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const subscription_billing_thresholdsSchema: { readonly description: ""; readonly properties: { readonly amount_gte: { readonly description: "Monetary threshold that triggers the subscription to create an invoice"; readonly nullable: true; readonly type: "integer"; }; readonly reset_billing_cycle_anchor: { readonly description: "Indicates if the `billing_cycle_anchor` should be reset when a threshold is reached. If true, `billing_cycle_anchor` will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged. This value may not be `true` if the subscription contains items with plans that have `aggregate_usage=last_ever`."; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "SubscriptionBillingThresholds"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscription_details_dataSchema: { readonly description: ""; readonly properties: { readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/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.*"; readonly nullable: true; readonly type: "object"; }; }; readonly title: "SubscriptionDetailsData"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscription_itemSchema: { readonly description: "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships."; readonly properties: { readonly billing_thresholds: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_item_billing_thresholds"; }]; readonly description: "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period"; readonly nullable: true; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly type: "integer"; }; readonly discounts: { readonly description: "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/discount"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/discount"; }]; }; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["subscription_item"]; readonly type: "string"; }; readonly price: { readonly $ref: "#/components/schemas/price"; }; readonly quantity: { readonly description: "The [quantity](https://stripe.com/docs/subscriptions/quantities) of the plan to which the customer should be subscribed."; readonly type: "integer"; }; readonly subscription: { readonly description: "The `subscription` this `subscription_item` belongs to."; readonly maxLength: 5000; readonly type: "string"; }; readonly tax_rates: { readonly description: "The tax rates which apply to this `subscription_item`. When set, the `default_tax_rates` on the subscription do not apply to this `subscription_item`."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; }; readonly required: readonly ["created", "discounts", "id", "metadata", "object", "price", "subscription"]; readonly title: "SubscriptionItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_thresholds", "discounts", "price", "tax_rates"]; readonly 'x-resourceId': "subscription_item"; }; export declare const subscription_item_billing_thresholdsSchema: { readonly description: ""; readonly properties: { readonly usage_gte: { readonly description: "Usage threshold that triggers the subscription to create an invoice"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "SubscriptionItemBillingThresholds"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscription_payment_method_options_cardSchema: { readonly description: ""; readonly properties: { readonly mandate_options: { readonly $ref: "#/components/schemas/invoice_mandate_options_card"; }; readonly network: { readonly description: "Selected network to process this Subscription on. Depends on the available networks of the card attached to the Subscription. Can be only set confirm-time."; readonly enum: readonly ["amex", "cartes_bancaires", "diners", "discover", "eftpos_au", "interac", "jcb", "mastercard", "unionpay", "unknown", "visa"]; readonly nullable: true; readonly type: "string"; }; readonly request_three_d_secure: { readonly description: "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure/authentication-flow#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine."; readonly enum: readonly ["any", "automatic", "challenge"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "subscription_payment_method_options_card"; readonly type: "object"; readonly 'x-expandableFields': readonly ["mandate_options"]; }; export declare const subscription_pending_invoice_item_intervalSchema: { readonly description: ""; readonly properties: { readonly interval: { readonly description: "Specifies invoicing frequency. Either `day`, `week`, `month` or `year`."; readonly enum: readonly ["day", "month", "week", "year"]; readonly type: "string"; }; readonly interval_count: { readonly description: "The number of intervals between invoices. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks)."; readonly type: "integer"; }; }; readonly required: readonly ["interval", "interval_count"]; readonly title: "SubscriptionPendingInvoiceItemInterval"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscription_scheduleSchema: { readonly description: "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)"; readonly properties: { readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; readonly description: "ID of the Connect Application that created the schedule."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }, { readonly $ref: "#/components/schemas/deleted_application"; }]; }; }; readonly canceled_at: { readonly description: "Time at which the subscription schedule was canceled. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly completed_at: { readonly description: "Time at which the subscription schedule was completed. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly current_phase: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_schedule_current_phase"; }]; readonly description: "Object representing the start and end dates for the current phase of the subscription schedule, if it is `active`."; readonly nullable: true; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; readonly description: "ID of the customer who owns the subscription schedule."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }, { readonly $ref: "#/components/schemas/deleted_customer"; }]; }; }; readonly default_settings: { readonly $ref: "#/components/schemas/subscription_schedules_resource_default_settings"; }; readonly end_behavior: { readonly description: "Behavior of the subscription schedule and underlying subscription when it ends. Possible values are `release` or `cancel` with the default being `release`. `release` will end the subscription schedule and keep the underlying subscription running. `cancel` will end the subscription schedule and cancel the underlying subscription."; readonly enum: readonly ["cancel", "none", "release", "renew"]; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["subscription_schedule"]; readonly type: "string"; }; readonly phases: { readonly description: "Configuration for the subscription schedule's phases."; readonly items: { readonly $ref: "#/components/schemas/subscription_schedule_phase_configuration"; }; readonly type: "array"; }; readonly released_at: { readonly description: "Time at which the subscription schedule was released. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly released_subscription: { readonly description: "ID of the subscription once managed by the subscription schedule (if it is released)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "The present status of the subscription schedule. Possible values are `not_started`, `active`, `completed`, `released`, and `canceled`. You can read more about the different states in our [behavior guide](https://stripe.com/docs/billing/subscriptions/subscription-schedules)."; readonly enum: readonly ["active", "canceled", "completed", "not_started", "released"]; readonly type: "string"; }; readonly subscription: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/subscription"; }]; readonly description: "ID of the subscription managed by the subscription schedule."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/subscription"; }]; }; }; readonly test_clock: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; readonly description: "ID of the test clock this subscription schedule belongs to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/test_helpers.test_clock"; }]; }; }; }; readonly required: readonly ["created", "customer", "default_settings", "end_behavior", "id", "livemode", "object", "phases", "status"]; readonly title: "SubscriptionSchedule"; readonly type: "object"; readonly 'x-expandableFields': readonly ["application", "current_phase", "customer", "default_settings", "phases", "subscription", "test_clock"]; readonly 'x-resourceId': "subscription_schedule"; }; export declare const subscription_schedule_add_invoice_itemSchema: { readonly description: "An Add Invoice Item describes the prices and quantities that will be added as pending invoice items when entering a phase."; readonly properties: { readonly discounts: { readonly description: "The stackable discounts that will be applied to the item."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_stackable_discount"; }; readonly type: "array"; }; readonly price: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/price"; }, { readonly $ref: "#/components/schemas/deleted_price"; }]; readonly description: "ID of the price used to generate the invoice item."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/price"; }, { readonly $ref: "#/components/schemas/deleted_price"; }]; }; }; readonly quantity: { readonly description: "The quantity of the invoice item."; readonly nullable: true; readonly type: "integer"; }; readonly tax_rates: { readonly description: "The tax rates which apply to the item. When set, the `default_tax_rates` do not apply to this item."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; }; readonly required: readonly ["discounts", "price"]; readonly title: "SubscriptionScheduleAddInvoiceItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["discounts", "price", "tax_rates"]; }; export declare const subscription_schedule_configuration_itemSchema: { readonly description: "A phase item describes the price and quantity of a phase."; readonly properties: { readonly billing_thresholds: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_item_billing_thresholds"; }]; readonly description: "Define thresholds at which an invoice will be sent, and the related subscription advanced to a new billing period"; readonly nullable: true; }; readonly discounts: { readonly description: "The discounts applied to the subscription item. Subscription item discounts are applied before subscription discounts. Use `expand[]=discounts` to expand each discount."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_stackable_discount"; }; readonly type: "array"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an item. Metadata on this item will update the underlying subscription item's `metadata` when the phase is entered."; readonly nullable: true; readonly type: "object"; }; readonly price: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/price"; }, { readonly $ref: "#/components/schemas/deleted_price"; }]; readonly description: "ID of the price to which the customer should be subscribed."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/price"; }, { readonly $ref: "#/components/schemas/deleted_price"; }]; }; }; readonly quantity: { readonly description: "Quantity of the plan to which the customer should be subscribed."; readonly type: "integer"; }; readonly tax_rates: { readonly description: "The tax rates which apply to this `phase_item`. When set, the `default_tax_rates` on the phase do not apply to this `phase_item`."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; }; readonly required: readonly ["discounts", "price"]; readonly title: "SubscriptionScheduleConfigurationItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_thresholds", "discounts", "price", "tax_rates"]; }; export declare const subscription_schedule_current_phaseSchema: { readonly description: ""; readonly properties: { readonly end_date: { readonly description: "The end of this phase of the subscription schedule."; readonly format: "unix-time"; readonly type: "integer"; }; readonly start_date: { readonly description: "The start of this phase of the subscription schedule."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["end_date", "start_date"]; readonly title: "SubscriptionScheduleCurrentPhase"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscription_schedule_phase_configurationSchema: { readonly description: "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period."; readonly properties: { readonly add_invoice_items: { readonly description: "A list of prices and quantities that will generate invoice items appended to the next invoice for this phase."; readonly items: { readonly $ref: "#/components/schemas/subscription_schedule_add_invoice_item"; }; readonly type: "array"; }; readonly application_fee_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule."; readonly nullable: true; readonly type: "number"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/schedules_phase_automatic_tax"; }; readonly billing_cycle_anchor: { readonly description: "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle)."; readonly enum: readonly ["automatic", "phase_start"]; readonly nullable: true; readonly type: "string"; }; readonly billing_thresholds: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_billing_thresholds"; }]; readonly description: "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"; readonly nullable: true; }; readonly collection_method: { readonly description: "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."; readonly enum: readonly ["charge_automatically", "send_invoice"]; readonly nullable: true; readonly type: "string"; }; readonly coupon: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/coupon"; }, { readonly $ref: "#/components/schemas/deleted_coupon"; }]; readonly description: "ID of the coupon to use during this phase of the subscription schedule."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/coupon"; }, { readonly $ref: "#/components/schemas/deleted_coupon"; }]; }; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly default_payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the default payment method for the subscription schedule. It must belong to the customer associated with the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly default_tax_rates: { readonly description: "The default tax rates to apply to the subscription during this phase of the subscription schedule."; readonly items: { readonly $ref: "#/components/schemas/tax_rate"; }; readonly nullable: true; readonly type: "array"; }; readonly description: { readonly description: "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly discounts: { readonly description: "The stackable discounts that will be applied to the subscription on this phase. Subscription item discounts are applied before subscription discounts."; readonly items: { readonly $ref: "#/components/schemas/discounts_resource_stackable_discount"; }; readonly type: "array"; }; readonly end_date: { readonly description: "The end of this phase of the subscription schedule."; readonly format: "unix-time"; readonly type: "integer"; }; readonly invoice_settings: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_setting_subscription_schedule_phase_setting"; }]; readonly description: "The invoice settings applicable during this phase."; readonly nullable: true; }; readonly items: { readonly description: "Subscription items to configure the subscription to during this phase of the subscription schedule."; readonly items: { readonly $ref: "#/components/schemas/subscription_schedule_configuration_item"; }; readonly type: "array"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to a phase. Metadata on a schedule's phase will update the underlying subscription's `metadata` when the phase is entered. Updating the underlying subscription's `metadata` directly will not affect the current phase's `metadata`."; readonly nullable: true; readonly type: "object"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly proration_behavior: { readonly description: "If the subscription schedule will prorate when transitioning to this phase. Possible values are `create_prorations` and `none`."; readonly enum: readonly ["always_invoice", "create_prorations", "none"]; readonly type: "string"; }; readonly start_date: { readonly description: "The start of this phase of the subscription schedule."; readonly format: "unix-time"; readonly type: "integer"; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_transfer_data"; }]; readonly description: "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."; readonly nullable: true; }; readonly trial_end: { readonly description: "When the trial ends within the phase."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["add_invoice_items", "currency", "discounts", "end_date", "items", "proration_behavior", "start_date"]; readonly title: "SubscriptionSchedulePhaseConfiguration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["add_invoice_items", "automatic_tax", "billing_thresholds", "coupon", "default_payment_method", "default_tax_rates", "discounts", "invoice_settings", "items", "on_behalf_of", "transfer_data"]; }; export declare const subscription_schedules_resource_default_settingsSchema: { readonly description: ""; readonly properties: { readonly application_fee_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account during this phase of the schedule."; readonly nullable: true; readonly type: "number"; }; readonly automatic_tax: { readonly $ref: "#/components/schemas/subscription_schedules_resource_default_settings_automatic_tax"; }; readonly billing_cycle_anchor: { readonly description: "Possible values are `phase_start` or `automatic`. If `phase_start` then billing cycle anchor of the subscription is set to the start of the phase when entering the phase. If `automatic` then the billing cycle anchor is automatically modified as needed when entering the phase. For more information, see the billing cycle [documentation](https://stripe.com/docs/billing/subscriptions/billing-cycle)."; readonly enum: readonly ["automatic", "phase_start"]; readonly type: "string"; }; readonly billing_thresholds: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_billing_thresholds"; }]; readonly description: "Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period"; readonly nullable: true; }; readonly collection_method: { readonly description: "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay the underlying subscription at the end of each billing cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions and mark the subscription as `active`."; readonly enum: readonly ["charge_automatically", "send_invoice"]; readonly nullable: true; readonly type: "string"; }; readonly default_payment_method: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_method"; }]; readonly description: "ID of the default payment method for the subscription schedule. If not set, invoices will use the default payment method in the customer's invoice settings."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_method"; }]; }; }; readonly description: { readonly description: "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly invoice_settings: { readonly $ref: "#/components/schemas/invoice_setting_subscription_schedule_setting"; }; readonly on_behalf_of: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) the charge was made on behalf of for charges associated with the schedule's subscription. See the Connect documentation for details."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly transfer_data: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_transfer_data"; }]; readonly description: "The account (if any) the associated subscription's payments will be attributed to for tax reporting, and where funds from each payment will be transferred to for each of the subscription's invoices."; readonly nullable: true; }; }; readonly required: readonly ["billing_cycle_anchor", "invoice_settings"]; readonly title: "SubscriptionSchedulesResourceDefaultSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["automatic_tax", "billing_thresholds", "default_payment_method", "invoice_settings", "on_behalf_of", "transfer_data"]; }; export declare const subscription_schedules_resource_default_settings_automatic_taxSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Whether Stripe automatically computes tax on invoices created during this phase."; readonly type: "boolean"; }; readonly liability: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/connect_account_reference"; }]; readonly description: "The account that's liable for tax. If set, the business address and tax registrations required to perform the tax calculation are loaded from this account. The tax transaction is returned in the report of the connected account."; readonly nullable: true; }; }; readonly required: readonly ["enabled"]; readonly title: "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax"; readonly type: "object"; readonly 'x-expandableFields': readonly ["liability"]; }; export declare const subscription_transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount_percent: { readonly description: "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice total that will be transferred to the destination account. By default, the entire amount is transferred to the destination."; readonly nullable: true; readonly type: "number"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account where funds from the payment will be transferred to upon payment success."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "SubscriptionTransferData"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const subscriptions_resource_billing_cycle_anchor_configSchema: { readonly description: ""; readonly properties: { readonly day_of_month: { readonly description: "The day of the month of the billing_cycle_anchor."; readonly type: "integer"; }; readonly hour: { readonly description: "The hour of the day of the billing_cycle_anchor."; readonly nullable: true; readonly type: "integer"; }; readonly minute: { readonly description: "The minute of the hour of the billing_cycle_anchor."; readonly nullable: true; readonly type: "integer"; }; readonly month: { readonly description: "The month to start full cycle billing periods."; readonly nullable: true; readonly type: "integer"; }; readonly second: { readonly description: "The second of the minute of the billing_cycle_anchor."; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["day_of_month"]; readonly title: "SubscriptionsResourceBillingCycleAnchorConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscriptions_resource_pause_collectionSchema: { readonly description: "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused."; readonly properties: { readonly behavior: { readonly description: "The payment collection behavior for this subscription while paused. One of `keep_as_draft`, `mark_uncollectible`, or `void`."; readonly enum: readonly ["keep_as_draft", "mark_uncollectible", "void"]; readonly type: "string"; }; readonly resumes_at: { readonly description: "The time after which the subscription will resume collecting payments."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly required: readonly ["behavior"]; readonly title: "SubscriptionsResourcePauseCollection"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscriptions_resource_payment_method_optionsSchema: { readonly description: ""; readonly properties: { readonly acss_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_acss_debit"; }]; readonly description: "This sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly bancontact: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_bancontact"; }]; readonly description: "This sub-hash contains details about the Bancontact payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly card: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscription_payment_method_options_card"; }]; readonly description: "This sub-hash contains details about the Card payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly customer_balance: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_customer_balance"; }]; readonly description: "This sub-hash contains details about the Bank transfer payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly konbini: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_konbini"; }]; readonly description: "This sub-hash contains details about the Konbini payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly sepa_debit: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_sepa_debit"; }]; readonly description: "This sub-hash contains details about the SEPA Direct Debit payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; readonly us_bank_account: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/invoice_payment_method_options_us_bank_account"; }]; readonly description: "This sub-hash contains details about the ACH direct debit payment method options to pass to invoices created by the subscription."; readonly nullable: true; }; }; readonly title: "SubscriptionsResourcePaymentMethodOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["acss_debit", "bancontact", "card", "customer_balance", "konbini", "sepa_debit", "us_bank_account"]; }; export declare const subscriptions_resource_payment_settingsSchema: { readonly description: ""; readonly properties: { readonly payment_method_options: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/subscriptions_resource_payment_method_options"; }]; readonly description: "Payment-method-specific configuration to provide to invoices created by the subscription."; readonly nullable: true; }; readonly payment_method_types: { readonly description: "The list of payment method types to provide to every invoice created by the subscription. If not set, Stripe attempts to automatically determine the types to use by looking at the invoice’s default payment method, the subscription’s default payment method, the customer’s default payment method, and your [invoice template settings](https://dashboard.stripe.com/settings/billing/invoice)."; readonly items: { readonly enum: readonly ["ach_credit_transfer", "ach_debit", "acss_debit", "amazon_pay", "au_becs_debit", "bacs_debit", "bancontact", "boleto", "card", "cashapp", "customer_balance", "eps", "fpx", "giropay", "grabpay", "ideal", "konbini", "link", "p24", "paynow", "paypal", "promptpay", "revolut_pay", "sepa_debit", "sofort", "swish", "us_bank_account", "wechat_pay"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly nullable: true; readonly type: "array"; }; readonly save_default_payment_method: { readonly description: "Either `off`, or `on_subscription`. With `on_subscription` Stripe updates `subscription.default_payment_method` when a subscription payment succeeds."; readonly enum: readonly ["off", "on_subscription"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "SubscriptionsResourcePaymentSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_method_options"]; }; export declare const subscriptions_resource_pending_updateSchema: { readonly description: "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment."; readonly properties: { readonly billing_cycle_anchor: { readonly description: "If the update is applied, determines the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices. The timestamp is in UTC format."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly expires_at: { readonly description: "The point after which the changes reflected by this update will be discarded and no longer applied."; readonly format: "unix-time"; readonly type: "integer"; }; readonly subscription_items: { readonly description: "List of subscription items, each with an attached plan, that will be set if the update is applied."; readonly items: { readonly $ref: "#/components/schemas/subscription_item"; }; readonly nullable: true; readonly type: "array"; }; readonly trial_end: { readonly description: "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time, if the update is applied."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly trial_from_plan: { readonly description: "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed. See [Using trial periods on subscriptions](https://stripe.com/docs/billing/subscriptions/trials) to learn more."; readonly nullable: true; readonly type: "boolean"; }; }; readonly required: readonly ["expires_at"]; readonly title: "SubscriptionsResourcePendingUpdate"; readonly type: "object"; readonly 'x-expandableFields': readonly ["subscription_items"]; }; export declare const subscriptions_resource_subscription_invoice_settingsSchema: { readonly description: ""; readonly properties: { readonly account_tax_ids: { readonly description: "The account tax IDs associated with the subscription. Will be set on invoices generated by the subscription."; readonly items: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/tax_id"; }, { readonly $ref: "#/components/schemas/deleted_tax_id"; }]; }; }; readonly nullable: true; readonly type: "array"; }; readonly issuer: { readonly $ref: "#/components/schemas/connect_account_reference"; }; }; readonly required: readonly ["issuer"]; readonly title: "SubscriptionsResourceSubscriptionInvoiceSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account_tax_ids", "issuer"]; }; export declare const subscriptions_trials_resource_end_behaviorSchema: { readonly description: "Defines how a subscription behaves when a free trial ends."; readonly properties: { readonly missing_payment_method: { readonly description: "Indicates how the subscription should change when the trial ends if the user did not provide a payment method."; readonly enum: readonly ["cancel", "create_invoice", "pause"]; readonly type: "string"; }; }; readonly required: readonly ["missing_payment_method"]; readonly title: "SubscriptionsTrialsResourceEndBehavior"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const subscriptions_trials_resource_trial_settingsSchema: { readonly description: "Configures how this subscription behaves during the trial period."; readonly properties: { readonly end_behavior: { readonly $ref: "#/components/schemas/subscriptions_trials_resource_end_behavior"; }; }; readonly required: readonly ["end_behavior"]; readonly title: "SubscriptionsTrialsResourceTrialSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["end_behavior"]; }; export declare const tax_calculationSchema: { readonly description: "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)"; readonly properties: { readonly amount_total: { readonly description: "Total after taxes."; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly customer: { readonly description: "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_details: { readonly $ref: "#/components/schemas/tax_product_resource_customer_details"; }; readonly expires_at: { readonly description: "Timestamp of date at which the tax calculation will expire."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the calculation."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line_items: { readonly description: "The list of items the customer is purchasing."; readonly nullable: true; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/tax.calculation_line_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly pattern: "^/v1/tax/calculations/[^/]+/line_items"; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "TaxProductResourceTaxCalculationLineItemList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.calculation"]; readonly type: "string"; }; readonly ship_from_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_ship_from_details"; }]; readonly description: "The details of the ship from location, such as the address."; readonly nullable: true; }; readonly shipping_cost: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_tax_calculation_shipping_cost"; }]; readonly description: "The shipping cost details for the calculation."; readonly nullable: true; }; readonly tax_amount_exclusive: { readonly description: "The amount of tax to be collected on top of the line item prices."; readonly type: "integer"; }; readonly tax_amount_inclusive: { readonly description: "The amount of tax already included in the line item prices."; readonly type: "integer"; }; readonly tax_breakdown: { readonly description: "Breakdown of individual tax amounts that add up to the total."; readonly items: { readonly $ref: "#/components/schemas/tax_product_resource_tax_breakdown"; }; readonly type: "array"; }; readonly tax_date: { readonly description: "Timestamp of date at which the tax rules and rates in effect applies for the calculation."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["amount_total", "currency", "customer_details", "livemode", "object", "tax_amount_exclusive", "tax_amount_inclusive", "tax_breakdown", "tax_date"]; readonly title: "TaxProductResourceTaxCalculation"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_details", "line_items", "ship_from_details", "shipping_cost", "tax_breakdown"]; readonly 'x-resourceId': "tax.calculation"; }; export declare const tax_calculation_line_itemSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.calculation_line_item"]; readonly type: "string"; }; readonly product: { readonly description: "The ID of an existing [Product](https://stripe.com/docs/api/products/object)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly quantity: { readonly description: "The number of units of the item being purchased. For reversals, this is the quantity reversed."; readonly type: "integer"; }; readonly reference: { readonly description: "A custom identifier for this line item."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_behavior: { readonly description: "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."; readonly enum: readonly ["exclusive", "inclusive"]; readonly type: "string"; }; readonly tax_breakdown: { readonly description: "Detailed account of taxes relevant to this line item."; readonly items: { readonly $ref: "#/components/schemas/tax_product_resource_line_item_tax_breakdown"; }; readonly nullable: true; readonly type: "array"; }; readonly tax_code: { readonly description: "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_tax", "id", "livemode", "object", "quantity", "tax_behavior", "tax_code"]; readonly title: "TaxProductResourceTaxCalculationLineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tax_breakdown"]; readonly 'x-resourceId': "tax.calculation_line_item"; }; export declare const tax_registrationSchema: { readonly description: "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)"; readonly properties: { readonly active_from: { readonly description: "Time at which the registration becomes active. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly country_options: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly expires_at: { readonly description: "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.registration"]; readonly type: "string"; }; readonly status: { readonly description: "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`."; readonly enum: readonly ["active", "expired", "scheduled"]; readonly type: "string"; }; }; readonly required: readonly ["active_from", "country", "country_options", "created", "id", "livemode", "object", "status"]; readonly title: "TaxProductRegistrationsResourceTaxRegistration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["country_options"]; readonly 'x-resourceId': "tax.registration"; }; export declare const tax_settingsSchema: { readonly description: "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)"; readonly properties: { readonly defaults: { readonly $ref: "#/components/schemas/tax_product_resource_tax_settings_defaults"; }; readonly head_office: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_tax_settings_head_office"; }]; readonly description: "The place where your business is located."; readonly nullable: true; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.settings"]; readonly type: "string"; }; readonly status: { readonly description: "The `active` status indicates you have all required settings to calculate tax. A status can transition out of `active` when new required settings are introduced."; readonly enum: readonly ["active", "pending"]; readonly type: "string"; }; readonly status_details: { readonly $ref: "#/components/schemas/tax_product_resource_tax_settings_status_details"; }; }; readonly required: readonly ["defaults", "livemode", "object", "status", "status_details"]; readonly title: "TaxProductResourceTaxSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["defaults", "head_office", "status_details"]; readonly 'x-resourceId': "tax.settings"; }; export declare const tax_transactionSchema: { readonly description: "A Tax Transaction records the tax collected from or refunded to your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom#tax-transaction)"; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly customer: { readonly description: "The ID of an existing [Customer](https://stripe.com/docs/api/customers/object) used for the resource."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly customer_details: { readonly $ref: "#/components/schemas/tax_product_resource_customer_details"; }; readonly id: { readonly description: "Unique identifier for the transaction."; readonly maxLength: 5000; readonly type: "string"; }; readonly line_items: { readonly description: "The tax collected or refunded, by line item."; readonly nullable: true; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/tax.transaction_line_item"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly pattern: "^/v1/tax/transactions/[^/]+/line_items"; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "TaxProductResourceTaxTransactionLineItemList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.transaction"]; readonly type: "string"; }; readonly reference: { readonly description: "A custom unique identifier, such as 'myOrder_123'."; readonly maxLength: 5000; readonly type: "string"; }; readonly reversal: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_tax_transaction_resource_reversal"; }]; readonly description: "If `type=reversal`, contains information about what was reversed."; readonly nullable: true; }; readonly ship_from_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_ship_from_details"; }]; readonly description: "The details of the ship from location, such as the address."; readonly nullable: true; }; readonly shipping_cost: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_tax_transaction_shipping_cost"; }]; readonly description: "The shipping cost details for the transaction."; readonly nullable: true; }; readonly tax_date: { readonly description: "Timestamp of date at which the tax rules and rates in effect applies for the calculation."; readonly format: "unix-time"; readonly type: "integer"; }; readonly type: { readonly description: "If `reversal`, this transaction reverses an earlier transaction."; readonly enum: readonly ["reversal", "transaction"]; readonly type: "string"; }; }; readonly required: readonly ["created", "currency", "customer_details", "id", "livemode", "object", "reference", "tax_date", "type"]; readonly title: "TaxProductResourceTaxTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer_details", "line_items", "reversal", "ship_from_details", "shipping_cost"]; readonly 'x-resourceId': "tax.transaction"; }; export declare const tax_transaction_line_itemSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The line item amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "The amount of tax calculated for this line item, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax.transaction_line_item"]; readonly type: "string"; }; readonly product: { readonly description: "The ID of an existing [Product](https://stripe.com/docs/api/products/object)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly quantity: { readonly description: "The number of units of the item being purchased. For reversals, this is the quantity reversed."; readonly type: "integer"; }; readonly reference: { readonly description: "A custom identifier for this line item in the transaction."; readonly maxLength: 5000; readonly type: "string"; }; readonly reversal: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_tax_transaction_line_item_resource_reversal"; }]; readonly description: "If `type=reversal`, contains information about what was reversed."; readonly nullable: true; }; readonly tax_behavior: { readonly description: "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."; readonly enum: readonly ["exclusive", "inclusive"]; readonly type: "string"; }; readonly tax_code: { readonly description: "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for this resource."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "If `reversal`, this line item reverses an earlier transaction."; readonly enum: readonly ["reversal", "transaction"]; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_tax", "id", "livemode", "object", "quantity", "reference", "tax_behavior", "tax_code", "type"]; readonly title: "TaxProductResourceTaxTransactionLineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly ["reversal"]; readonly 'x-resourceId': "tax.transaction_line_item"; }; export declare const tax_codeSchema: { readonly description: "[Tax codes](https://stripe.com/docs/tax/tax-categories) classify goods and services for tax purposes."; readonly properties: { readonly description: { readonly description: "A detailed description of which types of products the tax code represents."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly name: { readonly description: "A short name for the tax code."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax_code"]; readonly type: "string"; }; }; readonly required: readonly ["description", "id", "name", "object"]; readonly title: "TaxProductResourceTaxCode"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "tax_code"; }; export declare const tax_deducted_at_sourceSchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax_deducted_at_source"]; readonly type: "string"; }; readonly period_end: { readonly description: "The end of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."; readonly format: "unix-time"; readonly type: "integer"; }; readonly period_start: { readonly description: "The start of the invoicing period. This TDS applies to Stripe fees collected during this invoicing period."; readonly format: "unix-time"; readonly type: "integer"; }; readonly tax_deduction_account_number: { readonly description: "The TAN that was supplied to Stripe when TDS was assessed"; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["id", "object", "period_end", "period_start", "tax_deduction_account_number"]; readonly title: "TaxDeductedAtSource"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_i_ds_ownerSchema: { readonly description: ""; readonly properties: { readonly account: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account being referenced when `type` is `account`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly application: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/application"; }]; readonly description: "The Connect Application being referenced when `type` is `application`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/application"; }]; }; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "The customer being referenced when `type` is `customer`."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly type: { readonly description: "Type of owner referenced."; readonly enum: readonly ["account", "application", "customer", "self"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TaxIDsOwner"; readonly type: "object"; readonly 'x-expandableFields': readonly ["account", "application", "customer"]; }; export declare const tax_idSchema: { readonly description: "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)"; readonly properties: { readonly country: { readonly description: "Two-letter ISO code representing the country of the tax ID."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly customer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/customer"; }]; readonly description: "ID of the customer."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/customer"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax_id"]; readonly type: "string"; }; readonly owner: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_i_ds_owner"; }]; readonly description: "The account or customer the tax ID belongs to."; readonly nullable: true; }; readonly type: { readonly description: "Type of the tax ID, one of `ad_nrt`, `ae_trn`, `ar_cuit`, `au_abn`, `au_arn`, `bg_uic`, `bh_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `ca_bn`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `ca_qst`, `ch_vat`, `cl_tin`, `cn_tin`, `co_nit`, `cr_tin`, `de_stn`, `do_rcn`, `ec_ruc`, `eg_tin`, `es_cif`, `eu_oss_vat`, `eu_vat`, `gb_vat`, `ge_vat`, `hk_br`, `hu_tin`, `id_npwp`, `il_vat`, `in_gst`, `is_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `ke_pin`, `kr_brn`, `kz_bin`, `li_uid`, `mx_rfc`, `my_frp`, `my_itn`, `my_sst`, `ng_tin`, `no_vat`, `no_voec`, `nz_gst`, `om_vat`, `pe_ruc`, `ph_tin`, `ro_tin`, `rs_pib`, `ru_inn`, `ru_kpp`, `sa_vat`, `sg_gst`, `sg_uen`, `si_tin`, `sv_nit`, `th_vat`, `tr_tin`, `tw_vat`, `ua_vat`, `us_ein`, `uy_ruc`, `ve_rif`, `vn_tin`, or `za_vat`. Note that some legacy tax IDs have type `unknown`"; readonly enum: readonly ["ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat"]; readonly type: "string"; }; readonly value: { readonly description: "Value of the tax ID."; readonly maxLength: 5000; readonly type: "string"; }; readonly verification: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_id_verification"; }]; readonly description: "Tax ID verification information."; readonly nullable: true; }; }; readonly required: readonly ["created", "id", "livemode", "object", "type", "value"]; readonly title: "tax_id"; readonly type: "object"; readonly 'x-expandableFields': readonly ["customer", "owner", "verification"]; readonly 'x-resourceId': "tax_id"; }; export declare const tax_id_verificationSchema: { readonly description: ""; readonly properties: { readonly status: { readonly description: "Verification status, one of `pending`, `verified`, `unverified`, or `unavailable`."; readonly enum: readonly ["pending", "unavailable", "unverified", "verified"]; readonly type: "string"; }; readonly verified_address: { readonly description: "Verified address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly verified_name: { readonly description: "Verified name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "tax_id_verification"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_optionsSchema: { readonly description: ""; readonly properties: { readonly ae: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly at: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly au: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly be: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly bg: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly bh: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly ca: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_canada"; }; readonly ch: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly cl: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly co: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly cy: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly cz: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly de: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly dk: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly ee: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly eg: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly es: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly fi: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly fr: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly gb: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly ge: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly gr: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly hr: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly hu: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly id: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly ie: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly is: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly it: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly jp: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly ke: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly kr: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly kz: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly lt: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly lu: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly lv: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly mt: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly mx: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly my: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly ng: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly nl: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly no: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly nz: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly om: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly pl: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly pt: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly ro: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly sa: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly se: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly sg: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; readonly si: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly sk: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_europe"; }; readonly th: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly tr: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly us: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_united_states"; }; readonly vn: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_simplified"; }; readonly za: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_default"; }; }; readonly title: "TaxProductRegistrationsResourceCountryOptions"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ae", "at", "au", "be", "bg", "bh", "ca", "ch", "cl", "co", "cy", "cz", "de", "dk", "ee", "eg", "es", "fi", "fr", "gb", "ge", "gr", "hr", "hu", "id", "ie", "is", "it", "jp", "ke", "kr", "kz", "lt", "lu", "lv", "mt", "mx", "my", "ng", "nl", "no", "nz", "om", "pl", "pt", "ro", "sa", "se", "sg", "si", "sk", "th", "tr", "us", "vn", "za"]; }; export declare const tax_product_registrations_resource_country_options_ca_province_standardSchema: { readonly description: ""; readonly properties: { readonly province: { readonly description: "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["province"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_options_canadaSchema: { readonly description: ""; readonly properties: { readonly province_standard: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard"; }; readonly type: { readonly description: "Type of registration in Canada."; readonly enum: readonly ["province_standard", "simplified", "standard"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsCanada"; readonly type: "object"; readonly 'x-expandableFields': readonly ["province_standard"]; }; export declare const tax_product_registrations_resource_country_options_defaultSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "Type of registration in `country`."; readonly enum: readonly ["standard"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsDefault"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_options_eu_standardSchema: { readonly description: ""; readonly properties: { readonly place_of_supply_scheme: { readonly description: "Place of supply scheme used in an EU standard registration."; readonly enum: readonly ["small_seller", "standard"]; readonly type: "string"; }; }; readonly required: readonly ["place_of_supply_scheme"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsEuStandard"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_options_europeSchema: { readonly description: ""; readonly properties: { readonly standard: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard"; }; readonly type: { readonly description: "Type of registration in an EU country."; readonly enum: readonly ["ioss", "oss_non_union", "oss_union", "standard"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsEurope"; readonly type: "object"; readonly 'x-expandableFields': readonly ["standard"]; }; export declare const tax_product_registrations_resource_country_options_simplifiedSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "Type of registration in `country`."; readonly enum: readonly ["simplified"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsSimplified"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_options_united_statesSchema: { readonly description: ""; readonly properties: { readonly local_amusement_tax: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax"; }; readonly local_lease_tax: { readonly $ref: "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax"; }; readonly state: { readonly description: "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "Type of registration in the US."; readonly enum: readonly ["local_amusement_tax", "local_lease_tax", "state_communications_tax", "state_sales_tax"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["state", "type"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsUnitedStates"; readonly type: "object"; readonly 'x-expandableFields': readonly ["local_amusement_tax", "local_lease_tax"]; }; export declare const tax_product_registrations_resource_country_options_us_local_amusement_taxSchema: { readonly description: ""; readonly properties: { readonly jurisdiction: { readonly description: "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["jurisdiction"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_registrations_resource_country_options_us_local_lease_taxSchema: { readonly description: ""; readonly properties: { readonly jurisdiction: { readonly description: "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["jurisdiction"]; readonly title: "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_customer_detailsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_postal_address"; }]; readonly description: "The customer's postal address (for example, home or business location)."; readonly nullable: true; }; readonly address_source: { readonly description: "The type of customer address provided."; readonly enum: readonly ["billing", "shipping"]; readonly nullable: true; readonly type: "string"; }; readonly ip_address: { readonly description: "The customer's IP address (IPv4 or IPv6)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_ids: { readonly description: "The customer's tax IDs (for example, EU VAT numbers)."; readonly items: { readonly $ref: "#/components/schemas/tax_product_resource_customer_details_resource_tax_id"; }; readonly type: "array"; }; readonly taxability_override: { readonly description: "The taxability override used for taxation."; readonly enum: readonly ["customer_exempt", "none", "reverse_charge"]; readonly type: "string"; }; }; readonly required: readonly ["tax_ids", "taxability_override"]; readonly title: "TaxProductResourceCustomerDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address", "tax_ids"]; }; export declare const tax_product_resource_customer_details_resource_tax_idSchema: { readonly description: ""; readonly properties: { readonly type: { readonly description: "The type of the tax ID, one of `ad_nrt`, `ar_cuit`, `eu_vat`, `bo_tin`, `br_cnpj`, `br_cpf`, `cn_tin`, `co_nit`, `cr_tin`, `do_rcn`, `ec_ruc`, `eu_oss_vat`, `pe_ruc`, `ro_tin`, `rs_pib`, `sv_nit`, `uy_ruc`, `ve_rif`, `vn_tin`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `no_voec`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, `bh_vat`, `kz_bin`, `ng_tin`, `om_vat`, `de_stn`, or `unknown`"; readonly enum: readonly ["ad_nrt", "ae_trn", "ar_cuit", "au_abn", "au_arn", "bg_uic", "bh_vat", "bo_tin", "br_cnpj", "br_cpf", "ca_bn", "ca_gst_hst", "ca_pst_bc", "ca_pst_mb", "ca_pst_sk", "ca_qst", "ch_vat", "cl_tin", "cn_tin", "co_nit", "cr_tin", "de_stn", "do_rcn", "ec_ruc", "eg_tin", "es_cif", "eu_oss_vat", "eu_vat", "gb_vat", "ge_vat", "hk_br", "hu_tin", "id_npwp", "il_vat", "in_gst", "is_vat", "jp_cn", "jp_rn", "jp_trn", "ke_pin", "kr_brn", "kz_bin", "li_uid", "mx_rfc", "my_frp", "my_itn", "my_sst", "ng_tin", "no_vat", "no_voec", "nz_gst", "om_vat", "pe_ruc", "ph_tin", "ro_tin", "rs_pib", "ru_inn", "ru_kpp", "sa_vat", "sg_gst", "sg_uen", "si_tin", "sv_nit", "th_vat", "tr_tin", "tw_vat", "ua_vat", "unknown", "us_ein", "uy_ruc", "ve_rif", "vn_tin", "za_vat"]; readonly type: "string"; }; readonly value: { readonly description: "The value of the tax ID."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["type", "value"]; readonly title: "TaxProductResourceCustomerDetailsResourceTaxId"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_jurisdictionSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly display_name: { readonly description: "A human-readable name for the jurisdiction imposing the tax."; readonly maxLength: 5000; readonly type: "string"; }; readonly level: { readonly description: "Indicates the level of the jurisdiction imposing the tax."; readonly enum: readonly ["city", "country", "county", "district", "state"]; readonly type: "string"; }; readonly state: { readonly description: "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["country", "display_name", "level"]; readonly title: "TaxProductResourceJurisdiction"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_line_item_tax_breakdownSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly jurisdiction: { readonly $ref: "#/components/schemas/tax_product_resource_jurisdiction"; }; readonly sourcing: { readonly description: "Indicates whether the jurisdiction was determined by the origin (merchant's address) or destination (customer's address)."; readonly enum: readonly ["destination", "origin"]; readonly type: "string"; }; readonly tax_rate_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/tax_product_resource_line_item_tax_rate_details"; }]; readonly description: "Details regarding the rate for this tax. This field will be `null` when the tax is not imposed, for example if the product is exempt from tax."; readonly nullable: true; }; readonly taxability_reason: { readonly 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."; readonly enum: readonly ["customer_exempt", "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"]; readonly type: "string"; }; readonly taxable_amount: { readonly description: "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; }; readonly required: readonly ["amount", "jurisdiction", "sourcing", "taxability_reason", "taxable_amount"]; readonly title: "TaxProductResourceLineItemTaxBreakdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["jurisdiction", "tax_rate_details"]; }; export declare const tax_product_resource_line_item_tax_rate_detailsSchema: { readonly description: ""; readonly properties: { readonly display_name: { readonly description: "A localized display name for tax type, intended to be human-readable. For example, \"Local Sales and Use Tax\", \"Value-added tax (VAT)\", or \"Umsatzsteuer (USt.)\"."; readonly maxLength: 5000; readonly type: "string"; }; readonly percentage_decimal: { readonly description: "The tax rate percentage as a string. For example, 8.5% is represented as \"8.5\"."; readonly maxLength: 5000; readonly type: "string"; }; readonly tax_type: { readonly description: "The tax type, such as `vat` or `sales_tax`."; readonly enum: readonly ["amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["display_name", "percentage_decimal", "tax_type"]; readonly title: "TaxProductResourceLineItemTaxRateDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_postal_addressSchema: { readonly description: ""; readonly properties: { readonly city: { readonly description: "City, district, suburb, town, or village."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly line1: { readonly description: "Address line 1 (e.g., street, PO Box, or company name)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly line2: { readonly description: "Address line 2 (e.g., apartment, suite, unit, or building)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly postal_code: { readonly description: "ZIP or postal code."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly state: { readonly description: "State/province as an [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code, without country prefix. Example: \"NY\" or \"TX\"."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["country"]; readonly title: "TaxProductResourcePostalAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_ship_from_detailsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/tax_product_resource_postal_address"; }; }; readonly required: readonly ["address"]; readonly title: "TaxProductResourceShipFromDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const tax_product_resource_tax_breakdownSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The amount of tax, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly inclusive: { readonly description: "Specifies whether the tax amount is included in the line item amount."; readonly type: "boolean"; }; readonly tax_rate_details: { readonly $ref: "#/components/schemas/tax_product_resource_tax_rate_details"; }; readonly taxability_reason: { readonly description: "The reasoning behind this tax, for example, if the product is tax exempt. We might extend the possible values for this field to support new tax rules."; readonly enum: readonly ["customer_exempt", "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"]; readonly type: "string"; }; readonly taxable_amount: { readonly description: "The amount on which tax is calculated, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; }; readonly required: readonly ["amount", "inclusive", "tax_rate_details", "taxability_reason", "taxable_amount"]; readonly title: "TaxProductResourceTaxBreakdown"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tax_rate_details"]; }; export declare const tax_product_resource_tax_calculation_shipping_costSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly shipping_rate: { readonly description: "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object)."; readonly maxLength: 5000; readonly type: "string"; }; readonly tax_behavior: { readonly description: "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."; readonly enum: readonly ["exclusive", "inclusive"]; readonly type: "string"; }; readonly tax_breakdown: { readonly description: "Detailed account of taxes relevant to shipping cost."; readonly items: { readonly $ref: "#/components/schemas/tax_product_resource_line_item_tax_breakdown"; }; readonly type: "array"; }; readonly tax_code: { readonly description: "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_tax", "tax_behavior", "tax_code"]; readonly title: "TaxProductResourceTaxCalculationShippingCost"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tax_breakdown"]; }; export declare const tax_product_resource_tax_rate_detailsSchema: { readonly description: ""; readonly properties: { readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly percentage_decimal: { readonly description: "The tax rate percentage as a string. For example, 8.5% is represented as `\"8.5\"`."; readonly maxLength: 5000; readonly type: "string"; }; readonly state: { readonly description: "State, county, province, or region."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_type: { readonly description: "The tax type, such as `vat` or `sales_tax`."; readonly enum: readonly ["amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["percentage_decimal"]; readonly title: "TaxProductResourceTaxRateDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_settings_defaultsSchema: { readonly description: ""; readonly properties: { readonly tax_behavior: { readonly description: "Default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) used to specify whether the price is considered inclusive of taxes or exclusive of taxes. If the item's price has a tax behavior set, it will take precedence over the default tax behavior."; readonly enum: readonly ["exclusive", "inclusive", "inferred_by_currency"]; readonly nullable: true; readonly type: "string"; }; readonly tax_code: { readonly description: "Default [tax code](https://stripe.com/docs/tax/tax-categories) used to classify your products and prices."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TaxProductResourceTaxSettingsDefaults"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_settings_head_officeSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; }; readonly required: readonly ["address"]; readonly title: "TaxProductResourceTaxSettingsHeadOffice"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const tax_product_resource_tax_settings_status_detailsSchema: { readonly description: ""; readonly properties: { readonly active: { readonly $ref: "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_active"; }; readonly pending: { readonly $ref: "#/components/schemas/tax_product_resource_tax_settings_status_details_resource_pending"; }; }; readonly title: "TaxProductResourceTaxSettingsStatusDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["active", "pending"]; }; export declare const tax_product_resource_tax_settings_status_details_resource_activeSchema: { readonly description: ""; readonly properties: {}; readonly title: "TaxProductResourceTaxSettingsStatusDetailsResourceActive"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_settings_status_details_resource_pendingSchema: { readonly description: ""; readonly properties: { readonly missing_fields: { readonly description: "The list of missing fields that are required to perform calculations. It includes the entry `head_office` when the status is `pending`. It is recommended to set the optional values even if they aren't listed as required for calculating taxes. Calculations can fail if missing fields aren't explicitly provided on every call."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly nullable: true; readonly type: "array"; }; }; readonly title: "TaxProductResourceTaxSettingsStatusDetailsResourcePending"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_transaction_line_item_resource_reversalSchema: { readonly description: ""; readonly properties: { readonly original_line_item: { readonly description: "The `id` of the line item to reverse in the original transaction."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["original_line_item"]; readonly title: "TaxProductResourceTaxTransactionLineItemResourceReversal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_transaction_resource_reversalSchema: { readonly description: ""; readonly properties: { readonly original_transaction: { readonly description: "The `id` of the reversed `Transaction` object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TaxProductResourceTaxTransactionResourceReversal"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_product_resource_tax_transaction_shipping_costSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "The shipping amount in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). If `tax_behavior=inclusive`, then this amount includes taxes. Otherwise, taxes were calculated on top of this amount."; readonly type: "integer"; }; readonly amount_tax: { readonly description: "The amount of tax calculated for shipping, in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly shipping_rate: { readonly description: "The ID of an existing [ShippingRate](https://stripe.com/docs/api/shipping_rates/object)."; readonly maxLength: 5000; readonly type: "string"; }; readonly tax_behavior: { readonly description: "Specifies whether the `amount` includes taxes. If `tax_behavior=inclusive`, then the amount includes taxes."; readonly enum: readonly ["exclusive", "inclusive"]; readonly type: "string"; }; readonly tax_code: { readonly description: "The [tax code](https://stripe.com/docs/tax/tax-categories) ID used for shipping."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_tax", "tax_behavior", "tax_code"]; readonly title: "TaxProductResourceTaxTransactionShippingCost"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tax_rateSchema: { readonly description: "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)"; readonly properties: { readonly active: { readonly description: "Defaults to `true`. When set to `false`, this tax rate cannot be used with new applications or Checkout Sessions, but will still work for subscriptions and invoices that already have it set."; readonly type: "boolean"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly description: { readonly description: "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly display_name: { readonly description: "The display name of the tax rates as it will appear to your customer on their receipt email, PDF, and the hosted invoice page."; readonly maxLength: 5000; readonly type: "string"; }; readonly effective_percentage: { readonly description: "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true,\nthis percentage reflects the rate actually used to calculate tax based on the product's taxability\nand whether the user is registered to collect taxes in the corresponding jurisdiction."; readonly nullable: true; readonly type: "number"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly inclusive: { readonly description: "This specifies if the tax rate is inclusive or exclusive."; readonly type: "boolean"; }; readonly jurisdiction: { readonly description: "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly jurisdiction_level: { readonly description: "The level of the jurisdiction that imposes this tax rate. Will be `null` for manually defined tax rates."; readonly enum: readonly ["city", "country", "county", "district", "multiple", "state"]; readonly nullable: true; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["tax_rate"]; readonly type: "string"; }; readonly percentage: { readonly description: "Tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage includes the statutory tax rate of non-taxable jurisdictions."; readonly type: "number"; }; readonly state: { readonly description: "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly tax_type: { readonly description: "The high-level tax type, such as `vat` or `sales_tax`."; readonly enum: readonly ["amusement_tax", "communications_tax", "gst", "hst", "igst", "jct", "lease_tax", "pst", "qst", "rst", "sales_tax", "vat"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["active", "created", "display_name", "id", "inclusive", "livemode", "object", "percentage"]; readonly title: "TaxRate"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "tax_rate"; }; export declare const terminal_configurationSchema: { readonly description: "A Configurations object represents how features should be configured for terminal readers."; readonly properties: { readonly bbpos_wisepos_e: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly is_account_default: { readonly description: "Whether this Configuration is the default for your account"; readonly nullable: true; readonly type: "boolean"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly name: { readonly description: "String indicating the name of the Configuration object, set by the user"; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.configuration"]; readonly type: "string"; }; readonly offline: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_offline_config"; }; readonly stripe_s700: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"; }; readonly tipping: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_tipping"; }; readonly verifone_p400: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_device_type_specific_config"; }; }; readonly required: readonly ["id", "livemode", "object"]; readonly title: "TerminalConfigurationConfiguration"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bbpos_wisepos_e", "offline", "stripe_s700", "tipping", "verifone_p400"]; readonly 'x-resourceId': "terminal.configuration"; }; export declare const terminal_connection_tokenSchema: { readonly description: "A Connection Token is used by the Stripe Terminal SDK to connect to a reader.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)"; readonly properties: { readonly location: { readonly description: "The id of the location that this connection token is scoped to. Note that location scoping only applies to internet-connected readers. For more details, see [the docs on scoping connection tokens](https://docs.stripe.com/terminal/fleet/locations-and-zones?dashboard-or-api=api#connection-tokens)."; readonly maxLength: 5000; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.connection_token"]; readonly type: "string"; }; readonly secret: { readonly description: "Your application should pass this token to the Stripe Terminal SDK."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["object", "secret"]; readonly title: "TerminalConnectionToken"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "terminal.connection_token"; }; export declare const terminal_locationSchema: { readonly description: "A Location represents a grouping of readers.\n\nRelated guide: [Fleet management](https://stripe.com/docs/terminal/fleet/locations)"; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly configuration_overrides: { readonly description: "The ID of a configuration that will be used to customize all readers in this location."; readonly maxLength: 5000; readonly type: "string"; }; readonly display_name: { readonly description: "The display name of the location."; readonly maxLength: 5000; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.location"]; readonly type: "string"; }; }; readonly required: readonly ["address", "display_name", "id", "livemode", "metadata", "object"]; readonly title: "TerminalLocationLocation"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; readonly 'x-resourceId': "terminal.location"; }; export declare const terminal_readerSchema: { readonly description: "A Reader represents a physical device for accepting payment details.\n\nRelated guide: [Connecting to a reader](https://stripe.com/docs/terminal/payments/connect-reader)"; readonly properties: { readonly action: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/terminal_reader_reader_resource_reader_action"; }]; readonly description: "The most recent action performed by the reader."; readonly nullable: true; }; readonly device_sw_version: { readonly description: "The current software version of the reader."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly device_type: { readonly description: "Type of reader, one of `bbpos_wisepad3`, `stripe_m2`, `bbpos_chipper2x`, `bbpos_wisepos_e`, `verifone_P400`, `simulated_wisepos_e`, or `mobile_phone_reader`."; readonly enum: readonly ["bbpos_chipper2x", "bbpos_wisepad3", "bbpos_wisepos_e", "mobile_phone_reader", "simulated_wisepos_e", "stripe_m2", "verifone_P400"]; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly ip_address: { readonly description: "The local IP address of the reader."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly label: { readonly description: "Custom label given to the reader for easier identification."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly location: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/terminal.location"; }]; readonly description: "The location identifier of the reader."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/terminal.location"; }]; }; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["terminal.reader"]; readonly type: "string"; }; readonly serial_number: { readonly description: "Serial number of the reader."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "The networking status of the reader."; readonly enum: readonly ["offline", "online"]; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["device_type", "id", "label", "livemode", "metadata", "object", "serial_number"]; readonly title: "TerminalReaderReader"; readonly type: "object"; readonly 'x-expandableFields': readonly ["action", "location"]; readonly 'x-resourceId': "terminal.reader"; }; export declare const terminal_configuration_configuration_resource_currency_specific_configSchema: { readonly description: ""; readonly properties: { readonly fixed_amounts: { readonly description: "Fixed amounts displayed when collecting a tip"; readonly items: { readonly type: "integer"; }; readonly nullable: true; readonly type: "array"; }; readonly percentages: { readonly description: "Percentages displayed when collecting a tip"; readonly items: { readonly type: "integer"; }; readonly nullable: true; readonly type: "array"; }; readonly smart_tip_threshold: { readonly description: "Below this amount, fixed amounts will be displayed; above it, percentages will be displayed"; readonly type: "integer"; }; }; readonly title: "TerminalConfigurationConfigurationResourceCurrencySpecificConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const terminal_configuration_configuration_resource_device_type_specific_configSchema: { readonly description: ""; readonly properties: { readonly splashscreen: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/file"; }]; readonly description: "A File ID representing an image you would like displayed on the reader."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/file"; }]; }; }; }; readonly title: "TerminalConfigurationConfigurationResourceDeviceTypeSpecificConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly ["splashscreen"]; }; export declare const terminal_configuration_configuration_resource_offline_configSchema: { readonly description: ""; readonly properties: { readonly enabled: { readonly description: "Determines whether to allow transactions to be collected while reader is offline. Defaults to false."; readonly nullable: true; readonly type: "boolean"; }; }; readonly title: "TerminalConfigurationConfigurationResourceOfflineConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const terminal_configuration_configuration_resource_tippingSchema: { readonly description: ""; readonly properties: { readonly aud: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly cad: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly chf: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly czk: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly dkk: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly eur: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly gbp: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly hkd: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly myr: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly nok: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly nzd: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly sek: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly sgd: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; readonly usd: { readonly $ref: "#/components/schemas/terminal_configuration_configuration_resource_currency_specific_config"; }; }; readonly title: "TerminalConfigurationConfigurationResourceTipping"; readonly type: "object"; readonly 'x-expandableFields': readonly ["aud", "cad", "chf", "czk", "dkk", "eur", "gbp", "hkd", "myr", "nok", "nzd", "sek", "sgd", "usd"]; }; export declare const terminal_reader_reader_resource_cartSchema: { readonly description: "Represents a cart to be displayed on the reader"; readonly properties: { readonly currency: { readonly 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)."; readonly type: "string"; }; readonly line_items: { readonly description: "List of line items in the cart."; readonly items: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_line_item"; }; readonly type: "array"; }; readonly tax: { readonly description: "Tax amount for the entire cart. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly nullable: true; readonly type: "integer"; }; readonly total: { readonly description: "Total amount for the entire cart, including tax. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; }; readonly required: readonly ["currency", "line_items", "total"]; readonly title: "TerminalReaderReaderResourceCart"; readonly type: "object"; readonly 'x-expandableFields': readonly ["line_items"]; }; export declare const terminal_reader_reader_resource_line_itemSchema: { readonly description: "Represents a line item to be displayed on the reader"; readonly properties: { readonly amount: { readonly description: "The amount of the line item. A positive integer in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal)."; readonly type: "integer"; }; readonly description: { readonly description: "Description of the line item."; readonly maxLength: 5000; readonly type: "string"; }; readonly quantity: { readonly description: "The quantity of the line item."; readonly type: "integer"; }; }; readonly required: readonly ["amount", "description", "quantity"]; readonly title: "TerminalReaderReaderResourceLineItem"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const terminal_reader_reader_resource_process_configSchema: { readonly description: "Represents a per-transaction override of a reader configuration"; readonly properties: { readonly enable_customer_cancellation: { readonly description: "Enable customer initiated cancellation when processing this payment."; readonly type: "boolean"; }; readonly skip_tipping: { readonly description: "Override showing a tipping selection screen on this transaction."; readonly type: "boolean"; }; readonly tipping: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_tipping_config"; }; }; readonly title: "TerminalReaderReaderResourceProcessConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly ["tipping"]; }; export declare const terminal_reader_reader_resource_process_payment_intent_actionSchema: { readonly description: "Represents a reader action to process a payment intent"; readonly properties: { readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "Most recent PaymentIntent processed by the reader."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly process_config: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_process_config"; }; }; readonly required: readonly ["payment_intent"]; readonly title: "TerminalReaderReaderResourceProcessPaymentIntentAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["payment_intent", "process_config"]; }; export declare const terminal_reader_reader_resource_process_setup_configSchema: { readonly description: "Represents a per-setup override of a reader configuration"; readonly properties: { readonly enable_customer_cancellation: { readonly description: "Enable customer initiated cancellation when processing this SetupIntent."; readonly type: "boolean"; }; }; readonly title: "TerminalReaderReaderResourceProcessSetupConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const terminal_reader_reader_resource_process_setup_intent_actionSchema: { readonly description: "Represents a reader action to process a setup intent"; readonly properties: { readonly generated_card: { readonly description: "ID of a card PaymentMethod generated from the card_present PaymentMethod that may be attached to a Customer for future transactions. Only present if it was possible to generate a card PaymentMethod."; readonly maxLength: 5000; readonly type: "string"; }; readonly process_config: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_process_setup_config"; }; readonly setup_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/setup_intent"; }]; readonly description: "Most recent SetupIntent processed by the reader."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/setup_intent"; }]; }; }; }; readonly required: readonly ["setup_intent"]; readonly title: "TerminalReaderReaderResourceProcessSetupIntentAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["process_config", "setup_intent"]; }; export declare const terminal_reader_reader_resource_reader_actionSchema: { readonly description: "Represents an action performed by the reader"; readonly properties: { readonly failure_code: { readonly description: "Failure code, only set if status is `failed`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly failure_message: { readonly description: "Detailed failure message, only set if status is `failed`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly process_payment_intent: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_process_payment_intent_action"; }; readonly process_setup_intent: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_process_setup_intent_action"; }; readonly refund_payment: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_refund_payment_action"; }; readonly set_reader_display: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_set_reader_display_action"; }; readonly status: { readonly description: "Status of the action performed by the reader."; readonly enum: readonly ["failed", "in_progress", "succeeded"]; readonly type: "string"; }; readonly type: { readonly description: "Type of action performed by the reader."; readonly enum: readonly ["process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["status", "type"]; readonly title: "TerminalReaderReaderResourceReaderAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["process_payment_intent", "process_setup_intent", "refund_payment", "set_reader_display"]; }; export declare const terminal_reader_reader_resource_refund_payment_actionSchema: { readonly description: "Represents a reader action to refund a payment"; readonly properties: { readonly amount: { readonly description: "The amount being refunded."; readonly type: "integer"; }; readonly charge: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "Charge that is being refunded."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly payment_intent: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/payment_intent"; }]; readonly description: "Payment intent that is being refunded."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/payment_intent"; }]; }; }; readonly reason: { readonly description: "The reason for the refund."; readonly enum: readonly ["duplicate", "fraudulent", "requested_by_customer"]; readonly type: "string"; }; readonly refund: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/refund"; }]; readonly description: "Unique identifier for the refund object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/refund"; }]; }; }; readonly refund_application_fee: { readonly description: "Boolean indicating whether the application fee should be refunded when refunding this charge. If a full charge refund is given, the full application fee will be refunded. Otherwise, the application fee will be refunded in an amount proportional to the amount of the charge refunded. An application fee can be refunded only by the application that created the charge."; readonly type: "boolean"; }; readonly refund_payment_config: { readonly $ref: "#/components/schemas/terminal_reader_reader_resource_refund_payment_config"; }; readonly reverse_transfer: { readonly description: "Boolean indicating whether the transfer should be reversed when refunding this charge. The transfer will be reversed proportionally to the amount being refunded (either the entire or partial amount). A transfer can be reversed only by the application that created the charge."; readonly type: "boolean"; }; }; readonly title: "TerminalReaderReaderResourceRefundPaymentAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["charge", "payment_intent", "refund", "refund_payment_config"]; }; export declare const terminal_reader_reader_resource_refund_payment_configSchema: { readonly description: "Represents a per-transaction override of a reader configuration"; readonly properties: { readonly enable_customer_cancellation: { readonly description: "Enable customer initiated cancellation when refunding this payment."; readonly type: "boolean"; }; }; readonly title: "TerminalReaderReaderResourceRefundPaymentConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const terminal_reader_reader_resource_set_reader_display_actionSchema: { readonly description: "Represents a reader action to set the reader display"; readonly properties: { readonly cart: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/terminal_reader_reader_resource_cart"; }]; readonly description: "Cart object to be displayed by the reader."; readonly nullable: true; }; readonly type: { readonly description: "Type of information to be displayed by the reader."; readonly enum: readonly ["cart"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TerminalReaderReaderResourceSetReaderDisplayAction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["cart"]; }; export declare const terminal_reader_reader_resource_tipping_configSchema: { readonly description: "Represents a per-transaction tipping configuration"; readonly properties: { readonly amount_eligible: { readonly description: "Amount used to calculate tip suggestions on tipping selection screen for this transaction. Must be a positive integer in the smallest currency unit (e.g., 100 cents to represent $1.00 or 100 to represent ¥100, a zero-decimal currency)."; readonly type: "integer"; }; }; readonly title: "TerminalReaderReaderResourceTippingConfig"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const test_helpers_test_clockSchema: { readonly description: "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time."; readonly properties: { readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly deletes_after: { readonly description: "Time at which this clock is scheduled to auto delete."; readonly format: "unix-time"; readonly type: "integer"; }; readonly frozen_time: { readonly description: "Time at which all objects belonging to this clock are frozen."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly name: { readonly description: "The custom name supplied at creation."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["test_helpers.test_clock"]; readonly type: "string"; }; readonly status: { readonly description: "The status of the Test Clock."; readonly enum: readonly ["advancing", "internal_failure", "ready"]; readonly type: "string"; }; }; readonly required: readonly ["created", "deletes_after", "frozen_time", "id", "livemode", "object", "status"]; readonly title: "TestClock"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "test_helpers.test_clock"; }; export declare const three_d_secure_detailsSchema: { readonly description: ""; readonly properties: { readonly authentication_flow: { readonly description: "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."; readonly enum: readonly ["challenge", "frictionless"]; readonly nullable: true; readonly type: "string"; }; readonly electronic_commerce_indicator: { readonly description: "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed."; readonly enum: readonly ["01", "02", "05", "06", "07"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly result: { readonly description: "Indicates the outcome of 3D Secure authentication."; readonly enum: readonly ["attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error"]; readonly nullable: true; readonly type: "string"; }; readonly result_reason: { readonly description: "Additional information about why 3D Secure succeeded or failed based\non the `result`."; readonly enum: readonly ["abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected"]; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly version: { readonly description: "The version of 3D Secure that was used."; readonly enum: readonly ["1.0.2", "2.1.0", "2.2.0"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "three_d_secure_details"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const three_d_secure_details_chargeSchema: { readonly description: ""; readonly properties: { readonly authentication_flow: { readonly description: "For authenticated transactions: how the customer was authenticated by\nthe issuing bank."; readonly enum: readonly ["challenge", "frictionless"]; readonly nullable: true; readonly type: "string"; }; readonly electronic_commerce_indicator: { readonly description: "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed."; readonly enum: readonly ["01", "02", "05", "06", "07"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly exemption_indicator: { readonly description: "The exemption requested via 3DS and accepted by the issuer at authentication time."; readonly enum: readonly ["low_risk", "none"]; readonly nullable: true; readonly type: "string"; }; readonly exemption_indicator_applied: { readonly description: "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment."; readonly type: "boolean"; }; readonly result: { readonly description: "Indicates the outcome of 3D Secure authentication."; readonly enum: readonly ["attempt_acknowledged", "authenticated", "exempted", "failed", "not_supported", "processing_error"]; readonly nullable: true; readonly type: "string"; }; readonly result_reason: { readonly description: "Additional information about why 3D Secure succeeded or failed based\non the `result`."; readonly enum: readonly ["abandoned", "bypassed", "canceled", "card_not_enrolled", "network_not_supported", "protocol_error", "rejected"]; readonly nullable: true; readonly type: "string"; }; readonly transaction_id: { readonly description: "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly version: { readonly description: "The version of 3D Secure that was used."; readonly enum: readonly ["1.0.2", "2.1.0", "2.2.0"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly title: "three_d_secure_details_charge"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const three_d_secure_usageSchema: { readonly description: ""; readonly properties: { readonly supported: { readonly description: "Whether 3D Secure is supported on this card."; readonly type: "boolean"; }; }; readonly required: readonly ["supported"]; readonly title: "three_d_secure_usage"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const tokenSchema: { readonly description: "Tokenization is the process Stripe uses to collect sensitive card or bank\naccount details, or personally identifiable information (PII), directly from\nyour customers in a secure manner. A token representing this information is\nreturned to your server to use. Use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\non the client-side. This guarantees that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you can't use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. If\nyour integration uses this method, you're responsible for any PCI compliance\nthat it might require, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information isn't sent directly to\nStripe, so we can't determine how it's handled or stored.\n\nYou can't store or use tokens more than once. To store card or bank account\ninformation for later use, create [Customer](https://stripe.com/docs/api#customers)\nobjects or [External accounts](/api#external_accounts).\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization."; readonly properties: { readonly bank_account: { readonly $ref: "#/components/schemas/bank_account"; }; readonly card: { readonly $ref: "#/components/schemas/card"; }; readonly client_ip: { readonly description: "IP address of the client that generates the token."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["token"]; readonly type: "string"; }; readonly type: { readonly description: "Type of the token: `account`, `bank_account`, `card`, or `pii`."; readonly maxLength: 5000; readonly type: "string"; }; readonly used: { readonly description: "Determines if you have already used this token (you can only use tokens once)."; readonly type: "boolean"; }; }; readonly required: readonly ["created", "id", "livemode", "object", "type", "used"]; readonly title: "Token"; readonly type: "object"; readonly 'x-expandableFields': readonly ["bank_account", "card"]; readonly 'x-resourceId': "token"; }; export declare const token_card_networksSchema: { readonly description: ""; readonly properties: { readonly preferred: { readonly description: "The preferred network for co-branded cards. Can be `cartes_bancaires`, `mastercard`, `visa` or `invalid_preference` if requested network is not valid for the card."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "token_card_networks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const topupSchema: { readonly description: "To top up your Stripe balance, you create a top-up object. You can retrieve\nindividual top-ups, as well as list all top-ups. Top-ups are identified by a\nunique, random ID.\n\nRelated guide: [Topping up your platform account](https://stripe.com/docs/connect/top-ups)"; readonly properties: { readonly amount: { readonly description: "Amount transferred."; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly maxLength: 5000; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly expected_availability_date: { readonly description: "Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up."; readonly nullable: true; readonly type: "integer"; }; readonly failure_code: { readonly description: "Error code explaining reason for top-up failure if available (see [the errors section](https://stripe.com/docs/api#errors) for a list of codes)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly failure_message: { readonly description: "Message to user further explaining reason for top-up failure if available."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["topup"]; readonly type: "string"; }; readonly source: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/source"; }]; readonly description: "The source field is deprecated. It might not always be present in the API response."; readonly nullable: true; }; readonly statement_descriptor: { readonly description: "Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly status: { readonly description: "The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`."; readonly enum: readonly ["canceled", "failed", "pending", "reversed", "succeeded"]; readonly type: "string"; }; readonly transfer_group: { readonly description: "A string that identifies this top-up as part of a group."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "created", "currency", "id", "livemode", "metadata", "object", "status"]; readonly title: "Topup"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "source"]; readonly 'x-resourceId': "topup"; }; export declare const transferSchema: { readonly description: "A `Transfer` object is created when you move funds between Stripe accounts as\npart of Connect.\n\nBefore April 6, 2017, transfers also represented movement of funds from a\nStripe account to a card or bank account. This behavior has since been split\nout into a [Payout](https://stripe.com/docs/api#payout_object) object, with corresponding payout endpoints. For more\ninformation, read about the\n[transfer/payout split](https://stripe.com/docs/transfer-payout-split).\n\nRelated guide: [Creating separate charges and transfers](https://stripe.com/docs/connect/separate-charges-and-transfers)"; readonly properties: { readonly amount: { readonly description: "Amount in cents (or local equivalent) to be transferred."; readonly type: "integer"; }; readonly amount_reversed: { readonly description: "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued)."; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "Balance transaction that describes the impact of this transfer on your account balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly created: { readonly description: "Time that this record of the transfer was first created."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "ID of the Stripe account the transfer was sent to."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; readonly destination_payment: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "If the destination is a Stripe account, this will be the ID of the payment that the destination account received for the transfer."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["transfer"]; readonly type: "string"; }; readonly reversals: { readonly description: "A list of reversals that have been applied to the transfer."; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/transfer_reversal"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "TransferReversalList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly reversed: { readonly description: "Whether the transfer has been fully reversed. If the transfer is only partially reversed, this attribute will still be false."; readonly type: "boolean"; }; readonly source_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/charge"; }]; readonly description: "ID of the charge or payment that was used to fund the transfer. If null, the transfer was funded from the available balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/charge"; }]; }; }; readonly source_type: { readonly description: "The source balance this transfer came from. One of `card`, `fpx`, or `bank_account`."; readonly maxLength: 5000; readonly type: "string"; }; readonly transfer_group: { readonly description: "A string that identifies this transaction as part of a group. See the [Connect documentation](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options) for details."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["amount", "amount_reversed", "created", "currency", "id", "livemode", "metadata", "object", "reversals", "reversed"]; readonly title: "Transfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "destination", "destination_payment", "reversals", "source_transaction"]; readonly 'x-resourceId': "transfer"; }; export declare const transfer_dataSchema: { readonly description: ""; readonly properties: { readonly amount: { readonly description: "Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://stripe.com/docs/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99)."; readonly type: "integer"; }; readonly destination: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/account"; }]; readonly description: "The account (if any) that the payment is attributed to for tax\nreporting, and where funds from the payment are transferred to after\npayment success."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/account"; }]; }; }; }; readonly required: readonly ["destination"]; readonly title: "transfer_data"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination"]; }; export declare const transfer_reversalSchema: { readonly description: "[Stripe Connect](https://stripe.com/docs/connect) platforms can reverse transfers made to a\nconnected account, either entirely or partially, and can also specify whether\nto refund any related application fees. Transfer reversals add to the\nplatform's balance and subtract from the destination account's balance.\n\nReversing a transfer that was made for a [destination\ncharge](/docs/connect/destination-charges) is allowed only up to the amount of\nthe charge. It is possible to reverse a\n[transfer_group](https://stripe.com/docs/connect/separate-charges-and-transfers#transfer-options)\ntransfer only if the destination account has enough balance to cover the\nreversal.\n\nRelated guide: [Reverse transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reverse-transfers)"; readonly properties: { readonly amount: { readonly description: "Amount, in cents (or local equivalent)."; readonly type: "integer"; }; readonly balance_transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/balance_transaction"; }]; readonly description: "Balance transaction that describes the impact on your account balance."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/balance_transaction"; }]; }; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly destination_payment_refund: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/refund"; }]; readonly description: "Linked payment refund for the transfer reversal."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/refund"; }]; }; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["transfer_reversal"]; readonly type: "string"; }; readonly source_refund: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/refund"; }]; readonly description: "ID of the refund responsible for the transfer reversal."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/refund"; }]; }; }; readonly transfer: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/transfer"; }]; readonly description: "ID of the transfer that was reversed."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/transfer"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "id", "object", "transfer"]; readonly title: "TransferReversal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_transaction", "destination_payment_refund", "source_refund", "transfer"]; readonly 'x-resourceId': "transfer_reversal"; }; export declare const transfer_scheduleSchema: { readonly description: ""; readonly properties: { readonly delay_days: { readonly description: "The number of days charges for the account will be held before being paid out."; readonly type: "integer"; }; readonly interval: { readonly description: "How frequently funds will be paid out. One of `manual` (payouts only created via API call), `daily`, `weekly`, or `monthly`."; readonly maxLength: 5000; readonly type: "string"; }; readonly monthly_anchor: { readonly 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."; readonly type: "integer"; }; readonly weekly_anchor: { readonly description: "The day of the week funds will be paid out, of the style 'monday', 'tuesday', etc. Only shown if `interval` is weekly."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["delay_days", "interval"]; readonly title: "TransferSchedule"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const transform_quantitySchema: { readonly description: ""; readonly properties: { readonly divide_by: { readonly description: "Divide usage by this number."; readonly type: "integer"; }; readonly round: { readonly description: "After division, either round the result `up` or `down`."; readonly enum: readonly ["down", "up"]; readonly type: "string"; }; }; readonly required: readonly ["divide_by", "round"]; readonly title: "TransformQuantity"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const transform_usageSchema: { readonly description: ""; readonly properties: { readonly divide_by: { readonly description: "Divide usage by this number."; readonly type: "integer"; }; readonly round: { readonly description: "After division, either round the result `up` or `down`."; readonly enum: readonly ["down", "up"]; readonly type: "string"; }; }; readonly required: readonly ["divide_by", "round"]; readonly title: "TransformUsage"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_credit_reversalSchema: { readonly description: "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly financial_account: { readonly description: "The FinancialAccount to reverse funds from."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly network: { readonly description: "The rails used to reverse the funds."; readonly enum: readonly ["ach", "stripe"]; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.credit_reversal"]; readonly type: "string"; }; readonly received_credit: { readonly description: "The ReceivedCredit being reversed."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Status of the CreditReversal"; readonly enum: readonly ["canceled", "posted", "processing"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_received_credits_resource_status_transitions"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "financial_account", "id", "livemode", "metadata", "network", "object", "received_credit", "status", "status_transitions"]; readonly title: "TreasuryReceivedCreditsResourceCreditReversal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_transitions", "transaction"]; readonly 'x-resourceId': "treasury.credit_reversal"; }; export declare const treasury_debit_reversalSchema: { readonly description: "You can reverse some [ReceivedDebits](https://stripe.com/docs/api#received_debits) depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly financial_account: { readonly description: "The FinancialAccount to reverse funds from."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly linked_flows: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_received_debits_resource_debit_reversal_linked_flows"; }]; readonly description: "Other flows linked to a DebitReversal."; readonly nullable: true; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly network: { readonly description: "The rails used to reverse the funds."; readonly enum: readonly ["ach", "card"]; readonly type: "string"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.debit_reversal"]; readonly type: "string"; }; readonly received_debit: { readonly description: "The ReceivedDebit being reversed."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Status of the DebitReversal"; readonly enum: readonly ["failed", "processing", "succeeded"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_received_debits_resource_status_transitions"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "id", "livemode", "metadata", "network", "object", "received_debit", "status", "status_transitions"]; readonly title: "TreasuryReceivedDebitsResourceDebitReversal"; readonly type: "object"; readonly 'x-expandableFields': readonly ["linked_flows", "status_transitions", "transaction"]; readonly 'x-resourceId': "treasury.debit_reversal"; }; export declare const treasury_financial_accountSchema: { readonly description: "Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance.\nFinancialAccounts serve as the source and destination of Treasury’s money movement APIs."; readonly properties: { readonly active_features: { readonly description: "The array of paths to active Features in the Features hash."; readonly items: { readonly enum: readonly ["card_issuing", "deposit_insurance", "financial_addresses.aba", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly balance: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_balance"; }; readonly country: { readonly description: "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2))."; readonly maxLength: 5000; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly features: { readonly $ref: "#/components/schemas/treasury.financial_account_features"; }; readonly financial_addresses: { readonly description: "The set of credentials that resolve to a FinancialAccount."; readonly items: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_financial_address"; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly nullable: true; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.financial_account"]; readonly type: "string"; }; readonly pending_features: { readonly description: "The array of paths to pending Features in the Features hash."; readonly items: { readonly enum: readonly ["card_issuing", "deposit_insurance", "financial_addresses.aba", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly platform_restrictions: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_platform_restrictions"; }]; readonly description: "The set of functionalities that the platform can restrict on the FinancialAccount."; readonly nullable: true; }; readonly restricted_features: { readonly description: "The array of paths to restricted Features in the Features hash."; readonly items: { readonly enum: readonly ["card_issuing", "deposit_insurance", "financial_addresses.aba", "inbound_transfers.ach", "intra_stripe_flows", "outbound_payments.ach", "outbound_payments.us_domestic_wire", "outbound_transfers.ach", "outbound_transfers.us_domestic_wire", "remote_deposit_capture"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly status: { readonly description: "The enum specifying what state the account is in."; readonly enum: readonly ["closed", "open"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly status_details: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_status_details"; }; readonly supported_currencies: { readonly description: "The currencies the FinancialAccount can hold a balance in. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase."; readonly items: { readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["balance", "country", "created", "financial_addresses", "id", "livemode", "object", "status", "status_details", "supported_currencies"]; readonly title: "TreasuryFinancialAccountsResourceFinancialAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance", "features", "financial_addresses", "platform_restrictions", "status_details"]; readonly 'x-resourceId': "treasury.financial_account"; }; export declare const treasury_financial_account_featuresSchema: { readonly description: "Encodes whether a FinancialAccount has access to a particular Feature, with a `status` enum and associated `status_details`.\nStripe or the platform can control Features via the requested field."; readonly properties: { readonly card_issuing: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"; }; readonly deposit_insurance: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"; }; readonly financial_addresses: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_financial_addresses_features"; }; readonly inbound_transfers: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_inbound_transfers"; }; readonly intra_stripe_flows: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.financial_account_features"]; readonly type: "string"; }; readonly outbound_payments: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_outbound_payments"; }; readonly outbound_transfers: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_outbound_transfers"; }; }; readonly required: readonly ["object"]; readonly title: "TreasuryFinancialAccountsResourceFinancialAccountFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly ["card_issuing", "deposit_insurance", "financial_addresses", "inbound_transfers", "intra_stripe_flows", "outbound_payments", "outbound_transfers"]; readonly 'x-resourceId': "treasury.financial_account_features"; }; export declare const treasury_inbound_transferSchema: { readonly description: "Use [InboundTransfers](https://stripe.com/docs/treasury/moving-money/financial-accounts/into/inbound-transfers) to add funds to your [FinancialAccount](https://stripe.com/docs/api#financial_accounts) via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly cancelable: { readonly description: "Returns `true` if the InboundTransfer is able to be canceled."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly failure_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_inbound_transfers_resource_failure_details"; }]; readonly description: "Details about this InboundTransfer's failure. Only set when status is `failed`."; readonly nullable: true; }; readonly financial_account: { readonly description: "The FinancialAccount that received the funds."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly linked_flows: { readonly $ref: "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.inbound_transfer"]; readonly type: "string"; }; readonly origin_payment_method: { readonly description: "The origin payment method to be debited for an InboundTransfer."; readonly maxLength: 5000; readonly type: "string"; }; readonly origin_payment_method_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/inbound_transfers"; }]; readonly description: "Details about the PaymentMethod for an InboundTransfer."; readonly nullable: true; }; readonly returned: { readonly description: "Returns `true` if the funds for an InboundTransfer were returned after the InboundTransfer went to the `succeeded` state."; readonly nullable: true; readonly type: "boolean"; }; readonly statement_descriptor: { readonly description: "Statement descriptor shown when funds are debited from the source. Not all payment networks support `statement_descriptor`."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Status of the InboundTransfer: `processing`, `succeeded`, `failed`, and `canceled`. An InboundTransfer is `processing` if it is created and pending. The status changes to `succeeded` once the funds have been \"confirmed\" and a `transaction` is created and posted. The status changes to `failed` if the transfer fails."; readonly enum: readonly ["canceled", "failed", "processing", "succeeded"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "cancelable", "created", "currency", "financial_account", "id", "linked_flows", "livemode", "metadata", "object", "origin_payment_method", "statement_descriptor", "status", "status_transitions"]; readonly title: "TreasuryInboundTransfersResourceInboundTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["failure_details", "linked_flows", "origin_payment_method_details", "status_transitions", "transaction"]; readonly 'x-resourceId': "treasury.inbound_transfer"; }; export declare const treasury_outbound_paymentSchema: { readonly description: "Use OutboundPayments to send funds to another party's external bank account or [FinancialAccount](https://stripe.com/docs/api#financial_accounts). To send money to an account belonging to the same user, use an [OutboundTransfer](https://stripe.com/docs/api#outbound_transfers).\n\nSimulate OutboundPayment state changes with the `/v1/test_helpers/treasury/outbound_payments` endpoints. These methods can only be called on test mode objects."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly cancelable: { readonly description: "Returns `true` if the object can be canceled, and `false` otherwise."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly customer: { readonly description: "ID of the [customer](https://stripe.com/docs/api/customers) to whom an OutboundPayment is sent."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination_payment_method: { readonly description: "The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using `destination_payment_method_data`."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination_payment_method_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/outbound_payments_payment_method_details"; }]; readonly description: "Details about the PaymentMethod for an OutboundPayment."; readonly nullable: true; }; readonly end_user_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_end_user_details"; }]; readonly description: "Details about the end user."; readonly nullable: true; }; readonly expected_arrival_date: { readonly description: "The date when funds are expected to arrive in the destination account."; readonly format: "unix-time"; readonly type: "integer"; }; readonly financial_account: { readonly description: "The FinancialAccount that funds were pulled from."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.outbound_payment"]; readonly type: "string"; }; readonly returned_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_returned_status"; }]; readonly description: "Details about a returned OutboundPayment. Only set when the status is `returned`."; readonly nullable: true; }; readonly statement_descriptor: { readonly description: "The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer)."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Current status of the OutboundPayment: `processing`, `failed`, `posted`, `returned`, `canceled`. An OutboundPayment is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundPayment has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundPayment fails to arrive at its destination, its status will change to `returned`."; readonly enum: readonly ["canceled", "failed", "posted", "processing", "returned"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_status_transitions"; }; readonly tracking_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_outbound_payment_resource_tracking_details"; }]; readonly description: "Details about network-specific tracking information if available."; readonly nullable: true; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "cancelable", "created", "currency", "expected_arrival_date", "financial_account", "id", "livemode", "metadata", "object", "statement_descriptor", "status", "status_transitions", "transaction"]; readonly title: "TreasuryOutboundPaymentsResourceOutboundPayment"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination_payment_method_details", "end_user_details", "returned_details", "status_transitions", "tracking_details", "transaction"]; readonly 'x-resourceId': "treasury.outbound_payment"; }; export declare const treasury_outbound_transferSchema: { readonly description: "Use OutboundTransfers to transfer funds from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) to a PaymentMethod belonging to the same entity. To send funds to a different party, use [OutboundPayments](https://stripe.com/docs/api#outbound_payments) instead. You can send funds over ACH rails or through a domestic wire transfer to a user's own external bank account.\n\nSimulate OutboundTransfer state changes with the `/v1/test_helpers/treasury/outbound_transfers` endpoints. These methods can only be called on test mode objects."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly cancelable: { readonly description: "Returns `true` if the object can be canceled, and `false` otherwise."; readonly type: "boolean"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination_payment_method: { readonly description: "The PaymentMethod used as the payment instrument for an OutboundTransfer."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly destination_payment_method_details: { readonly $ref: "#/components/schemas/outbound_transfers_payment_method_details"; }; readonly expected_arrival_date: { readonly description: "The date when funds are expected to arrive in the destination account."; readonly format: "unix-time"; readonly type: "integer"; }; readonly financial_account: { readonly description: "The FinancialAccount that funds were pulled from."; readonly maxLength: 5000; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.outbound_transfer"]; readonly type: "string"; }; readonly returned_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_outbound_transfers_resource_returned_details"; }]; readonly description: "Details about a returned OutboundTransfer. Only set when the status is `returned`."; readonly nullable: true; }; readonly statement_descriptor: { readonly description: "Information about the OutboundTransfer to be sent to the recipient account."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "Current status of the OutboundTransfer: `processing`, `failed`, `canceled`, `posted`, `returned`. An OutboundTransfer is `processing` if it has been created and is pending. The status changes to `posted` once the OutboundTransfer has been \"confirmed\" and funds have left the account, or to `failed` or `canceled`. If an OutboundTransfer fails to arrive at its destination, its status will change to `returned`."; readonly enum: readonly ["canceled", "failed", "posted", "processing", "returned"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_outbound_transfers_resource_status_transitions"; }; readonly tracking_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_details"; }]; readonly description: "Details about network-specific tracking information if available."; readonly nullable: true; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "cancelable", "created", "currency", "destination_payment_method_details", "expected_arrival_date", "financial_account", "id", "livemode", "metadata", "object", "statement_descriptor", "status", "status_transitions", "transaction"]; readonly title: "TreasuryOutboundTransfersResourceOutboundTransfer"; readonly type: "object"; readonly 'x-expandableFields': readonly ["destination_payment_method_details", "returned_details", "status_transitions", "tracking_details", "transaction"]; readonly 'x-resourceId': "treasury.outbound_transfer"; }; export declare const treasury_received_creditSchema: { readonly description: "ReceivedCredits represent funds sent to a [FinancialAccount](https://stripe.com/docs/api#financial_accounts) (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly type: "string"; }; readonly failure_code: { readonly description: "Reason for the failure. A ReceivedCredit might fail because the receiving FinancialAccount is closed or frozen."; readonly enum: readonly ["account_closed", "account_frozen", "other"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly financial_account: { readonly description: "The FinancialAccount that received the funds."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly initiating_payment_method_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"; }; readonly linked_flows: { readonly $ref: "#/components/schemas/treasury_received_credits_resource_linked_flows"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly network: { readonly description: "The rails used to send the funds."; readonly enum: readonly ["ach", "card", "stripe", "us_domestic_wire"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.received_credit"]; readonly type: "string"; }; readonly reversal_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_received_credits_resource_reversal_details"; }]; readonly description: "Details describing when a ReceivedCredit may be reversed."; readonly nullable: true; }; readonly status: { readonly description: "Status of the ReceivedCredit. ReceivedCredits are created either `succeeded` (approved) or `failed` (declined). If a ReceivedCredit is declined, the failure reason can be found in the `failure_code` field."; readonly enum: readonly ["failed", "succeeded"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "description", "id", "initiating_payment_method_details", "linked_flows", "livemode", "network", "object", "status"]; readonly title: "TreasuryReceivedCreditsResourceReceivedCredit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["initiating_payment_method_details", "linked_flows", "reversal_details", "transaction"]; readonly 'x-resourceId': "treasury.received_credit"; }; export declare const treasury_received_debitSchema: { readonly description: "ReceivedDebits represent funds pulled from a [FinancialAccount](https://stripe.com/docs/api#financial_accounts). These are not initiated from the FinancialAccount."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly type: "string"; }; readonly failure_code: { readonly description: "Reason for the failure. A ReceivedDebit might fail because the FinancialAccount doesn't have sufficient funds, is closed, or is frozen."; readonly enum: readonly ["account_closed", "account_frozen", "insufficient_funds", "other"]; readonly nullable: true; readonly type: "string"; }; readonly financial_account: { readonly description: "The FinancialAccount that funds were pulled from."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly hosted_regulatory_receipt_url: { readonly description: "A [hosted transaction receipt](https://stripe.com/docs/treasury/moving-money/regulatory-receipts) URL that is provided when money movement is considered regulated under Stripe's money transmission licenses."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly initiating_payment_method_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"; }; readonly linked_flows: { readonly $ref: "#/components/schemas/treasury_received_debits_resource_linked_flows"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly network: { readonly description: "The network used for the ReceivedDebit."; readonly enum: readonly ["ach", "card", "stripe"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.received_debit"]; readonly type: "string"; }; readonly reversal_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_received_debits_resource_reversal_details"; }]; readonly description: "Details describing when a ReceivedDebit might be reversed."; readonly nullable: true; }; readonly status: { readonly description: "Status of the ReceivedDebit. ReceivedDebits are created with a status of either `succeeded` (approved) or `failed` (declined). The failure reason can be found under the `failure_code`."; readonly enum: readonly ["failed", "succeeded"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly nullable: true; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["amount", "created", "currency", "description", "id", "linked_flows", "livemode", "network", "object", "status"]; readonly title: "TreasuryReceivedDebitsResourceReceivedDebit"; readonly type: "object"; readonly 'x-expandableFields': readonly ["initiating_payment_method_details", "linked_flows", "reversal_details", "transaction"]; readonly 'x-resourceId': "treasury.received_debit"; }; export declare const treasury_transactionSchema: { readonly description: "Transactions represent changes to a [FinancialAccount's](https://stripe.com/docs/api#financial_accounts) balance."; readonly properties: { readonly amount: { readonly description: "Amount (in cents) transferred."; readonly type: "integer"; }; readonly balance_impact: { readonly $ref: "#/components/schemas/treasury_transactions_resource_balance_impact"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly description: { readonly description: "An arbitrary string attached to the object. Often useful for displaying to users."; readonly maxLength: 5000; readonly type: "string"; }; readonly entries: { readonly description: "A list of TransactionEntries that are part of this Transaction. This cannot be expanded in any list endpoints."; readonly nullable: true; readonly properties: { readonly data: { readonly description: "Details about each object."; readonly items: { readonly $ref: "#/components/schemas/treasury.transaction_entry"; }; readonly type: "array"; }; readonly has_more: { readonly description: "True if this list has another page of items after this one that can be fetched."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value. Always has the value `list`."; readonly enum: readonly ["list"]; readonly type: "string"; }; readonly url: { readonly description: "The URL where this list can be accessed."; readonly maxLength: 5000; readonly pattern: "^/v1/treasury/transaction_entries"; readonly type: "string"; }; }; readonly required: readonly ["data", "has_more", "object", "url"]; readonly title: "TreasuryTransactionsResourceTransactionEntryList"; readonly type: "object"; readonly 'x-expandableFields': readonly ["data"]; }; readonly financial_account: { readonly description: "The FinancialAccount associated with this object."; readonly maxLength: 5000; readonly type: "string"; }; readonly flow: { readonly description: "ID of the flow that created the Transaction."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly flow_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_transactions_resource_flow_details"; }]; readonly description: "Details of the flow that created the Transaction."; readonly nullable: true; }; readonly flow_type: { readonly description: "Type of the flow that created the Transaction."; readonly enum: readonly ["credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit"]; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.transaction"]; readonly type: "string"; }; readonly status: { readonly description: "Status of the Transaction."; readonly enum: readonly ["open", "posted", "void"]; readonly type: "string"; }; readonly status_transitions: { readonly $ref: "#/components/schemas/treasury_transactions_resource_abstract_transaction_resource_status_transitions"; }; }; readonly required: readonly ["amount", "balance_impact", "created", "currency", "description", "financial_account", "flow_type", "id", "livemode", "object", "status", "status_transitions"]; readonly title: "TreasuryTransactionsResourceTransaction"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_impact", "entries", "flow_details", "status_transitions"]; readonly 'x-resourceId': "treasury.transaction"; }; export declare const treasury_transaction_entrySchema: { readonly description: "TransactionEntries represent individual units of money movements within a single [Transaction](https://stripe.com/docs/api#transactions)."; readonly properties: { readonly balance_impact: { readonly $ref: "#/components/schemas/treasury_transactions_resource_balance_impact"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly currency: { readonly 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)."; readonly type: "string"; }; readonly effective_at: { readonly description: "When the TransactionEntry will impact the FinancialAccount's balance."; readonly format: "unix-time"; readonly type: "integer"; }; readonly financial_account: { readonly description: "The FinancialAccount associated with this object."; readonly maxLength: 5000; readonly type: "string"; }; readonly flow: { readonly description: "Token of the flow associated with the TransactionEntry."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly flow_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_transactions_resource_flow_details"; }]; readonly description: "Details of the flow associated with the TransactionEntry."; readonly nullable: true; }; readonly flow_type: { readonly description: "Type of the flow associated with the TransactionEntry."; readonly enum: readonly ["credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit"]; readonly type: "string"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["treasury.transaction_entry"]; readonly type: "string"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; readonly type: { readonly description: "The specific money movement that generated the TransactionEntry."; readonly enum: readonly ["credit_reversal", "credit_reversal_posting", "debit_reversal", "inbound_transfer", "inbound_transfer_return", "issuing_authorization_hold", "issuing_authorization_release", "other", "outbound_payment", "outbound_payment_cancellation", "outbound_payment_failure", "outbound_payment_posting", "outbound_payment_return", "outbound_transfer", "outbound_transfer_cancellation", "outbound_transfer_failure", "outbound_transfer_posting", "outbound_transfer_return", "received_credit", "received_debit"]; readonly type: "string"; }; }; readonly required: readonly ["balance_impact", "created", "currency", "effective_at", "financial_account", "flow_type", "id", "livemode", "object", "transaction", "type"]; readonly title: "TreasuryTransactionsResourceTransactionEntry"; readonly type: "object"; readonly 'x-expandableFields': readonly ["balance_impact", "flow_details", "transaction"]; readonly 'x-resourceId': "treasury.transaction_entry"; }; export declare const treasury_financial_accounts_resource_aba_recordSchema: { readonly description: "ABA Records contain U.S. bank account details per the ABA format."; readonly properties: { readonly account_holder_name: { readonly description: "The name of the person or business that owns the bank account."; readonly maxLength: 5000; readonly type: "string"; }; readonly account_number: { readonly description: "The account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly account_number_last4: { readonly description: "The last four characters of the account number."; readonly maxLength: 5000; readonly type: "string"; }; readonly bank_name: { readonly description: "Name of the bank."; readonly maxLength: 5000; readonly type: "string"; }; readonly routing_number: { readonly description: "Routing number for the account."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["account_holder_name", "account_number_last4", "bank_name", "routing_number"]; readonly title: "TreasuryFinancialAccountsResourceABARecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_financial_accounts_resource_aba_toggle_settingsSchema: { readonly description: "Toggle settings for enabling/disabling the ABA address feature"; readonly properties: { readonly requested: { readonly description: "Whether the FinancialAccount should have the Feature."; readonly type: "boolean"; }; readonly status: { readonly description: "Whether the Feature is operational."; readonly enum: readonly ["active", "pending", "restricted"]; readonly type: "string"; }; readonly status_details: { readonly description: "Additional details; includes at least one entry when the status is not `active`."; readonly items: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"; }; readonly type: "array"; }; }; readonly required: readonly ["requested", "status", "status_details"]; readonly title: "TreasuryFinancialAccountsResourceAbaToggleSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_details"]; }; export declare const treasury_financial_accounts_resource_ach_toggle_settingsSchema: { readonly description: "Toggle settings for enabling/disabling an ACH specific feature"; readonly properties: { readonly requested: { readonly description: "Whether the FinancialAccount should have the Feature."; readonly type: "boolean"; }; readonly status: { readonly description: "Whether the Feature is operational."; readonly enum: readonly ["active", "pending", "restricted"]; readonly type: "string"; }; readonly status_details: { readonly description: "Additional details; includes at least one entry when the status is not `active`."; readonly items: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"; }; readonly type: "array"; }; }; readonly required: readonly ["requested", "status", "status_details"]; readonly title: "TreasuryFinancialAccountsResourceAchToggleSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_details"]; }; export declare const treasury_financial_accounts_resource_balanceSchema: { readonly description: "Balance information for the FinancialAccount"; readonly properties: { readonly cash: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "Funds the user can spend right now."; readonly type: "object"; }; readonly inbound_pending: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "Funds not spendable yet, but will become available at a later time."; readonly type: "object"; }; readonly outbound_pending: { readonly additionalProperties: { readonly type: "integer"; }; readonly description: "Funds in the account, but not spendable because they are being held for pending outbound flows."; readonly type: "object"; }; }; readonly required: readonly ["cash", "inbound_pending", "outbound_pending"]; readonly title: "TreasuryFinancialAccountsResourceBalance"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_financial_accounts_resource_closed_status_detailsSchema: { readonly description: ""; readonly properties: { readonly reasons: { readonly description: "The array that contains reasons for a FinancialAccount closure."; readonly items: { readonly enum: readonly ["account_rejected", "closed_by_platform", "other"]; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["reasons"]; readonly title: "TreasuryFinancialAccountsResourceClosedStatusDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_financial_accounts_resource_financial_addressSchema: { readonly description: "FinancialAddresses contain identifying information that resolves to a FinancialAccount."; readonly properties: { readonly aba: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_aba_record"; }; readonly supported_networks: { readonly description: "The list of networks that the address supports"; readonly items: { readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly type: "array"; }; readonly type: { readonly description: "The type of financial address"; readonly enum: readonly ["aba"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["type"]; readonly title: "TreasuryFinancialAccountsResourceFinancialAddress"; readonly type: "object"; readonly 'x-expandableFields': readonly ["aba"]; }; export declare const treasury_financial_accounts_resource_financial_addresses_featuresSchema: { readonly description: "Settings related to Financial Addresses features on a Financial Account"; readonly properties: { readonly aba: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_aba_toggle_settings"; }; }; readonly title: "TreasuryFinancialAccountsResourceFinancialAddressesFeatures"; readonly type: "object"; readonly 'x-expandableFields': readonly ["aba"]; }; export declare const treasury_financial_accounts_resource_inbound_transfersSchema: { readonly description: "InboundTransfers contains inbound transfers features for a FinancialAccount."; readonly properties: { readonly ach: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings"; }; }; readonly title: "TreasuryFinancialAccountsResourceInboundTransfers"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach"]; }; export declare const treasury_financial_accounts_resource_outbound_paymentsSchema: { readonly description: "Settings related to Outbound Payments features on a Financial Account"; readonly properties: { readonly ach: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings"; }; readonly us_domestic_wire: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"; }; }; readonly title: "TreasuryFinancialAccountsResourceOutboundPayments"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach", "us_domestic_wire"]; }; export declare const treasury_financial_accounts_resource_outbound_transfersSchema: { readonly description: "OutboundTransfers contains outbound transfers features for a FinancialAccount."; readonly properties: { readonly ach: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_ach_toggle_settings"; }; readonly us_domestic_wire: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggle_settings"; }; }; readonly title: "TreasuryFinancialAccountsResourceOutboundTransfers"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach", "us_domestic_wire"]; }; export declare const treasury_financial_accounts_resource_platform_restrictionsSchema: { readonly description: "Restrictions that a Connect Platform has placed on this FinancialAccount."; readonly properties: { readonly inbound_flows: { readonly description: "Restricts all inbound money movement."; readonly enum: readonly ["restricted", "unrestricted"]; readonly nullable: true; readonly type: "string"; }; readonly outbound_flows: { readonly description: "Restricts all outbound money movement."; readonly enum: readonly ["restricted", "unrestricted"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryFinancialAccountsResourcePlatformRestrictions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_financial_accounts_resource_status_detailsSchema: { readonly description: ""; readonly properties: { readonly closed: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_closed_status_details"; }]; readonly description: "Details related to the closure of this FinancialAccount"; readonly nullable: true; }; }; readonly title: "TreasuryFinancialAccountsResourceStatusDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["closed"]; }; export declare const treasury_financial_accounts_resource_toggle_settingsSchema: { readonly description: "Toggle settings for enabling/disabling a feature"; readonly properties: { readonly requested: { readonly description: "Whether the FinancialAccount should have the Feature."; readonly type: "boolean"; }; readonly status: { readonly description: "Whether the Feature is operational."; readonly enum: readonly ["active", "pending", "restricted"]; readonly type: "string"; }; readonly status_details: { readonly description: "Additional details; includes at least one entry when the status is not `active`."; readonly items: { readonly $ref: "#/components/schemas/treasury_financial_accounts_resource_toggles_setting_status_details"; }; readonly type: "array"; }; }; readonly required: readonly ["requested", "status", "status_details"]; readonly title: "TreasuryFinancialAccountsResourceToggleSettings"; readonly type: "object"; readonly 'x-expandableFields': readonly ["status_details"]; }; export declare const treasury_financial_accounts_resource_toggles_setting_status_detailsSchema: { readonly description: "Additional details on the FinancialAccount Features information."; readonly properties: { readonly code: { readonly description: "Represents the reason why the status is `pending` or `restricted`."; readonly enum: readonly ["activating", "capability_not_requested", "financial_account_closed", "rejected_other", "rejected_unsupported_business", "requirements_past_due", "requirements_pending_verification", "restricted_by_platform", "restricted_other"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly resolution: { readonly description: "Represents what the user should do, if anything, to activate the Feature."; readonly enum: readonly ["contact_stripe", "provide_information", "remove_restriction"]; readonly nullable: true; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly restriction: { readonly description: "The `platform_restrictions` that are restricting this Feature."; readonly enum: readonly ["inbound_flows", "outbound_flows"]; readonly type: "string"; }; }; readonly required: readonly ["code"]; readonly title: "TreasuryFinancialAccountsResourceTogglesSettingStatusDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_inbound_transfers_resource_failure_detailsSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "Reason for the failure."; readonly enum: readonly ["account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "debit_not_authorized", "incorrect_account_holder_address", "incorrect_account_holder_name", "incorrect_account_holder_tax_id", "insufficient_funds", "invalid_account_number", "invalid_currency", "no_account", "other"]; readonly type: "string"; }; }; readonly required: readonly ["code"]; readonly title: "TreasuryInboundTransfersResourceFailureDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flowsSchema: { readonly description: ""; readonly properties: { readonly received_debit: { readonly description: "If funds for this flow were returned after the flow went to the `succeeded` state, this field contains a reference to the ReceivedDebit return."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly canceled_at: { readonly description: "Timestamp describing when an InboundTransfer changed status to `canceled`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly failed_at: { readonly description: "Timestamp describing when an InboundTransfer changed status to `failed`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly succeeded_at: { readonly description: "Timestamp describing when an InboundTransfer changed status to `succeeded`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryInboundTransfersResourceInboundTransferResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_payments_resource_ach_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly trace_id: { readonly description: "ACH trace ID of the OutboundPayment for payments sent over the `ach` network."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["trace_id"]; readonly title: "TreasuryOutboundPaymentsResourceACHTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_payments_resource_outbound_payment_resource_end_user_detailsSchema: { readonly description: ""; readonly properties: { readonly ip_address: { readonly description: "IP address of the user initiating the OutboundPayment. Set if `present` is set to `true`. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly present: { readonly description: "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`."; readonly type: "boolean"; }; }; readonly required: readonly ["present"]; readonly title: "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_payments_resource_outbound_payment_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly canceled_at: { readonly description: "Timestamp describing when an OutboundPayment changed status to `canceled`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly failed_at: { readonly description: "Timestamp describing when an OutboundPayment changed status to `failed`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly posted_at: { readonly description: "Timestamp describing when an OutboundPayment changed status to `posted`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly returned_at: { readonly description: "Timestamp describing when an OutboundPayment changed status to `returned`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryOutboundPaymentsResourceOutboundPaymentResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_payments_resource_outbound_payment_resource_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly ach: { readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_ach_tracking_details"; }; readonly type: { readonly description: "The US bank account network used to send funds."; readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; }; readonly us_domestic_wire: { readonly $ref: "#/components/schemas/treasury_outbound_payments_resource_us_domestic_wire_tracking_details"; }; }; readonly required: readonly ["type"]; readonly title: "TreasuryOutboundPaymentsResourceOutboundPaymentResourceTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach", "us_domestic_wire"]; }; export declare const treasury_outbound_payments_resource_returned_statusSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "Reason for the return."; readonly enum: readonly ["account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other"]; readonly type: "string"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["code", "transaction"]; readonly title: "TreasuryOutboundPaymentsResourceReturnedStatus"; readonly type: "object"; readonly 'x-expandableFields': readonly ["transaction"]; }; export declare const treasury_outbound_payments_resource_us_domestic_wire_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly imad: { readonly description: "IMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network."; readonly maxLength: 5000; readonly type: "string"; }; readonly omad: { readonly description: "OMAD of the OutboundPayment for payments sent over the `us_domestic_wire` network."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["imad"]; readonly title: "TreasuryOutboundPaymentsResourceUSDomesticWireTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_transfers_resource_ach_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly trace_id: { readonly description: "ACH trace ID of the OutboundTransfer for transfers sent over the `ach` network."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["trace_id"]; readonly title: "TreasuryOutboundTransfersResourceACHTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_transfers_resource_outbound_transfer_resource_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly ach: { readonly $ref: "#/components/schemas/treasury_outbound_transfers_resource_ach_tracking_details"; }; readonly type: { readonly description: "The US bank account network used to send funds."; readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; }; readonly us_domestic_wire: { readonly $ref: "#/components/schemas/treasury_outbound_transfers_resource_us_domestic_wire_tracking_details"; }; }; readonly required: readonly ["type"]; readonly title: "TreasuryOutboundTransfersResourceOutboundTransferResourceTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["ach", "us_domestic_wire"]; }; export declare const treasury_outbound_transfers_resource_returned_detailsSchema: { readonly description: ""; readonly properties: { readonly code: { readonly description: "Reason for the return."; readonly enum: readonly ["account_closed", "account_frozen", "bank_account_restricted", "bank_ownership_changed", "declined", "incorrect_account_holder_name", "invalid_account_number", "invalid_currency", "no_account", "other"]; readonly type: "string"; }; readonly transaction: { readonly anyOf: readonly [{ readonly maxLength: 5000; readonly type: "string"; }, { readonly $ref: "#/components/schemas/treasury.transaction"; }]; readonly description: "The Transaction associated with this object."; readonly 'x-expansionResources': { readonly oneOf: readonly [{ readonly $ref: "#/components/schemas/treasury.transaction"; }]; }; }; }; readonly required: readonly ["code", "transaction"]; readonly title: "TreasuryOutboundTransfersResourceReturnedDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["transaction"]; }; export declare const treasury_outbound_transfers_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly canceled_at: { readonly description: "Timestamp describing when an OutboundTransfer changed status to `canceled`"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly failed_at: { readonly description: "Timestamp describing when an OutboundTransfer changed status to `failed`"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly posted_at: { readonly description: "Timestamp describing when an OutboundTransfer changed status to `posted`"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly returned_at: { readonly description: "Timestamp describing when an OutboundTransfer changed status to `returned`"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryOutboundTransfersResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_outbound_transfers_resource_us_domestic_wire_tracking_detailsSchema: { readonly description: ""; readonly properties: { readonly imad: { readonly description: "IMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network."; readonly maxLength: 5000; readonly type: "string"; }; readonly omad: { readonly description: "OMAD of the OutboundTransfer for transfers sent over the `us_domestic_wire` network."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["imad"]; readonly title: "TreasuryOutboundTransfersResourceUSDomesticWireTrackingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_credits_resource_linked_flowsSchema: { readonly description: ""; readonly properties: { readonly credit_reversal: { readonly description: "The CreditReversal created as a result of this ReceivedCredit being reversed."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuing_authorization: { readonly description: "Set if the ReceivedCredit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuing_transaction: { readonly description: "Set if the ReceivedCredit is also viewable as an [Issuing transaction](https://stripe.com/docs/api#issuing_transactions) object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly source_flow: { readonly description: "ID of the source flow. Set if `network` is `stripe` and the source flow is visible to the user. Examples of source flows include OutboundPayments, payouts, or CreditReversals."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly source_flow_details: { readonly anyOf: readonly [{ readonly $ref: "#/components/schemas/treasury_received_credits_resource_source_flows_details"; }]; readonly description: "The expandable object of the source flow."; readonly nullable: true; }; readonly source_flow_type: { readonly description: "The type of flow that originated the ReceivedCredit (for example, `outbound_payment`)."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryReceivedCreditsResourceLinkedFlows"; readonly type: "object"; readonly 'x-expandableFields': readonly ["source_flow_details"]; }; export declare const treasury_received_credits_resource_reversal_detailsSchema: { readonly description: ""; readonly properties: { readonly deadline: { readonly description: "Time before which a ReceivedCredit can be reversed."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly restricted_reason: { readonly description: "Set if a ReceivedCredit cannot be reversed."; readonly enum: readonly ["already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryReceivedCreditsResourceReversalDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_credits_resource_source_flows_detailsSchema: { readonly description: ""; readonly properties: { readonly credit_reversal: { readonly $ref: "#/components/schemas/treasury.credit_reversal"; }; readonly outbound_payment: { readonly $ref: "#/components/schemas/treasury.outbound_payment"; }; readonly payout: { readonly $ref: "#/components/schemas/payout"; }; readonly type: { readonly description: "The type of the source flow that originated the ReceivedCredit."; readonly enum: readonly ["credit_reversal", "other", "outbound_payment", "payout"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; }; readonly required: readonly ["type"]; readonly title: "TreasuryReceivedCreditsResourceSourceFlowsDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["credit_reversal", "outbound_payment", "payout"]; }; export declare const treasury_received_credits_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly posted_at: { readonly description: "Timestamp describing when the CreditReversal changed status to `posted`"; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryReceivedCreditsResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_debits_resource_debit_reversal_linked_flowsSchema: { readonly description: ""; readonly properties: { readonly issuing_dispute: { readonly description: "Set if there is an Issuing dispute associated with the DebitReversal."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_debits_resource_linked_flowsSchema: { readonly description: ""; readonly properties: { readonly debit_reversal: { readonly description: "The DebitReversal created as a result of this ReceivedDebit being reversed."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly inbound_transfer: { readonly description: "Set if the ReceivedDebit is associated with an InboundTransfer's return of funds."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuing_authorization: { readonly description: "Set if the ReceivedDebit was created due to an [Issuing Authorization](https://stripe.com/docs/api#issuing_authorizations) object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly issuing_transaction: { readonly description: "Set if the ReceivedDebit is also viewable as an [Issuing Dispute](https://stripe.com/docs/api#issuing_disputes) object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly payout: { readonly description: "Set if the ReceivedDebit was created due to a [Payout](https://stripe.com/docs/api#payouts) object."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryReceivedDebitsResourceLinkedFlows"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_debits_resource_reversal_detailsSchema: { readonly description: ""; readonly properties: { readonly deadline: { readonly description: "Time before which a ReceivedDebit can be reversed."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly restricted_reason: { readonly description: "Set if a ReceivedDebit can't be reversed."; readonly enum: readonly ["already_reversed", "deadline_passed", "network_restricted", "other", "source_flow_restricted"]; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasuryReceivedDebitsResourceReversalDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_received_debits_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly completed_at: { readonly description: "Timestamp describing when the DebitReversal changed status to `completed`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryReceivedDebitsResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_shared_resource_billing_detailsSchema: { readonly description: ""; readonly properties: { readonly address: { readonly $ref: "#/components/schemas/address"; }; readonly email: { readonly description: "Email address."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly name: { readonly description: "Full name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly required: readonly ["address"]; readonly title: "TreasurySharedResourceBillingDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["address"]; }; export declare const treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_detailsSchema: { readonly description: ""; readonly properties: { readonly balance: { readonly description: "Set when `type` is `balance`."; readonly enum: readonly ["payments"]; readonly type: "string"; }; readonly billing_details: { readonly $ref: "#/components/schemas/treasury_shared_resource_billing_details"; }; readonly financial_account: { readonly $ref: "#/components/schemas/received_payment_method_details_financial_account"; }; readonly issuing_card: { readonly description: "Set when `type` is `issuing_card`. This is an [Issuing Card](https://stripe.com/docs/api#issuing_cards) ID."; readonly maxLength: 5000; readonly type: "string"; }; readonly type: { readonly description: "Polymorphic type matching the originating money movement's source. This can be an external account, a Stripe balance, or a FinancialAccount."; readonly enum: readonly ["balance", "financial_account", "issuing_card", "stripe", "us_bank_account"]; readonly type: "string"; readonly 'x-stripeBypassValidation': true; }; readonly us_bank_account: { readonly $ref: "#/components/schemas/treasury_shared_resource_initiating_payment_method_details_us_bank_account"; }; }; readonly required: readonly ["billing_details", "type"]; readonly title: "TreasurySharedResourceInitiatingPaymentMethodDetailsInitiatingPaymentMethodDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["billing_details", "financial_account", "us_bank_account"]; }; export declare const treasury_shared_resource_initiating_payment_method_details_us_bank_accountSchema: { readonly description: ""; readonly properties: { readonly bank_name: { readonly description: "Bank name."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly last4: { readonly description: "The last four digits of the bank account number."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly routing_number: { readonly description: "The routing number for the bank account."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; }; readonly title: "TreasurySharedResourceInitiatingPaymentMethodDetailsUSBankAccount"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_transactions_resource_abstract_transaction_resource_status_transitionsSchema: { readonly description: ""; readonly properties: { readonly posted_at: { readonly description: "Timestamp describing when the Transaction changed status to `posted`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; readonly void_at: { readonly description: "Timestamp describing when the Transaction changed status to `void`."; readonly format: "unix-time"; readonly nullable: true; readonly type: "integer"; }; }; readonly title: "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_transactions_resource_balance_impactSchema: { readonly description: "Change to a FinancialAccount's balance"; readonly properties: { readonly cash: { readonly description: "The change made to funds the user can spend right now."; readonly type: "integer"; }; readonly inbound_pending: { readonly description: "The change made to funds that are not spendable yet, but will become available at a later time."; readonly type: "integer"; }; readonly outbound_pending: { readonly description: "The change made to funds in the account, but not spendable because they are being held for pending outbound flows."; readonly type: "integer"; }; }; readonly required: readonly ["cash", "inbound_pending", "outbound_pending"]; readonly title: "TreasuryTransactionsResourceBalanceImpact"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const treasury_transactions_resource_flow_detailsSchema: { readonly description: ""; readonly properties: { readonly credit_reversal: { readonly $ref: "#/components/schemas/treasury.credit_reversal"; }; readonly debit_reversal: { readonly $ref: "#/components/schemas/treasury.debit_reversal"; }; readonly inbound_transfer: { readonly $ref: "#/components/schemas/treasury.inbound_transfer"; }; readonly issuing_authorization: { readonly $ref: "#/components/schemas/issuing.authorization"; }; readonly outbound_payment: { readonly $ref: "#/components/schemas/treasury.outbound_payment"; }; readonly outbound_transfer: { readonly $ref: "#/components/schemas/treasury.outbound_transfer"; }; readonly received_credit: { readonly $ref: "#/components/schemas/treasury.received_credit"; }; readonly received_debit: { readonly $ref: "#/components/schemas/treasury.received_debit"; }; readonly type: { readonly description: "Type of the flow that created the Transaction. Set to the same value as `flow_type`."; readonly enum: readonly ["credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "other", "outbound_payment", "outbound_transfer", "received_credit", "received_debit"]; readonly type: "string"; }; }; readonly required: readonly ["type"]; readonly title: "TreasuryTransactionsResourceFlowDetails"; readonly type: "object"; readonly 'x-expandableFields': readonly ["credit_reversal", "debit_reversal", "inbound_transfer", "issuing_authorization", "outbound_payment", "outbound_transfer", "received_credit", "received_debit"]; }; export declare const us_bank_account_networksSchema: { readonly description: ""; readonly properties: { readonly preferred: { readonly description: "The preferred network."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly supported: { readonly description: "All supported networks."; readonly items: { readonly enum: readonly ["ach", "us_domestic_wire"]; readonly type: "string"; }; readonly type: "array"; }; }; readonly required: readonly ["supported"]; readonly title: "us_bank_account_networks"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const usage_recordSchema: { readonly description: "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)\n\nThis is our legacy usage-based billing API. See the [updated usage-based billing docs](https://docs.stripe.com/billing/subscriptions/usage-based)."; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["usage_record"]; readonly type: "string"; }; readonly quantity: { readonly description: "The usage quantity for the specified date."; readonly type: "integer"; }; readonly subscription_item: { readonly description: "The ID of the subscription item this usage record contains data for."; readonly maxLength: 5000; readonly type: "string"; }; readonly timestamp: { readonly description: "The timestamp when this usage occurred."; readonly format: "unix-time"; readonly type: "integer"; }; }; readonly required: readonly ["id", "livemode", "object", "quantity", "subscription_item", "timestamp"]; readonly title: "UsageRecord"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "usage_record"; }; export declare const usage_record_summarySchema: { readonly description: ""; readonly properties: { readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly invoice: { readonly description: "The invoice in which this usage period has been billed for."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["usage_record_summary"]; readonly type: "string"; }; readonly period: { readonly $ref: "#/components/schemas/period"; }; readonly subscription_item: { readonly description: "The ID of the subscription item this summary is describing."; readonly maxLength: 5000; readonly type: "string"; }; readonly total_usage: { readonly description: "The total usage within this usage period."; readonly type: "integer"; }; }; readonly required: readonly ["id", "livemode", "object", "period", "subscription_item", "total_usage"]; readonly title: "UsageRecordSummary"; readonly type: "object"; readonly 'x-expandableFields': readonly ["period"]; readonly 'x-resourceId': "usage_record_summary"; }; export declare const verification_session_redactionSchema: { readonly description: ""; readonly properties: { readonly status: { readonly description: "Indicates whether this object and its related objects have been redacted or not."; readonly enum: readonly ["processing", "redacted"]; readonly type: "string"; }; }; readonly required: readonly ["status"]; readonly title: "verification_session_redaction"; readonly type: "object"; readonly 'x-expandableFields': readonly []; }; export declare const webhook_endpointSchema: { readonly description: "You can configure [webhook endpoints](https://docs.stripe.com/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://docs.stripe.com/webhooks/configure)"; readonly properties: { readonly api_version: { readonly description: "The API version events are rendered as for this webhook endpoint."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly application: { readonly description: "The ID of the associated Connect application."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly created: { readonly description: "Time at which the object was created. Measured in seconds since the Unix epoch."; readonly format: "unix-time"; readonly type: "integer"; }; readonly description: { readonly description: "An optional description of what the webhook is used for."; readonly maxLength: 5000; readonly nullable: true; readonly type: "string"; }; readonly enabled_events: { readonly description: "The list of events to enable for this endpoint. `['*']` indicates that all events are enabled, except those that require explicit selection."; readonly items: { readonly maxLength: 5000; readonly type: "string"; }; readonly type: "array"; }; readonly id: { readonly description: "Unique identifier for the object."; readonly maxLength: 5000; readonly type: "string"; }; readonly livemode: { readonly description: "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode."; readonly type: "boolean"; }; readonly metadata: { readonly additionalProperties: { readonly maxLength: 500; readonly type: "string"; }; readonly description: "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format."; readonly type: "object"; }; readonly object: { readonly description: "String representing the object's type. Objects of the same type share the same value."; readonly enum: readonly ["webhook_endpoint"]; readonly type: "string"; }; readonly secret: { readonly description: "The endpoint's secret, used to generate [webhook signatures](https://docs.stripe.com/webhooks/signatures). Only returned at creation."; readonly maxLength: 5000; readonly type: "string"; }; readonly status: { readonly description: "The status of the webhook. It can be `enabled` or `disabled`."; readonly maxLength: 5000; readonly type: "string"; }; readonly url: { readonly description: "The URL of the webhook endpoint."; readonly maxLength: 5000; readonly type: "string"; }; }; readonly required: readonly ["created", "enabled_events", "id", "livemode", "metadata", "object", "status", "url"]; readonly title: "NotificationWebhookEndpoint"; readonly type: "object"; readonly 'x-expandableFields': readonly []; readonly 'x-resourceId': "webhook_endpoint"; }; //# sourceMappingURL=schemas.gen.d.ts.map