From 9b57bd9e86eea272e1c4a9edbfc0997cc01b303d Mon Sep 17 00:00:00 2001
From: "stripe-openapi[bot]"
<105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Tue, 17 Oct 2023 12:31:09 -0700
Subject: [PATCH] Update OpenAPI for 42d1bba8851997acb5d43933afb46e5799bf2c32
(#1108)
Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
---
api/openapi-spec/spec3.sdk.json | 18020 ++++++++++++++++++++++++------
pkg/cmd/resources_cmds.go | 427 +-
pkg/proxy/events_list.go | 10 +-
3 files changed, 15111 insertions(+), 3346 deletions(-)
diff --git a/api/openapi-spec/spec3.sdk.json b/api/openapi-spec/spec3.sdk.json
index 859d8a421..391b23358 100644
--- a/api/openapi-spec/spec3.sdk.json
+++ b/api/openapi-spec/spec3.sdk.json
@@ -245,29 +245,138 @@
"class_name": "Account",
"has_collection_class": true,
"in_package": "",
- "inner_classes": [
- "account_branding_settings",
- "account_business_profile",
- "account_capabilities",
- "account_card_payments_settings",
- "account_dashboard_settings",
- "account_decline_charge_on",
- "account_future_requirements",
- "account_payments_settings",
- "account_payout_settings",
- "account_requirements",
- "account_settings",
- "account_tos_acceptance",
- "account_unification_account_controller",
- "legal_entity_company",
- "transfer_schedule"
- ],
"polymorphic_groups": [
"deleted_payment_source",
"payment_source"
]
}
},
+ "account.application.authorized": {
+ "description": "Occurs whenever a user authorizes an application. Sent to the related application only.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/application"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.application.authorized"
+ }
+ },
+ "account.application.deauthorized": {
+ "description": "Occurs whenever a user deauthorizes an application. Sent to the related application only.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/application"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.application.deauthorized"
+ }
+ },
+ "account.external_account.created": {
+ "description": "Occurs whenever an external account is created.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.external_account.created"
+ }
+ },
+ "account.external_account.deleted": {
+ "description": "Occurs whenever an external account is deleted.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.external_account.deleted"
+ }
+ },
+ "account.external_account.updated": {
+ "description": "Occurs whenever an external account is updated.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.external_account.updated"
+ }
+ },
+ "account.updated": {
+ "description": "Occurs whenever an account status or property has changed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "account.updated"
+ }
+ },
"account_bacs_debit_payments_settings": {
"description": "",
"properties": {
@@ -282,7 +391,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebitPayments",
- "in_class": "account_settings"
+ "in_package": ""
}
},
"account_branding_settings": {
@@ -355,7 +464,7 @@
],
"x-stripeResource": {
"class_name": "SettingsBranding",
- "in_class": "account"
+ "in_package": ""
}
},
"account_business_profile": {
@@ -367,6 +476,9 @@
"nullable": true,
"type": "string"
},
+ "monthly_estimated_revenue": {
+ "$ref": "#/components/schemas/account_monthly_estimated_revenue"
+ },
"name": {
"description": "The customer-facing business name.",
"maxLength": 5000,
@@ -425,11 +537,12 @@
"title": "AccountBusinessProfile",
"type": "object",
"x-expandableFields": [
+ "monthly_estimated_revenue",
"support_address"
],
"x-stripeResource": {
"class_name": "BusinessProfile",
- "in_class": "account"
+ "in_package": ""
}
},
"account_capabilities": {
@@ -765,7 +878,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Capabilities",
- "in_class": "account"
+ "in_package": ""
}
},
"account_capability_future_requirements": {
@@ -849,7 +962,7 @@
],
"x-stripeResource": {
"class_name": "FutureRequirements",
- "in_class": "capability"
+ "in_package": ""
}
},
"account_capability_requirements": {
@@ -933,7 +1046,7 @@
],
"x-stripeResource": {
"class_name": "Requirements",
- "in_class": "capability"
+ "in_package": ""
}
},
"account_card_issuing_settings": {
@@ -950,10 +1063,7 @@
],
"x-stripeResource": {
"class_name": "SettingsCardIssuing",
- "in_class": "account_settings",
- "inner_classes": [
- "card_issuing_account_terms_of_service"
- ]
+ "in_package": ""
}
},
"account_card_payments_settings": {
@@ -993,7 +1103,7 @@
],
"x-stripeResource": {
"class_name": "SettingsCardPayments",
- "in_class": "account"
+ "in_package": ""
}
},
"account_dashboard_settings": {
@@ -1021,7 +1131,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SettingsDashboard",
- "in_class": "account"
+ "in_package": ""
}
},
"account_decline_charge_on": {
@@ -1045,7 +1155,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DeclineChargeOn",
- "in_class": "account"
+ "in_package": ""
}
},
"account_future_requirements": {
@@ -1134,11 +1244,11 @@
],
"x-stripeResource": {
"class_name": "FutureRequirements",
- "in_class": "account"
+ "in_package": ""
}
},
"account_link": {
- "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/connect-onboarding)",
+ "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)",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
@@ -1187,6 +1297,30 @@
"in_package": ""
}
},
+ "account_monthly_estimated_revenue": {
+ "description": "",
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "AccountMonthlyEstimatedRevenue",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MonthlyEstimatedRevenue",
+ "in_package": ""
+ }
+ },
"account_payments_settings": {
"description": "",
"properties": {
@@ -1233,7 +1367,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SettingsPayments",
- "in_class": "account"
+ "in_package": ""
}
},
"account_payout_settings": {
@@ -1265,7 +1399,7 @@
],
"x-stripeResource": {
"class_name": "SettingsPayouts",
- "in_class": "account"
+ "in_package": ""
}
},
"account_requirements": {
@@ -1354,11 +1488,7 @@
],
"x-stripeResource": {
"class_name": "Requirements",
- "in_class": "account",
- "inner_classes": [
- "account_requirements_alternative",
- "account_requirements_error"
- ]
+ "in_package": ""
}
},
"account_requirements_alternative": {
@@ -1390,7 +1520,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Alternative",
- "in_class": "account_requirements"
+ "in_package": ""
}
},
"account_requirements_error": {
@@ -1400,15 +1530,51 @@
"description": "The code for the type of error.",
"enum": [
"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_length",
+ "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",
@@ -1434,6 +1600,7 @@
"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",
@@ -1445,6 +1612,7 @@
"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"
@@ -1473,7 +1641,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Errors",
- "in_class": "account_requirements"
+ "in_package": ""
}
},
"account_sepa_debit_payments_settings": {
@@ -1490,7 +1658,68 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebitPayments",
- "in_class": "account_settings"
+ "in_package": ""
+ }
+ },
+ "account_session": {
+ "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)",
+ "properties": {
+ "account": {
+ "description": "The ID of the account the AccountSession was created for",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "client_secret": {
+ "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.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "components": {
+ "$ref": "#/components/schemas/connect_embedded_account_session_create_components"
+ },
+ "expires_at": {
+ "description": "The timestamp at which this AccountSession will expire.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "account_session"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "account",
+ "client_secret",
+ "components",
+ "expires_at",
+ "livemode",
+ "object"
+ ],
+ "title": "ConnectEmbeddedMethodAccountSessionCreateMethodAccountSession",
+ "type": "object",
+ "x-expandableFields": [
+ "components"
+ ],
+ "x-resourceId": "account_session",
+ "x-stripeOperations": [
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/account_sessions"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "AccountSession",
+ "in_package": ""
}
},
"account_settings": {
@@ -1545,13 +1774,7 @@
],
"x-stripeResource": {
"class_name": "Settings",
- "in_class": "account",
- "inner_classes": [
- "account_bacs_debit_payments_settings",
- "account_card_issuing_settings",
- "account_sepa_debit_payments_settings",
- "account_treasury_settings"
- ]
+ "in_package": ""
}
},
"account_terms_of_service": {
@@ -1583,7 +1806,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TosAcceptance",
- "in_class": "account_treasury_settings"
+ "in_package": ""
}
},
"account_tos_acceptance": {
@@ -1618,7 +1841,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TosAcceptance",
- "in_class": "account"
+ "in_package": ""
}
},
"account_treasury_settings": {
@@ -1635,10 +1858,7 @@
],
"x-stripeResource": {
"class_name": "SettingsTreasury",
- "in_class": "account_settings",
- "inner_classes": [
- "account_terms_of_service"
- ]
+ "in_package": ""
}
},
"account_unification_account_controller": {
@@ -1665,7 +1885,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Controller",
- "in_class": "account"
+ "in_package": ""
}
},
"address": {
@@ -1724,28 +1944,6 @@
"in_package": ""
}
},
- "alternate_statement_descriptors": {
- "description": "",
- "properties": {
- "kana": {
- "description": "The Kana variation of the descriptor.",
- "maxLength": 5000,
- "type": "string"
- },
- "kanji": {
- "description": "The Kanji variation of the descriptor.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "AlternateStatementDescriptors",
- "type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AlternateStatementDescriptors",
- "in_class": "charge"
- }
- },
"api_errors": {
"description": "",
"properties": {
@@ -1900,6 +2098,7 @@
"sku_inactive",
"state_unsupported",
"status_transition_invalid",
+ "stripe_tax_inactive",
"tax_id_invalid",
"taxes_calculation_failed",
"terminal_location_country_unsupported",
@@ -2120,11 +2319,11 @@
}
},
"amount": {
- "description": "Amount earned, in %s.",
+ "description": "Amount earned, in cents (or local equivalent).",
"type": "integer"
},
"amount_refunded": {
- "description": "Amount in %s refunded (can be less than the amount attribute on the fee if a partial refund was issued)",
+ "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the fee if a partial refund was issued)",
"type": "integer"
},
"application": {
@@ -2326,6 +2525,54 @@
]
}
},
+ "application_fee.created": {
+ "description": "Occurs whenever an application fee is created on a charge.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/application_fee"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "application_fee.created"
+ }
+ },
+ "application_fee.refund.updated": {
+ "description": "Occurs whenever an application fee refund is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/fee_refund"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "application_fee.refund.updated"
+ }
+ },
+ "application_fee.refunded": {
+ "description": "Occurs whenever an application fee is refunded, whether from refunding a charge or from [refunding the application fee directly](#fee_refunds). This includes partial refunds.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/application_fee"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "application_fee.refunded"
+ }
+ },
"apps.secret": {
"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)",
"properties": {
@@ -2424,10 +2671,7 @@
"x-stripeResource": {
"class_name": "Secret",
"has_collection_class": true,
- "in_package": "Apps",
- "inner_classes": [
- "secret_service_resource_scope"
- ]
+ "in_package": "Apps"
}
},
"automatic_tax": {
@@ -2457,28 +2701,28 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "invoice"
+ "in_package": ""
}
},
"balance": {
"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)",
"properties": {
"available": {
- "description": "Funds that are available to be transferred or paid out, whether automatically by Stripe or explicitly via the [Transfers API](https://stripe.com/docs/api#transfers) or [Payouts API](https://stripe.com/docs/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property.",
+ "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.",
"items": {
"$ref": "#/components/schemas/balance_amount"
},
"type": "array"
},
"connect_reserved": {
- "description": "Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.",
+ "description": "Funds held due to negative balances on connected Custom accounts. You can find the connect reserve balance for each currency and payment type in the `source_types` property.",
"items": {
"$ref": "#/components/schemas/balance_amount"
},
"type": "array"
},
"instant_available": {
- "description": "Funds that can be paid out using Instant Payouts.",
+ "description": "Funds that you can pay out using Instant Payouts.",
"items": {
"$ref": "#/components/schemas/balance_amount"
},
@@ -2499,7 +2743,7 @@
"type": "string"
},
"pending": {
- "description": "Funds that are not yet available in the balance. The pending balance for each currency, and for each payment type, can be found in the `source_types` property.",
+ "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.",
"items": {
"$ref": "#/components/schemas/balance_amount"
},
@@ -2533,11 +2777,23 @@
],
"x-stripeResource": {
"class_name": "Balance",
- "in_package": "",
- "inner_classes": [
- "balance_amount",
- "balance_detail"
- ]
+ "in_package": ""
+ }
+ },
+ "balance.available": {
+ "description": "Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/balance"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "balance.available"
}
},
"balance_amount": {
@@ -2566,10 +2822,7 @@
],
"x-stripeResource": {
"class_name": "Money",
- "in_class": "balance",
- "inner_classes": [
- "balance_amount_by_source_type"
- ]
+ "in_package": ""
}
},
"balance_amount_by_source_type": {
@@ -2593,7 +2846,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SourceTypes",
- "in_class": "balance_amount"
+ "in_package": ""
}
},
"balance_detail": {
@@ -2617,18 +2870,18 @@
],
"x-stripeResource": {
"class_name": "Details",
- "in_class": "balance"
+ "in_package": ""
}
},
"balance_transaction": {
- "description": "Balance transactions represent funds moving through your Stripe account.\nThey're created for every type of transaction that comes into or flows out of your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://stripe.com/docs/reports/balance-transaction-types)",
+ "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)",
"properties": {
"amount": {
- "description": "Gross amount of the transaction, in %s.",
+ "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.",
"type": "integer"
},
"available_on": {
- "description": "The date the transaction's net funds will become available in the Stripe balance.",
+ "description": "The date that the transaction's net funds become available in the Stripe balance.",
"format": "unix-time",
"type": "integer"
},
@@ -2648,16 +2901,16 @@
"type": "string"
},
"exchange_rate": {
- "description": "The exchange rate used, if applicable, for this transaction. Specifically, if money was converted from currency A to currency B, then the `amount` in currency A, times `exchange_rate`, would be the `amount` in currency B. For example, suppose you charged a customer 10.00 EUR. Then the PaymentIntent's `amount` would be `1000` and `currency` would be `eur`. Suppose this was converted into 12.34 USD in your Stripe account. Then the BalanceTransaction's `amount` would be `1234`, `currency` would be `usd`, and `exchange_rate` would be `1.234`.",
+ "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`.",
"nullable": true,
"type": "number"
},
"fee": {
- "description": "Fees (in %s) paid for this transaction.",
+ "description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.",
"type": "integer"
},
"fee_details": {
- "description": "Detailed breakdown of fees (in %s) paid for this transaction.",
+ "description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.",
"items": {
"$ref": "#/components/schemas/fee"
},
@@ -2669,7 +2922,7 @@
"type": "string"
},
"net": {
- "description": "Net amount of the transaction, in %s.",
+ "description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`",
"type": "integer"
},
"object": {
@@ -2680,7 +2933,7 @@
"type": "string"
},
"reporting_category": {
- "description": "[Learn more](https://stripe.com/docs/reports/reporting-categories) about how reporting categories can help you understand balance transactions from an accounting perspective.",
+ "description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.",
"maxLength": 5000,
"type": "string"
},
@@ -2694,7 +2947,7 @@
"$ref": "#/components/schemas/balance_transaction_source"
}
],
- "description": "The Stripe object to which this transaction is related.",
+ "description": "This transaction relates to the Stripe object.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -2705,12 +2958,12 @@
}
},
"status": {
- "description": "If the transaction's net funds are available in the Stripe balance yet. Either `available` or `pending`.",
+ "description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.",
"maxLength": 5000,
"type": "string"
},
"type": {
- "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. [Learn more](https://stripe.com/docs/reports/balance-transaction-types) about balance transaction types and what they represent. If you are looking to classify transactions for accounting purposes, you might want to consider `reporting_category` instead.",
+ "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `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.",
"enum": [
"adjustment",
"advance",
@@ -2725,9 +2978,16 @@
"issuing_authorization_release",
"issuing_dispute",
"issuing_transaction",
+ "obligation_inbound",
+ "obligation_outbound",
+ "obligation_payout",
+ "obligation_payout_failure",
+ "obligation_reversal_inbound",
+ "obligation_reversal_outbound",
"payment",
"payment_failure_refund",
"payment_refund",
+ "payment_reversal",
"payout",
"payout_cancel",
"payout_failure",
@@ -2791,10 +3051,7 @@
"x-stripeResource": {
"class_name": "BalanceTransaction",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "fee"
- ]
+ "in_package": ""
}
},
"balance_transaction_source": {
@@ -2808,6 +3065,9 @@
{
"$ref": "#/components/schemas/connect_collection_transfer"
},
+ {
+ "$ref": "#/components/schemas/customer_cash_balance_transaction"
+ },
{
"$ref": "#/components/schemas/dispute"
},
@@ -2965,7 +3225,7 @@
"$ref": "#/components/schemas/external_account_requirements"
}
],
- "description": "Information about upcoming new requirements for the bank account, including what information needs to be collected.",
+ "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.",
"nullable": true
},
"id": {
@@ -3147,7 +3407,7 @@
],
"x-stripeResource": {
"class_name": "AccountHolder",
- "in_class": "financial_connections.account"
+ "in_package": ""
}
},
"bank_connections_resource_balance": {
@@ -3193,11 +3453,7 @@
],
"x-stripeResource": {
"class_name": "Balance",
- "in_class": "financial_connections.account",
- "inner_classes": [
- "bank_connections_resource_balance_api_resource_cash_balance",
- "bank_connections_resource_balance_api_resource_credit_balance"
- ]
+ "in_package": ""
}
},
"bank_connections_resource_balance_api_resource_cash_balance": {
@@ -3220,7 +3476,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CashBalance",
- "in_class": "bank_connections_resource_balance"
+ "in_package": ""
}
},
"bank_connections_resource_balance_api_resource_credit_balance": {
@@ -3243,7 +3499,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CreditBalance",
- "in_class": "bank_connections_resource_balance"
+ "in_package": ""
}
},
"bank_connections_resource_balance_refresh": {
@@ -3273,7 +3529,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BalanceRefresh",
- "in_class": "financial_connections.account"
+ "in_package": ""
}
},
"bank_connections_resource_link_account_session_filters": {
@@ -3297,7 +3553,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Filters",
- "in_class": "financial_connections.session"
+ "in_package": ""
}
},
"bank_connections_resource_ownership_refresh": {
@@ -3327,7 +3583,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "OwnershipRefresh",
- "in_class": "financial_connections.account"
+ "in_package": ""
}
},
"billing_details": {
@@ -3374,7 +3630,7 @@
],
"x-stripeResource": {
"class_name": "BillingDetails",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"billing_portal.configuration": {
@@ -3522,12 +3778,39 @@
"x-stripeResource": {
"class_name": "Configuration",
"has_collection_class": true,
- "in_package": "BillingPortal",
- "inner_classes": [
- "portal_business_profile",
- "portal_features",
- "portal_login_page"
- ]
+ "in_package": "BillingPortal"
+ }
+ },
+ "billing_portal.configuration.created": {
+ "description": "Occurs whenever a portal configuration is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/billing_portal.configuration"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "billing_portal.configuration.created"
+ }
+ },
+ "billing_portal.configuration.updated": {
+ "description": "Occurs whenever a portal configuration is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/billing_portal.configuration"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "billing_portal.configuration.updated"
}
},
"billing_portal.session": {
@@ -3690,23 +3973,36 @@
],
"x-stripeResource": {
"class_name": "Session",
- "in_package": "BillingPortal",
- "inner_classes": [
- "portal_flows_flow"
- ]
+ "in_package": "BillingPortal"
+ }
+ },
+ "billing_portal.session.created": {
+ "description": "Occurs whenever a portal session is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/billing_portal.session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "billing_portal.session.created"
}
},
"cancellation_details": {
"description": "",
"properties": {
"comment": {
- "description": "Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user.",
+ "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"feedback": {
- "description": "The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user.",
+ "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
"enum": [
"customer_service",
"low_quality",
@@ -3721,7 +4017,7 @@
"type": "string"
},
"reason": {
- "description": "Why this subscription was cancelled.",
+ "description": "Why this subscription was canceled.",
"enum": [
"cancellation_requested",
"payment_disputed",
@@ -3741,7 +4037,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CancellationDetails",
- "in_class": "subscription"
+ "in_package": ""
}
},
"capability": {
@@ -3862,11 +4158,23 @@
"x-stripeResource": {
"class_name": "Capability",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "account_capability_future_requirements",
- "account_capability_requirements"
- ]
+ "in_package": ""
+ }
+ },
+ "capability.updated": {
+ "description": "Occurs whenever a capability has new requirements or a new status.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/capability"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "capability.updated"
}
},
"card": {
@@ -4025,7 +4333,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -4190,7 +4498,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TosAcceptance",
- "in_class": "account_card_issuing_settings"
+ "in_package": ""
}
},
"card_mandate_payment_method_details": {
@@ -4201,7 +4509,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"cash_balance": {
@@ -4266,28 +4574,38 @@
],
"x-stripeResource": {
"class_name": "CashBalance",
- "in_package": "",
- "inner_classes": [
- "customer_balance_customer_balance_settings"
- ]
+ "in_package": ""
+ }
+ },
+ "cash_balance.funds_available": {
+ "description": "Occurs whenever there is a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you enabled manual reconciliation, this webhook will fire whenever there are new funds into the cash balance.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/cash_balance"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "cash_balance.funds_available"
}
},
"charge": {
"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.",
"properties": {
- "alternate_statement_descriptors": {
- "$ref": "#/components/schemas/alternate_statement_descriptors"
- },
"amount": {
"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).",
"type": "integer"
},
"amount_captured": {
- "description": "Amount in %s captured (can be less than the amount attribute on the charge if a partial capture was made).",
+ "description": "Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made).",
"type": "integer"
},
"amount_refunded": {
- "description": "Amount in %s refunded (can be less than the amount attribute on the charge if a partial refund was issued).",
+ "description": "Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued).",
"type": "integer"
},
"application": {
@@ -4414,46 +4732,6 @@
"nullable": true,
"type": "string"
},
- "destination": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/account"
- }
- ],
- "description": "ID of an existing, connected Stripe account to transfer funds to if `transfer_data` was specified in the charge request.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/account"
- }
- ]
- }
- },
- "dispute": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/dispute"
- }
- ],
- "description": "Details about the dispute if the charge has been disputed.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/dispute"
- }
- ]
- }
- },
"disputed": {
"description": "Whether the charge has been disputed.",
"type": "boolean"
@@ -4808,8 +5086,6 @@
"currency",
"customer",
"description",
- "destination",
- "dispute",
"disputed",
"failure_balance_transaction",
"failure_code",
@@ -4844,14 +5120,11 @@
"title": "Charge",
"type": "object",
"x-expandableFields": [
- "alternate_statement_descriptors",
"application",
"application_fee",
"balance_transaction",
"billing_details",
"customer",
- "destination",
- "dispute",
"failure_balance_transaction",
"fraud_details",
"invoice",
@@ -4919,20 +5192,219 @@
"has_collection_class": true,
"has_search_result_class": true,
"in_package": "",
- "inner_classes": [
- "alternate_statement_descriptors",
- "charge_fraud_details",
- "charge_outcome",
- "charge_transfer_data",
- "level3",
- "payment_method_details",
- "radar_radar_options"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
}
},
+ "charge.captured": {
+ "description": "Occurs whenever a previously uncaptured charge is captured.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.captured"
+ }
+ },
+ "charge.dispute.closed": {
+ "description": "Occurs when a dispute is closed and the dispute status changes to `lost`, `warning_closed`, or `won`.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.dispute.closed"
+ }
+ },
+ "charge.dispute.created": {
+ "description": "Occurs whenever a customer disputes a charge with their bank.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.dispute.created"
+ }
+ },
+ "charge.dispute.funds_reinstated": {
+ "description": "Occurs when funds are reinstated to your account after a dispute is closed. This includes [partially refunded payments](/docs/disputes#disputes-on-partially-refunded-payments).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.dispute.funds_reinstated"
+ }
+ },
+ "charge.dispute.funds_withdrawn": {
+ "description": "Occurs when funds are removed from your account due to a dispute.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.dispute.funds_withdrawn"
+ }
+ },
+ "charge.dispute.updated": {
+ "description": "Occurs when the dispute is updated (usually with evidence).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.dispute.updated"
+ }
+ },
+ "charge.expired": {
+ "description": "Occurs whenever an uncaptured charge expires.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.expired"
+ }
+ },
+ "charge.failed": {
+ "description": "Occurs whenever a failed charge attempt occurs.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.failed"
+ }
+ },
+ "charge.pending": {
+ "description": "Occurs whenever a pending charge is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.pending"
+ }
+ },
+ "charge.refund.updated": {
+ "description": "Occurs whenever a refund is updated, on selected payment methods.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/refund"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.refund.updated"
+ }
+ },
+ "charge.refunded": {
+ "description": "Occurs whenever a charge is refunded, including partial refunds.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.refunded"
+ }
+ },
+ "charge.succeeded": {
+ "description": "Occurs whenever a charge is successful.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.succeeded"
+ }
+ },
+ "charge.updated": {
+ "description": "Occurs whenever a charge description or metadata is updated, or upon an asynchronous capture.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/charge"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "charge.updated"
+ }
+ },
"charge_fraud_details": {
"description": "",
"properties": {
@@ -4952,7 +5424,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FraudDetails",
- "in_class": "charge"
+ "in_package": ""
}
},
"charge_outcome": {
@@ -5023,7 +5495,7 @@
],
"x-stripeResource": {
"class_name": "Outcome",
- "in_class": "charge"
+ "in_package": ""
}
},
"charge_transfer_data": {
@@ -5065,7 +5537,7 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "charge"
+ "in_package": ""
}
},
"checkout.session": {
@@ -5119,6 +5591,12 @@
"nullable": true,
"type": "string"
},
+ "client_secret": {
+ "description": "Client secret to be used when initializing Stripe.js embedded checkout.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"consent": {
"anyOf": [
{
@@ -5179,7 +5657,7 @@
"$ref": "#/components/schemas/deleted_customer"
}
],
- "description": "The ID of the customer for this Session.\nFor Checkout Sessions in `payment` or `subscription` 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.",
+ "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.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -5421,6 +5899,15 @@
"nullable": true,
"type": "string"
},
+ "payment_method_configuration_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
+ }
+ ],
+ "description": "Information about the payment method configuration used for this Checkout session if using dynamic payment methods.",
+ "nullable": true
+ },
"payment_method_options": {
"anyOf": [
{
@@ -5456,6 +5943,20 @@
"nullable": true,
"type": "string"
},
+ "redirect_on_completion": {
+ "description": "Applies to Checkout Sessions with `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.",
+ "enum": [
+ "always",
+ "if_required",
+ "never"
+ ],
+ "type": "string"
+ },
+ "return_url": {
+ "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.",
+ "maxLength": 5000,
+ "type": "string"
+ },
"setup_intent": {
"anyOf": [
{
@@ -5569,6 +6070,16 @@
"description": "Tax and discount details for the computed total amount.",
"nullable": true
},
+ "ui_mode": {
+ "description": "The UI mode of the Session. Can be `hosted` (default) or `embedded`.",
+ "enum": [
+ "embedded",
+ "hosted"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
"url": {
"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.",
"maxLength": 5000,
@@ -5585,6 +6096,7 @@
"billing_address_collection",
"cancel_url",
"client_reference_id",
+ "client_secret",
"consent",
"consent_collection",
"created",
@@ -5622,6 +6134,7 @@
"subscription",
"success_url",
"total_details",
+ "ui_mode",
"url"
],
"title": "Session",
@@ -5641,6 +6154,7 @@
"line_items",
"payment_intent",
"payment_link",
+ "payment_method_configuration_details",
"payment_method_options",
"phone_number_collection",
"setup_intent",
@@ -5693,25 +6207,71 @@
"x-stripeResource": {
"class_name": "Session",
"has_collection_class": true,
- "in_package": "Checkout",
- "inner_classes": [
- "checkout_session_payment_method_options",
- "payment_pages_checkout_session_after_expiration",
- "payment_pages_checkout_session_automatic_tax",
- "payment_pages_checkout_session_consent",
- "payment_pages_checkout_session_consent_collection",
- "payment_pages_checkout_session_currency_conversion",
- "payment_pages_checkout_session_custom_fields",
- "payment_pages_checkout_session_custom_text",
- "payment_pages_checkout_session_customer_details",
- "payment_pages_checkout_session_invoice_creation",
- "payment_pages_checkout_session_phone_number_collection",
- "payment_pages_checkout_session_shipping_address_collection",
- "payment_pages_checkout_session_shipping_cost",
- "payment_pages_checkout_session_shipping_option",
- "payment_pages_checkout_session_tax_id_collection",
- "payment_pages_checkout_session_total_details"
- ]
+ "in_package": "Checkout"
+ }
+ },
+ "checkout.session.async_payment_failed": {
+ "description": "Occurs when a payment intent using a delayed payment method fails.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/checkout.session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "checkout.session.async_payment_failed"
+ }
+ },
+ "checkout.session.async_payment_succeeded": {
+ "description": "Occurs when a payment intent using a delayed payment method finally succeeds.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/checkout.session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "checkout.session.async_payment_succeeded"
+ }
+ },
+ "checkout.session.completed": {
+ "description": "Occurs when a Checkout Session has been successfully completed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/checkout.session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "checkout.session.completed"
+ }
+ },
+ "checkout.session.expired": {
+ "description": "Occurs when a Checkout Session is expired.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/checkout.session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "checkout.session.expired"
}
},
"checkout_acss_debit_mandate_options": {
@@ -5769,7 +6329,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "checkout_acss_debit_payment_method_options"
+ "in_package": ""
}
},
"checkout_acss_debit_payment_method_options": {
@@ -5813,10 +6373,7 @@
],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "checkout_session_payment_method_options",
- "inner_classes": [
- "checkout_acss_debit_mandate_options"
- ]
+ "in_package": ""
}
},
"checkout_affirm_payment_method_options": {
@@ -5835,7 +6392,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Affirm",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_afterpay_clearpay_payment_method_options": {
@@ -5854,7 +6411,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AfterpayClearpay",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_alipay_payment_method_options": {
@@ -5873,7 +6430,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Alipay",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_au_becs_debit_payment_method_options": {
@@ -5892,7 +6449,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_bacs_debit_payment_method_options": {
@@ -5913,7 +6470,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_bancontact_payment_method_options": {
@@ -5932,7 +6489,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_boleto_payment_method_options": {
@@ -5960,7 +6517,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Boleto",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_card_installments_options": {
@@ -5976,7 +6533,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Installments",
- "in_class": "checkout_card_payment_method_options"
+ "in_package": ""
}
},
"checkout_card_payment_method_options": {
@@ -6012,10 +6569,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "checkout_session_payment_method_options",
- "inner_classes": [
- "checkout_card_installments_options"
- ]
+ "in_package": ""
}
},
"checkout_cashapp_payment_method_options": {
@@ -6034,7 +6588,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_customer_balance_bank_transfer_payment_method_options": {
@@ -6084,7 +6638,7 @@
],
"x-stripeResource": {
"class_name": "BankTransfer",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_customer_balance_payment_method_options": {
@@ -6119,7 +6673,7 @@
],
"x-stripeResource": {
"class_name": "CustomerBalance",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_eps_payment_method_options": {
@@ -6138,7 +6692,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Eps",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_fpx_payment_method_options": {
@@ -6157,7 +6711,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fpx",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_giropay_payment_method_options": {
@@ -6176,7 +6730,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Giropay",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_grab_pay_payment_method_options": {
@@ -6195,7 +6749,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GrabPay",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_ideal_payment_method_options": {
@@ -6214,7 +6768,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Ideal",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_klarna_payment_method_options": {
@@ -6235,7 +6789,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Klarna",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_konbini_payment_method_options": {
@@ -6262,7 +6816,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Konbini",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_link_payment_method_options": {
@@ -6282,7 +6836,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_oxxo_payment_method_options": {
@@ -6308,7 +6862,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Oxxo",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_p24_payment_method_options": {
@@ -6327,7 +6881,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "P24",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_paynow_payment_method_options": {
@@ -6346,7 +6900,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paynow",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_pix_payment_method_options": {
@@ -6366,7 +6920,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Pix",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_sepa_debit_payment_method_options": {
@@ -6387,7 +6941,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_session_payment_method_options": {
@@ -6504,36 +7058,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodOptions",
- "in_class": "checkout.session",
- "inner_classes": [
- "checkout_acss_debit_payment_method_options",
- "checkout_affirm_payment_method_options",
- "checkout_afterpay_clearpay_payment_method_options",
- "checkout_alipay_payment_method_options",
- "checkout_au_becs_debit_payment_method_options",
- "checkout_bacs_debit_payment_method_options",
- "checkout_bancontact_payment_method_options",
- "checkout_boleto_payment_method_options",
- "checkout_card_payment_method_options",
- "checkout_cashapp_payment_method_options",
- "checkout_customer_balance_bank_transfer_payment_method_options",
- "checkout_customer_balance_payment_method_options",
- "checkout_eps_payment_method_options",
- "checkout_fpx_payment_method_options",
- "checkout_giropay_payment_method_options",
- "checkout_grab_pay_payment_method_options",
- "checkout_ideal_payment_method_options",
- "checkout_klarna_payment_method_options",
- "checkout_konbini_payment_method_options",
- "checkout_link_payment_method_options",
- "checkout_oxxo_payment_method_options",
- "checkout_p24_payment_method_options",
- "checkout_paynow_payment_method_options",
- "checkout_pix_payment_method_options",
- "checkout_sepa_debit_payment_method_options",
- "checkout_sofort_payment_method_options",
- "checkout_us_bank_account_payment_method_options"
- ]
+ "in_package": ""
}
},
"checkout_sofort_payment_method_options": {
@@ -6552,7 +7077,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Sofort",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"checkout_us_bank_account_payment_method_options": {
@@ -6587,14 +7112,14 @@
],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "checkout_session_payment_method_options"
+ "in_package": ""
}
},
"connect_collection_transfer": {
"description": "",
"properties": {
"amount": {
- "description": "Amount transferred, in %s.",
+ "description": "Amount transferred, in cents (or local equivalent).",
"type": "integer"
},
"currency": {
@@ -6658,6 +7183,45 @@
]
}
},
+ "connect_embedded_account_session_create_components": {
+ "description": "",
+ "properties": {
+ "account_onboarding": {
+ "$ref": "#/components/schemas/connect_embedded_base_config_claim"
+ }
+ },
+ "required": [
+ "account_onboarding"
+ ],
+ "title": "ConnectEmbeddedAccountSessionCreateComponents",
+ "type": "object",
+ "x-expandableFields": [
+ "account_onboarding"
+ ],
+ "x-stripeResource": {
+ "class_name": "Components",
+ "in_package": ""
+ }
+ },
+ "connect_embedded_base_config_claim": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "ConnectEmbeddedBaseConfigClaim",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "BaseConfig",
+ "in_package": ""
+ }
+ },
"country_spec": {
"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).",
"properties": {
@@ -6752,10 +7316,7 @@
"x-stripeResource": {
"class_name": "CountrySpec",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "country_spec_verification_fields"
- ]
+ "in_package": ""
}
},
"country_spec_verification_field_details": {
@@ -6787,7 +7348,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Details",
- "in_class": "country_spec_verification_fields"
+ "in_package": ""
}
},
"country_spec_verification_fields": {
@@ -6812,10 +7373,7 @@
],
"x-stripeResource": {
"class_name": "VerificationFields",
- "in_class": "country_spec",
- "inner_classes": [
- "country_spec_verification_field_details"
- ]
+ "in_package": ""
}
},
"coupon": {
@@ -6898,7 +7456,7 @@
"type": "string"
},
"percent_off": {
- "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 %s100 invoice %s50 instead.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -6981,11 +7539,55 @@
"x-stripeResource": {
"class_name": "Coupon",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "coupon_applies_to",
- "coupon_currency_option"
- ]
+ "in_package": ""
+ }
+ },
+ "coupon.created": {
+ "description": "Occurs whenever a coupon is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/coupon"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "coupon.created"
+ }
+ },
+ "coupon.deleted": {
+ "description": "Occurs whenever a coupon is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/coupon"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "coupon.deleted"
+ }
+ },
+ "coupon.updated": {
+ "description": "Occurs whenever a coupon is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/coupon"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "coupon.updated"
}
},
"coupon_applies_to": {
@@ -7008,7 +7610,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AppliesTo",
- "in_class": "coupon"
+ "in_package": ""
}
},
"coupon_currency_option": {
@@ -7027,14 +7629,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrencyOption",
- "in_class": "coupon"
+ "in_package": ""
}
},
"credit_note": {
"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)",
"properties": {
"amount": {
- "description": "The integer amount in %s representing the total amount of the credit note, including tax.",
+ "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax.",
"type": "integer"
},
"amount_shipping": {
@@ -7096,7 +7698,7 @@
}
},
"discount_amount": {
- "description": "The integer amount in %s representing the total amount of discount that was credited.",
+ "description": "The integer amount in cents (or local equivalent) representing the total amount of discount that was credited.",
"type": "integer"
},
"discount_amounts": {
@@ -7265,11 +7867,11 @@
"type": "string"
},
"subtotal": {
- "description": "The integer amount in %s representing the amount of the credit note, excluding exclusive tax and invoice level discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding exclusive tax and invoice level discounts.",
"type": "integer"
},
"subtotal_excluding_tax": {
- "description": "The integer amount in %s representing the amount of the credit note, excluding all tax and invoice level discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the amount of the credit note, excluding all tax and invoice level discounts.",
"nullable": true,
"type": "integer"
},
@@ -7281,11 +7883,11 @@
"type": "array"
},
"total": {
- "description": "The integer amount in %s representing the total amount of the credit note, including tax and all discount.",
+ "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, including tax and all discount.",
"type": "integer"
},
"total_excluding_tax": {
- "description": "The integer amount in %s representing the total amount of the credit note, excluding tax, but including discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the total amount of the credit note, excluding tax, but including discounts.",
"nullable": true,
"type": "integer"
},
@@ -7403,21 +8005,66 @@
"x-stripeResource": {
"class_name": "CreditNote",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "credit_note_tax_amount"
- ]
+ "in_package": ""
+ }
+ },
+ "credit_note.created": {
+ "description": "Occurs whenever a credit note is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/credit_note"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "credit_note.created"
+ }
+ },
+ "credit_note.updated": {
+ "description": "Occurs whenever a credit note is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/credit_note"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "credit_note.updated"
+ }
+ },
+ "credit_note.voided": {
+ "description": "Occurs whenever a credit note is voided.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/credit_note"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "credit_note.voided"
}
},
"credit_note_line_item": {
- "description": "",
+ "description": "The credit note line item object",
"properties": {
"amount": {
- "description": "The integer amount in %s representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the gross amount being credited for this line item, excluding (exclusive) tax and discounts.",
"type": "integer"
},
"amount_excluding_tax": {
- "description": "The integer amount in %s representing the amount being credited for this line item, excluding all tax and discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the amount being credited for this line item, excluding all tax and discounts.",
"nullable": true,
"type": "integer"
},
@@ -7428,7 +8075,7 @@
"type": "string"
},
"discount_amount": {
- "description": "The integer amount in %s representing the discount being credited for this line item.",
+ "description": "The integer amount in cents (or local equivalent) representing the discount being credited for this line item.",
"type": "integer"
},
"discount_amounts": {
@@ -7498,7 +8145,7 @@
"type": "string"
},
"unit_amount_excluding_tax": {
- "description": "The amount in %s representing the unit amount being credited for this line item, excluding all tax and discounts.",
+ "description": "The amount in cents (or local equivalent) representing the unit amount being credited for this line item, excluding all tax and discounts.",
"format": "decimal",
"nullable": true,
"type": "string"
@@ -7555,7 +8202,7 @@
"description": "",
"properties": {
"amount": {
- "description": "The amount, in %s, of the tax.",
+ "description": "The amount, in cents (or local equivalent), of the tax.",
"type": "integer"
},
"inclusive": {
@@ -7605,7 +8252,7 @@
"x-stripeBypassValidation": true
},
"taxable_amount": {
- "description": "The amount on which tax is calculated, in %s.",
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
"nullable": true,
"type": "integer"
}
@@ -7624,7 +8271,7 @@
],
"x-stripeResource": {
"class_name": "TaxAmount",
- "in_class": "credit_note"
+ "in_package": ""
}
},
"currency_option": {
@@ -7657,12 +8304,12 @@
"type": "array"
},
"unit_amount": {
- "description": "The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"nullable": true,
"type": "integer"
},
"unit_amount_decimal": {
- "description": "The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"format": "decimal",
"nullable": true,
"type": "string"
@@ -7682,7 +8329,7 @@
],
"x-stripeResource": {
"class_name": "CurrencyOption",
- "in_class": "price"
+ "in_package": ""
}
},
"custom_unit_amount": {
@@ -7714,11 +8361,11 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomUnitAmount",
- "in_class": "price"
+ "in_package": ""
}
},
"customer": {
- "description": "This object represents a customer of your business. It lets you 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)",
+ "description": "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)",
"properties": {
"address": {
"anyOf": [
@@ -7730,7 +8377,7 @@
"nullable": true
},
"balance": {
- "description": "Current balance, if any, being 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 will be added to their next invoice. The balance does not refer to any unpaid invoices; it solely takes into account amounts that have yet to be successfully applied to any invoice. This balance is only taken into account as invoices are finalized.",
+ "description": "The current balance, if any, that's stored on the customer. If negative, the customer has credit to apply to their next invoice. If positive, the customer has an amount owed that's added to their next invoice. The balance only considers amounts that Stripe hasn't successfully applied to any invoice. It doesn't reflect unpaid invoices. This balance is only taken into account after invoices finalize.",
"type": "integer"
},
"cash_balance": {
@@ -7739,7 +8386,7 @@
"$ref": "#/components/schemas/cash_balance"
}
],
- "description": "The current funds being held by Stripe on behalf of the customer. These funds can be applied towards payment intents with source \"cash_balance\". The settings[reconciliation_mode] field describes whether these funds are applied to such payment intents manually or automatically.",
+ "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.",
"nullable": true
},
"created": {
@@ -7763,7 +8410,7 @@
"$ref": "#/components/schemas/payment_source"
}
],
- "description": "ID of the default payment source for the customer.\n\nIf you are using payment methods created via 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.",
+ "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.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -7774,7 +8421,7 @@
}
},
"delinquent": {
- "description": "When the customer's latest invoice is billed by charging automatically, `delinquent` is `true` if the invoice's latest charge failed. When the customer's latest invoice is billed by sending an invoice, `delinquent` is `true` if the invoice isn't paid by its due date.\n\nIf an invoice is marked uncollectible by [dunning](https://stripe.com/docs/billing/automatic-collection), `delinquent` doesn't get reset to `false`.",
+ "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`.",
"nullable": true,
"type": "boolean"
},
@@ -7808,7 +8455,7 @@
"additionalProperties": {
"type": "integer"
},
- "description": "The current multi-currency balances, if any, being 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 will be added to their next invoice denominated in that currency. These balances do not refer to any unpaid invoices. They solely track amounts that have yet to be successfully applied to any invoice. A balance in a particular currency is only applied to any invoice as an invoice in that currency is finalized.",
+ "description": "The current multi-currency balances, if any, that's stored on the customer. If positive in a currency, the customer has a credit to apply to their next invoice denominated in that currency. If negative, the customer has an amount owed that's added to their next invoice denominated in that currency. These balances don't apply to unpaid invoices. They solely track amounts that Stripe hasn't successfully applied to any invoice. Stripe only applies a balance in a specific currency to an invoice after that invoice (which is in the same currency) finalizes.",
"type": "object"
},
"invoice_prefix": {
@@ -7839,7 +8486,7 @@
"type": "string"
},
"next_invoice_sequence": {
- "description": "The suffix of the customer's next invoice number, e.g., 0001.",
+ "description": "The suffix of the customer's next invoice number (for example, 0001).",
"type": "integer"
},
"object": {
@@ -7955,7 +8602,7 @@
"$ref": "#/components/schemas/customer_tax"
},
"tax_exempt": {
- "description": "Describes the customer's tax exemption status. One of `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the text **\"Reverse charge\"**.",
+ "description": "Describes the customer's tax exemption status, which is `none`, `exempt`, or `reverse`. When set to `reverse`, invoice and receipt PDFs include the following text: **\"Reverse charge\"**.",
"enum": [
"exempt",
"none",
@@ -8013,7 +8660,7 @@
"$ref": "#/components/schemas/test_helpers.test_clock"
}
],
- "description": "ID of the test clock this customer belongs to.",
+ "description": "ID of the test clock that this customer belongs to.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -8140,18 +8787,387 @@
"class_name": "Customer",
"has_collection_class": true,
"has_search_result_class": true,
- "in_package": "",
- "inner_classes": [
- "customer_tax",
- "invoice_setting_customer_setting"
- ]
+ "in_package": ""
+ }
+ },
+ "customer.created": {
+ "description": "Occurs whenever a new customer is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/customer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.created"
+ }
+ },
+ "customer.deleted": {
+ "description": "Occurs whenever a customer is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/customer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.deleted"
+ }
+ },
+ "customer.discount.created": {
+ "description": "Occurs whenever a coupon is attached to a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/discount"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.discount.created"
+ }
+ },
+ "customer.discount.deleted": {
+ "description": "Occurs whenever a coupon is removed from a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/discount"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.discount.deleted"
+ }
+ },
+ "customer.discount.updated": {
+ "description": "Occurs whenever a customer is switched from one coupon to another.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/discount"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.discount.updated"
+ }
+ },
+ "customer.source.created": {
+ "description": "Occurs whenever a new source is created for a customer.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.source.created"
+ }
+ },
+ "customer.source.deleted": {
+ "description": "Occurs whenever a source is removed from a customer.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.source.deleted"
+ }
+ },
+ "customer.source.expiring": {
+ "description": "Occurs whenever a card or source will expire at the end of the month.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.source.expiring"
+ }
+ },
+ "customer.source.updated": {
+ "description": "Occurs whenever a source's details are changed.",
+ "properties": {
+ "object": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/bank_account"
+ },
+ {
+ "$ref": "#/components/schemas/card"
+ },
+ {
+ "$ref": "#/components/schemas/source"
+ }
+ ]
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.source.updated"
+ }
+ },
+ "customer.subscription.created": {
+ "description": "Occurs whenever a customer is signed up for a new plan.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.created"
+ }
+ },
+ "customer.subscription.deleted": {
+ "description": "Occurs whenever a customer's subscription ends.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.deleted"
+ }
+ },
+ "customer.subscription.paused": {
+ "description": "Occurs whenever a customer's subscription is paused. Only applies when subscriptions enter `status=paused`, not when [payment collection](/docs/billing/subscriptions/pause) is paused.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.paused"
+ }
+ },
+ "customer.subscription.pending_update_applied": {
+ "description": "Occurs whenever a customer's subscription's pending update is applied, and the subscription is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.pending_update_applied"
+ }
+ },
+ "customer.subscription.pending_update_expired": {
+ "description": "Occurs whenever a customer's subscription's pending update expires before the related invoice is paid.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.pending_update_expired"
+ }
+ },
+ "customer.subscription.resumed": {
+ "description": "Occurs whenever a customer's subscription is no longer paused. Only applies when a `status=paused` subscription is [resumed](/docs/api/subscriptions/resume), not when [payment collection](/docs/billing/subscriptions/pause) is resumed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.resumed"
+ }
+ },
+ "customer.subscription.trial_will_end": {
+ "description": "Occurs three days before a subscription's trial period is scheduled to end, or when a trial is ended immediately (using `trial_end=now`).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.trial_will_end"
+ }
+ },
+ "customer.subscription.updated": {
+ "description": "Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.subscription.updated"
+ }
+ },
+ "customer.tax_id.created": {
+ "description": "Occurs whenever a tax ID is created for a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax_id"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.tax_id.created"
+ }
+ },
+ "customer.tax_id.deleted": {
+ "description": "Occurs whenever a tax ID is deleted from a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax_id"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.tax_id.deleted"
+ }
+ },
+ "customer.tax_id.updated": {
+ "description": "Occurs whenever a customer's tax ID is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax_id"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.tax_id.updated"
+ }
+ },
+ "customer.updated": {
+ "description": "Occurs whenever any property of a customer changes.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/customer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer.updated"
}
},
"customer_acceptance": {
"description": "",
"properties": {
"accepted_at": {
- "description": "The time at which the customer accepted the Mandate.",
+ "description": "The time that the customer accepts the mandate.",
"format": "unix-time",
"nullable": true,
"type": "integer"
@@ -8163,7 +9179,7 @@
"$ref": "#/components/schemas/online_acceptance"
},
"type": {
- "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
+ "description": "The mandate includes the type of customer acceptance information, such as: `online` or `offline`.",
"enum": [
"offline",
"online"
@@ -8183,11 +9199,7 @@
],
"x-stripeResource": {
"class_name": "CustomerAcceptance",
- "in_class": "mandate",
- "inner_classes": [
- "offline_acceptance",
- "online_acceptance"
- ]
+ "in_package": ""
}
},
"customer_balance_customer_balance_settings": {
@@ -8215,7 +9227,64 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BalanceSettings",
- "in_class": "cash_balance"
+ "in_package": ""
+ }
+ },
+ "customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": {
+ "description": "",
+ "properties": {
+ "balance_transaction": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/balance_transaction"
+ }
+ ],
+ "description": "The [Balance Transaction](https://stripe.com/docs/api/balance_transactions/object) that corresponds to funds taken out of your Stripe balance.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/balance_transaction"
+ }
+ ]
+ }
+ },
+ "linked_transaction": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/customer_cash_balance_transaction"
+ }
+ ],
+ "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.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/customer_cash_balance_transaction"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "balance_transaction",
+ "linked_transaction"
+ ],
+ "title": "CustomerBalanceResourceCashBalanceTransactionResourceAdjustedForOverdraft",
+ "type": "object",
+ "x-expandableFields": [
+ "balance_transaction",
+ "linked_transaction"
+ ],
+ "x-stripeResource": {
+ "class_name": "AdjustedForOverdraft",
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction": {
@@ -8251,7 +9320,7 @@
],
"x-stripeResource": {
"class_name": "AppliedToPayment",
- "in_class": "customer_cash_balance_transaction"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction": {
@@ -8271,10 +9340,7 @@
],
"x-stripeResource": {
"class_name": "Funded",
- "in_class": "customer_cash_balance_transaction",
- "inner_classes": [
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
- ]
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": {
@@ -8325,13 +9391,7 @@
],
"x-stripeResource": {
"class_name": "BankTransfer",
- "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction",
- "inner_classes": [
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer",
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer",
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer",
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer"
- ]
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": {
@@ -8366,7 +9426,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EuBankTransfer",
- "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": {
@@ -8401,7 +9461,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GbBankTransfer",
- "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": {
@@ -8436,7 +9496,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "JpBankTransfer",
- "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": {
@@ -8466,7 +9526,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankTransfer",
- "in_class": "customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": {
@@ -8502,7 +9562,7 @@
],
"x-stripeResource": {
"class_name": "RefundedFromPayment",
- "in_class": "customer_cash_balance_transaction"
+ "in_package": ""
}
},
"customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction": {
@@ -8538,7 +9598,7 @@
],
"x-stripeResource": {
"class_name": "UnappliedFromPayment",
- "in_class": "customer_cash_balance_transaction"
+ "in_package": ""
}
},
"customer_balance_transaction": {
@@ -8751,6 +9811,9 @@
"customer_cash_balance_transaction": {
"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.",
"properties": {
+ "adjusted_for_overdraft": {
+ "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft"
+ },
"applied_to_payment": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction"
},
@@ -8816,6 +9879,7 @@
"type": {
"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.",
"enum": [
+ "adjusted_for_overdraft",
"applied_to_payment",
"funded",
"funding_reversed",
@@ -8844,6 +9908,7 @@
"title": "CustomerCashBalanceTransaction",
"type": "object",
"x-expandableFields": [
+ "adjusted_for_overdraft",
"applied_to_payment",
"customer",
"funded",
@@ -8885,14 +9950,27 @@
"class_name": "CustomerCashBalanceTransaction",
"has_collection_class": true,
"in_package": "",
- "inner_classes": [
- "customer_balance_resource_cash_balance_transaction_resource_applied_to_payment_transaction",
- "customer_balance_resource_cash_balance_transaction_resource_funded_transaction",
- "customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction",
- "customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction"
+ "polymorphic_groups": [
+ "balance_transaction_source"
]
}
},
+ "customer_cash_balance_transaction.created": {
+ "description": "Occurs whenever a new customer cash balance transactions is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/customer_cash_balance_transaction"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "customer_cash_balance_transaction.created"
+ }
+ },
"customer_tax": {
"description": "",
"properties": {
@@ -8934,10 +10012,7 @@
],
"x-stripeResource": {
"class_name": "Tax",
- "in_class": "customer",
- "inner_classes": [
- "customer_tax_location"
- ]
+ "in_package": ""
}
},
"customer_tax_location": {
@@ -8975,7 +10050,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Location",
- "in_class": "customer_tax"
+ "in_package": ""
}
},
"deleted_account": {
@@ -10095,7 +11170,7 @@
"description": "",
"properties": {
"amount": {
- "description": "The amount, in %s, of the discount.",
+ "description": "The amount, in cents (or local equivalent), of the discount.",
"type": "integer"
},
"discount": {
@@ -10139,10 +11214,10 @@
}
},
"dispute": {
- "description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you're given the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate. You can find more\ninformation about the dispute process in our [Disputes and\nFraud](/docs/disputes) documentation.\n\nRelated guide: [Disputes and fraud](https://stripe.com/docs/disputes)",
+ "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)",
"properties": {
"amount": {
- "description": "Disputed amount. Usually the amount of the charge, but can differ (usually because of currency fluctuation or because only part of the order is disputed).",
+ "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).",
"type": "integer"
},
"balance_transactions": {
@@ -10162,7 +11237,7 @@
"$ref": "#/components/schemas/charge"
}
],
- "description": "ID of the charge that was disputed.",
+ "description": "ID of the charge that's disputed.",
"x-expansionResources": {
"oneOf": [
{
@@ -10192,7 +11267,7 @@
"type": "string"
},
"is_charge_refundable": {
- "description": "If true, it is still possible to refund the disputed payment. Once the payment has been fully refunded, no further funds will be withdrawn from your Stripe account as a result of this dispute.",
+ "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.",
"type": "boolean"
},
"livemode": {
@@ -10230,7 +11305,7 @@
"$ref": "#/components/schemas/payment_intent"
}
],
- "description": "ID of the PaymentIntent that was disputed.",
+ "description": "ID of the PaymentIntent that's disputed.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -10240,15 +11315,17 @@
]
}
},
+ "payment_method_details": {
+ "$ref": "#/components/schemas/dispute_payment_method_details"
+ },
"reason": {
- "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`. Read more about [dispute reasons](https://stripe.com/docs/disputes/categories).",
+ "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).",
"maxLength": 5000,
"type": "string"
},
"status": {
- "description": "Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `charge_refunded`, `won`, or `lost`.",
+ "description": "Current status of dispute. Possible values are `warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, or `lost`.",
"enum": [
- "charge_refunded",
"lost",
"needs_response",
"under_review",
@@ -10284,7 +11361,8 @@
"charge",
"evidence",
"evidence_details",
- "payment_intent"
+ "payment_intent",
+ "payment_method_details"
],
"x-resourceId": "dispute",
"x-stripeOperations": [
@@ -10321,10 +11399,6 @@
"class_name": "Dispute",
"has_collection_class": true,
"in_package": "",
- "inner_classes": [
- "dispute_evidence",
- "dispute_evidence_details"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
@@ -10666,7 +11740,7 @@
],
"x-stripeResource": {
"class_name": "Evidence",
- "in_class": "dispute"
+ "in_package": ""
}
},
"dispute_evidence_details": {
@@ -10702,7 +11776,68 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EvidenceDetails",
- "in_class": "dispute"
+ "in_package": ""
+ }
+ },
+ "dispute_payment_method_details": {
+ "description": "",
+ "properties": {
+ "card": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/dispute_payment_method_details_card"
+ }
+ ],
+ "description": "Card specific dispute details.",
+ "nullable": true
+ },
+ "type": {
+ "description": "Payment method type.",
+ "enum": [
+ "card"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "card",
+ "type"
+ ],
+ "title": "DisputePaymentMethodDetails",
+ "type": "object",
+ "x-expandableFields": [
+ "card"
+ ],
+ "x-stripeResource": {
+ "class_name": "DisputePaymentMethodDetails",
+ "in_package": ""
+ }
+ },
+ "dispute_payment_method_details_card": {
+ "description": "",
+ "properties": {
+ "brand": {
+ "description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "network_reason_code": {
+ "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.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "brand",
+ "network_reason_code"
+ ],
+ "title": "DisputePaymentMethodDetailsCard",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "DisputePaymentMethodDetailsCard",
+ "in_package": ""
}
},
"email_sent": {
@@ -10728,7 +11863,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EmailSent",
- "in_class": "refund_next_action_display_details"
+ "in_package": ""
}
},
"ephemeral_key": {
@@ -10815,15 +11950,15 @@
}
},
"event": {
- "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. Note that many API requests may cause multiple\nevents to be created. For example, if you create a new subscription for a\ncustomer, you will 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 state of that\nresource at the time of the change is embedded in the event's data field. For\nexample, a `charge.succeeded` event will contain a charge, and an\n`invoice.payment_failed` event will contain 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. Webhooks are managed\nin your\n[account settings](https://dashboard.stripe.com/account/webhooks),\nand our [Using Webhooks](https://stripe.com/docs/webhooks) guide will help you get set up.\n\nWhen using [Connect](https://stripe.com/docs/connect), you can also receive notifications of\nevents that occur in connected accounts. For these events, there will be an\nadditional `account` attribute in the received `Event` object.\n\n**NOTE:** Right now, access to events through the [Retrieve Event API](https://stripe.com/docs/api#retrieve_event) is\nguaranteed only for 30 days.",
+ "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]\n(/docs/webhooks) so that your integration can automatically trigger reactions.\n\nWhen using [Connect](https://stripe.com/docs/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.",
"properties": {
"account": {
- "description": "The connected account that originated the event.",
+ "description": "The connected account that originates the event.",
"maxLength": 5000,
"type": "string"
},
"api_version": {
- "description": "The Stripe API version used to render `data`. *Note: This property is populated only for events on or after October 31, 2014*.",
+ "description": "The Stripe API version used to render `data`. This property is populated only for events on or after October 31, 2014.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -10853,7 +11988,7 @@
"type": "string"
},
"pending_webhooks": {
- "description": "Number of webhooks that have yet to be successfully delivered (i.e., to return a 20x response) to the URLs you've specified.",
+ "description": "Number of webhooks that haven't been successfully delivered (for example, to return a 20x response) to the URLs you specify.",
"type": "integer"
},
"request": {
@@ -10862,11 +11997,230 @@
"$ref": "#/components/schemas/notification_event_request"
}
],
- "description": "Information on the API request that instigated the event.",
+ "description": "Information on the API request that triggers the event.",
"nullable": true
},
"type": {
- "description": "Description of the event (e.g., `invoice.created` or `charge.refunded`).",
+ "description": "Description of the event (for example, `invoice.created` or `charge.refunded`).",
+ "enum": [
+ "account.application.authorized",
+ "account.application.deauthorized",
+ "account.external_account.created",
+ "account.external_account.deleted",
+ "account.external_account.updated",
+ "account.updated",
+ "application_fee.created",
+ "application_fee.refund.updated",
+ "application_fee.refunded",
+ "balance.available",
+ "billing_portal.configuration.created",
+ "billing_portal.configuration.updated",
+ "billing_portal.session.created",
+ "capability.updated",
+ "cash_balance.funds_available",
+ "charge.captured",
+ "charge.dispute.closed",
+ "charge.dispute.created",
+ "charge.dispute.funds_reinstated",
+ "charge.dispute.funds_withdrawn",
+ "charge.dispute.updated",
+ "charge.expired",
+ "charge.failed",
+ "charge.pending",
+ "charge.refund.updated",
+ "charge.refunded",
+ "charge.succeeded",
+ "charge.updated",
+ "checkout.session.async_payment_failed",
+ "checkout.session.async_payment_succeeded",
+ "checkout.session.completed",
+ "checkout.session.expired",
+ "coupon.created",
+ "coupon.deleted",
+ "coupon.updated",
+ "credit_note.created",
+ "credit_note.updated",
+ "credit_note.voided",
+ "customer.created",
+ "customer.deleted",
+ "customer.discount.created",
+ "customer.discount.deleted",
+ "customer.discount.updated",
+ "customer.source.created",
+ "customer.source.deleted",
+ "customer.source.expiring",
+ "customer.source.updated",
+ "customer.subscription.created",
+ "customer.subscription.deleted",
+ "customer.subscription.paused",
+ "customer.subscription.pending_update_applied",
+ "customer.subscription.pending_update_expired",
+ "customer.subscription.resumed",
+ "customer.subscription.trial_will_end",
+ "customer.subscription.updated",
+ "customer.tax_id.created",
+ "customer.tax_id.deleted",
+ "customer.tax_id.updated",
+ "customer.updated",
+ "customer_cash_balance_transaction.created",
+ "file.created",
+ "financial_connections.account.created",
+ "financial_connections.account.deactivated",
+ "financial_connections.account.disconnected",
+ "financial_connections.account.reactivated",
+ "financial_connections.account.refreshed_balance",
+ "identity.verification_session.canceled",
+ "identity.verification_session.created",
+ "identity.verification_session.processing",
+ "identity.verification_session.redacted",
+ "identity.verification_session.requires_input",
+ "identity.verification_session.verified",
+ "invoice.created",
+ "invoice.deleted",
+ "invoice.finalization_failed",
+ "invoice.finalized",
+ "invoice.marked_uncollectible",
+ "invoice.paid",
+ "invoice.payment_action_required",
+ "invoice.payment_failed",
+ "invoice.payment_succeeded",
+ "invoice.sent",
+ "invoice.upcoming",
+ "invoice.updated",
+ "invoice.voided",
+ "invoiceitem.created",
+ "invoiceitem.deleted",
+ "issuing_authorization.created",
+ "issuing_authorization.request",
+ "issuing_authorization.updated",
+ "issuing_card.created",
+ "issuing_card.updated",
+ "issuing_cardholder.created",
+ "issuing_cardholder.updated",
+ "issuing_dispute.closed",
+ "issuing_dispute.created",
+ "issuing_dispute.funds_reinstated",
+ "issuing_dispute.submitted",
+ "issuing_dispute.updated",
+ "issuing_token.created",
+ "issuing_token.updated",
+ "issuing_transaction.created",
+ "issuing_transaction.updated",
+ "mandate.updated",
+ "payment_intent.amount_capturable_updated",
+ "payment_intent.canceled",
+ "payment_intent.created",
+ "payment_intent.partially_funded",
+ "payment_intent.payment_failed",
+ "payment_intent.processing",
+ "payment_intent.requires_action",
+ "payment_intent.succeeded",
+ "payment_link.created",
+ "payment_link.updated",
+ "payment_method.attached",
+ "payment_method.automatically_updated",
+ "payment_method.detached",
+ "payment_method.updated",
+ "payout.canceled",
+ "payout.created",
+ "payout.failed",
+ "payout.paid",
+ "payout.reconciliation_completed",
+ "payout.updated",
+ "person.created",
+ "person.deleted",
+ "person.updated",
+ "plan.created",
+ "plan.deleted",
+ "plan.updated",
+ "price.created",
+ "price.deleted",
+ "price.updated",
+ "product.created",
+ "product.deleted",
+ "product.updated",
+ "promotion_code.created",
+ "promotion_code.updated",
+ "quote.accepted",
+ "quote.canceled",
+ "quote.created",
+ "quote.finalized",
+ "radar.early_fraud_warning.created",
+ "radar.early_fraud_warning.updated",
+ "refund.created",
+ "refund.updated",
+ "reporting.report_run.failed",
+ "reporting.report_run.succeeded",
+ "reporting.report_type.updated",
+ "review.closed",
+ "review.opened",
+ "setup_intent.canceled",
+ "setup_intent.created",
+ "setup_intent.requires_action",
+ "setup_intent.setup_failed",
+ "setup_intent.succeeded",
+ "sigma.scheduled_query_run.created",
+ "source.canceled",
+ "source.chargeable",
+ "source.failed",
+ "source.mandate_notification",
+ "source.refund_attributes_required",
+ "source.transaction.created",
+ "source.transaction.updated",
+ "subscription_schedule.aborted",
+ "subscription_schedule.canceled",
+ "subscription_schedule.completed",
+ "subscription_schedule.created",
+ "subscription_schedule.expiring",
+ "subscription_schedule.released",
+ "subscription_schedule.updated",
+ "tax.settings.updated",
+ "tax_rate.created",
+ "tax_rate.updated",
+ "terminal.reader.action_failed",
+ "terminal.reader.action_succeeded",
+ "test_helpers.test_clock.advancing",
+ "test_helpers.test_clock.created",
+ "test_helpers.test_clock.deleted",
+ "test_helpers.test_clock.internal_failure",
+ "test_helpers.test_clock.ready",
+ "topup.canceled",
+ "topup.created",
+ "topup.failed",
+ "topup.reversed",
+ "topup.succeeded",
+ "transfer.created",
+ "transfer.reversed",
+ "transfer.updated",
+ "treasury.credit_reversal.created",
+ "treasury.credit_reversal.posted",
+ "treasury.debit_reversal.completed",
+ "treasury.debit_reversal.created",
+ "treasury.debit_reversal.initial_credit_granted",
+ "treasury.financial_account.closed",
+ "treasury.financial_account.created",
+ "treasury.financial_account.features_status_updated",
+ "treasury.inbound_transfer.canceled",
+ "treasury.inbound_transfer.created",
+ "treasury.inbound_transfer.failed",
+ "treasury.inbound_transfer.succeeded",
+ "treasury.outbound_payment.canceled",
+ "treasury.outbound_payment.created",
+ "treasury.outbound_payment.expected_arrival_date_updated",
+ "treasury.outbound_payment.failed",
+ "treasury.outbound_payment.posted",
+ "treasury.outbound_payment.returned",
+ "treasury.outbound_transfer.canceled",
+ "treasury.outbound_transfer.created",
+ "treasury.outbound_transfer.expected_arrival_date_updated",
+ "treasury.outbound_transfer.failed",
+ "treasury.outbound_transfer.posted",
+ "treasury.outbound_transfer.returned",
+ "treasury.received_credit.created",
+ "treasury.received_credit.failed",
+ "treasury.received_credit.succeeded",
+ "treasury.received_debit.created"
+ ],
"maxLength": 5000,
"type": "string"
}
@@ -11136,14 +12490,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fee",
- "in_class": "balance_transaction"
+ "in_package": ""
}
},
"fee_refund": {
"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)",
"properties": {
"amount": {
- "description": "Amount, in %s.",
+ "description": "Amount, in cents (or local equivalent).",
"type": "integer"
},
"balance_transaction": {
@@ -11294,7 +12648,7 @@
}
},
"file": {
- "description": "This is an object representing a file hosted on Stripe's servers. The\nfile may have been uploaded by yourself using the [create file](https://stripe.com/docs/api#create_file)\nrequest (for example, when uploading dispute evidence) or it may have\nbeen created by Stripe (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
+ "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 independetly (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
@@ -11302,13 +12656,13 @@
"type": "integer"
},
"expires_at": {
- "description": "The time at which the file expires and is no longer available in epoch seconds.",
+ "description": "The file expires and isn't available at this time in epoch seconds.",
"format": "unix-time",
"nullable": true,
"type": "integer"
},
"filename": {
- "description": "A filename for the file, suitable for saving to a filesystem.",
+ "description": "The suitable name for saving the file to a filesystem.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -11389,23 +12743,23 @@
"x-stripeBypassValidation": true
},
"size": {
- "description": "The size in bytes of the file object.",
+ "description": "The size of the file object in bytes.",
"type": "integer"
},
"title": {
- "description": "A user friendly title for the document.",
+ "description": "A suitable title for the document.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"type": {
- "description": "The type of the file returned (e.g., `csv`, `pdf`, `jpg`, or `png`).",
+ "description": "The returned file type (for example, `csv`, `pdf`, `jpg`, or `png`).",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"url": {
- "description": "The URL from which the file can be downloaded using your live secret API key.",
+ "description": "Use your live secret API key to download the file from this URL.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -11458,8 +12812,24 @@
"in_package": ""
}
},
+ "file.created": {
+ "description": "Occurs whenever a new Stripe-generated file is available for your account.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/file"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "file.created"
+ }
+ },
"file_link": {
- "description": "To share the contents of a `File` object with non-Stripe users, you can\ncreate a `FileLink`. `FileLink`s contain a URL that can be used to\nretrieve the contents of the file without authentication.",
+ "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.",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
@@ -11467,11 +12837,11 @@
"type": "integer"
},
"expired": {
- "description": "Whether this link is already expired.",
+ "description": "Returns if the link is already expired.",
"type": "boolean"
},
"expires_at": {
- "description": "Time at which the link expires.",
+ "description": "Time that the link expires.",
"format": "unix-time",
"nullable": true,
"type": "integer"
@@ -11802,13 +13172,87 @@
"x-stripeResource": {
"class_name": "Account",
"has_collection_class": true,
- "in_package": "FinancialConnections",
- "inner_classes": [
- "bank_connections_resource_accountholder",
- "bank_connections_resource_balance",
- "bank_connections_resource_balance_refresh",
- "bank_connections_resource_ownership_refresh"
- ]
+ "in_package": "FinancialConnections"
+ }
+ },
+ "financial_connections.account.created": {
+ "description": "Occurs when a new Financial Connections account is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "financial_connections.account.created"
+ }
+ },
+ "financial_connections.account.deactivated": {
+ "description": "Occurs when a Financial Connections account's status is updated from `active` to `inactive`.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "financial_connections.account.deactivated"
+ }
+ },
+ "financial_connections.account.disconnected": {
+ "description": "Occurs when a Financial Connections account is disconnected.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "financial_connections.account.disconnected"
+ }
+ },
+ "financial_connections.account.reactivated": {
+ "description": "Occurs when a Financial Connections account's status is updated from `inactive` to `active`.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "financial_connections.account.reactivated"
+ }
+ },
+ "financial_connections.account.refreshed_balance": {
+ "description": "Occurs when an Account’s `balance_refresh` status transitions from `pending` to either `succeeded` or `failed`.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/financial_connections.account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "financial_connections.account.refreshed_balance"
}
},
"financial_connections.account_owner": {
@@ -12047,6 +13491,19 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "Data features requested to be retrieved upon account creation.",
+ "items": {
+ "enum": [
+ "balances",
+ "ownership"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "nullable": true,
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -12060,7 +13517,8 @@
"id",
"livemode",
"object",
- "permissions"
+ "permissions",
+ "prefetch"
],
"title": "BankConnectionsResourceLinkAccountSession",
"type": "object",
@@ -12088,10 +13546,7 @@
],
"x-stripeResource": {
"class_name": "Session",
- "in_package": "FinancialConnections",
- "inner_classes": [
- "bank_connections_resource_link_account_session_filters"
- ]
+ "in_package": "FinancialConnections"
}
},
"financial_reporting_finance_report_run_run_parameters": {
@@ -12145,7 +13600,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Parameters",
- "in_class": "reporting.report_run"
+ "in_package": ""
}
},
"funding_instructions": {
@@ -12193,10 +13648,7 @@
"x-resourceId": "funding_instructions",
"x-stripeResource": {
"class_name": "FundingInstructions",
- "in_package": "",
- "inner_classes": [
- "funding_instructions_bank_transfer"
- ]
+ "in_package": ""
}
},
"funding_instructions_bank_transfer": {
@@ -12236,10 +13688,7 @@
],
"x-stripeResource": {
"class_name": "BankTransfer",
- "in_class": "funding_instructions",
- "inner_classes": [
- "funding_instructions_bank_transfer_financial_address"
- ]
+ "in_package": ""
}
},
"funding_instructions_bank_transfer_financial_address": {
@@ -12297,13 +13746,7 @@
],
"x-stripeResource": {
"class_name": "FinancialAddress",
- "in_class": "funding_instructions_bank_transfer",
- "inner_classes": [
- "funding_instructions_bank_transfer_iban_record",
- "funding_instructions_bank_transfer_sort_code_record",
- "funding_instructions_bank_transfer_spei_record",
- "funding_instructions_bank_transfer_zengin_record"
- ]
+ "in_package": ""
}
},
"funding_instructions_bank_transfer_iban_record": {
@@ -12341,7 +13784,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Iban",
- "in_class": "funding_instructions_bank_transfer_financial_address"
+ "in_package": ""
}
},
"funding_instructions_bank_transfer_sort_code_record": {
@@ -12373,7 +13816,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SortCode",
- "in_class": "funding_instructions_bank_transfer_financial_address"
+ "in_package": ""
}
},
"funding_instructions_bank_transfer_spei_record": {
@@ -12405,7 +13848,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Spei",
- "in_class": "funding_instructions_bank_transfer_financial_address"
+ "in_package": ""
}
},
"funding_instructions_bank_transfer_zengin_record": {
@@ -12468,7 +13911,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Zengin",
- "in_class": "funding_instructions_bank_transfer_financial_address"
+ "in_package": ""
}
},
"gelato_data_document_report_date_of_birth": {
@@ -12500,7 +13943,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "gelato_document_report"
+ "in_package": ""
}
},
"gelato_data_document_report_expiration_date": {
@@ -12532,7 +13975,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ExpirationDate",
- "in_class": "gelato_document_report"
+ "in_package": ""
}
},
"gelato_data_document_report_issued_date": {
@@ -12564,7 +14007,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "IssuedDate",
- "in_class": "gelato_document_report"
+ "in_package": ""
}
},
"gelato_data_id_number_report_date": {
@@ -12596,7 +14039,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "gelato_id_number_report"
+ "in_package": ""
}
},
"gelato_data_verified_outputs_date": {
@@ -12628,7 +14071,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "gelato_verified_outputs"
+ "in_package": ""
}
},
"gelato_document_report": {
@@ -12757,13 +14200,7 @@
],
"x-stripeResource": {
"class_name": "Document",
- "in_class": "identity.verification_report",
- "inner_classes": [
- "gelato_data_document_report_date_of_birth",
- "gelato_data_document_report_expiration_date",
- "gelato_data_document_report_issued_date",
- "gelato_document_report_error"
- ]
+ "in_package": ""
}
},
"gelato_document_report_error": {
@@ -12796,7 +14233,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DocumentCheckError",
- "in_class": "gelato_document_report"
+ "in_package": ""
}
},
"gelato_id_number_report": {
@@ -12875,11 +14312,7 @@
],
"x-stripeResource": {
"class_name": "IdNumber",
- "in_class": "identity.verification_report",
- "inner_classes": [
- "gelato_data_id_number_report_date",
- "gelato_id_number_report_error"
- ]
+ "in_package": ""
}
},
"gelato_id_number_report_error": {
@@ -12911,7 +14344,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "IdNumberCheckError",
- "in_class": "gelato_id_number_report"
+ "in_package": ""
}
},
"gelato_report_document_options": {
@@ -12947,7 +14380,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Document",
- "in_class": "gelato_verification_report_options"
+ "in_package": ""
}
},
"gelato_report_id_number_options": {
@@ -12958,7 +14391,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "IdNumber",
- "in_class": "gelato_verification_report_options"
+ "in_package": ""
}
},
"gelato_selfie_report": {
@@ -13008,10 +14441,7 @@
],
"x-stripeResource": {
"class_name": "Selfie",
- "in_class": "identity.verification_report",
- "inner_classes": [
- "gelato_selfie_report_error"
- ]
+ "in_package": ""
}
},
"gelato_selfie_report_error": {
@@ -13044,7 +14474,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SelfieCheckError",
- "in_class": "gelato_selfie_report"
+ "in_package": ""
}
},
"gelato_session_document_options": {
@@ -13080,7 +14510,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Document",
- "in_class": "gelato_verification_session_options"
+ "in_package": ""
}
},
"gelato_session_id_number_options": {
@@ -13091,7 +14521,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "IdNumber",
- "in_class": "gelato_verification_session_options"
+ "in_package": ""
}
},
"gelato_session_last_error": {
@@ -13136,7 +14566,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LastError",
- "in_class": "identity.verification_session"
+ "in_package": ""
}
},
"gelato_verification_report_options": {
@@ -13157,11 +14587,7 @@
],
"x-stripeResource": {
"class_name": "Options",
- "in_class": "identity.verification_report",
- "inner_classes": [
- "gelato_report_document_options",
- "gelato_report_id_number_options"
- ]
+ "in_package": ""
}
},
"gelato_verification_session_options": {
@@ -13182,11 +14608,7 @@
],
"x-stripeResource": {
"class_name": "Options",
- "in_class": "identity.verification_session",
- "inner_classes": [
- "gelato_session_document_options",
- "gelato_session_id_number_options"
- ]
+ "in_package": ""
}
},
"gelato_verified_outputs": {
@@ -13255,10 +14677,7 @@
],
"x-stripeResource": {
"class_name": "VerifiedOutputs",
- "in_class": "identity.verification_session",
- "inner_classes": [
- "gelato_data_verified_outputs_date"
- ]
+ "in_package": ""
}
},
"identity.verification_report": {
@@ -13348,13 +14767,7 @@
"x-stripeResource": {
"class_name": "VerificationReport",
"has_collection_class": true,
- "in_package": "Identity",
- "inner_classes": [
- "gelato_document_report",
- "gelato_id_number_report",
- "gelato_selfie_report",
- "gelato_verification_report_options"
- ]
+ "in_package": "Identity"
}
},
"identity.verification_session": {
@@ -13551,13 +14964,103 @@
"x-stripeResource": {
"class_name": "VerificationSession",
"has_collection_class": true,
- "in_package": "Identity",
- "inner_classes": [
- "gelato_session_last_error",
- "gelato_verification_session_options",
- "gelato_verified_outputs",
- "verification_session_redaction"
- ]
+ "in_package": "Identity"
+ }
+ },
+ "identity.verification_session.canceled": {
+ "description": "Occurs whenever a VerificationSession is canceled",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.canceled"
+ }
+ },
+ "identity.verification_session.created": {
+ "description": "Occurs whenever a VerificationSession is created",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.created"
+ }
+ },
+ "identity.verification_session.processing": {
+ "description": "Occurs whenever a VerificationSession transitions to processing",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.processing"
+ }
+ },
+ "identity.verification_session.redacted": {
+ "description": "Occurs whenever a VerificationSession is redacted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.redacted"
+ }
+ },
+ "identity.verification_session.requires_input": {
+ "description": "Occurs whenever a VerificationSession transitions to require user input",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.requires_input"
+ }
+ },
+ "identity.verification_session.verified": {
+ "description": "Occurs whenever a VerificationSession transitions to verified",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/identity.verification_session"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "identity.verification_session.verified"
}
},
"inbound_transfers": {
@@ -13590,10 +15093,7 @@
],
"x-stripeResource": {
"class_name": "OriginPaymentMethodDetails",
- "in_class": "treasury.inbound_transfer",
- "inner_classes": [
- "inbound_transfers_payment_method_details_us_bank_account"
- ]
+ "in_package": ""
}
},
"inbound_transfers_payment_method_details_us_bank_account": {
@@ -13663,7 +15163,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "inbound_transfers"
+ "in_package": ""
}
},
"invoice": {
@@ -13715,11 +15215,11 @@
"type": "integer"
},
"amount_paid": {
- "description": "The amount, in %s, that was paid.",
+ "description": "The amount, in cents (or local equivalent), that was paid.",
"type": "integer"
},
"amount_remaining": {
- "description": "The difference between amount_due and amount_paid, in %s.",
+ "description": "The difference between amount_due and amount_paid, in cents (or local equivalent).",
"type": "integer"
},
"amount_shipping": {
@@ -13753,7 +15253,7 @@
}
},
"application_fee_amount": {
- "description": "The fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account when the invoice is paid.",
+ "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.",
"nullable": true,
"type": "integer"
},
@@ -13773,7 +15273,7 @@
"$ref": "#/components/schemas/automatic_tax"
},
"billing_reason": {
- "description": "Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.",
+ "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.",
"enum": [
"automatic_pending_invoice_item_invoice",
"manual",
@@ -14248,13 +15748,22 @@
"nullable": true,
"type": "string"
},
+ "rendering": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/invoices_invoice_rendering"
+ }
+ ],
+ "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
+ "nullable": true
+ },
"rendering_options": {
"anyOf": [
{
"$ref": "#/components/schemas/invoice_setting_rendering_options"
}
],
- "description": "Options for invoice PDF rendering.",
+ "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering.",
"nullable": true
},
"shipping_cost": {
@@ -14321,6 +15830,15 @@
]
}
},
+ "subscription_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/subscription_details_data"
+ }
+ ],
+ "description": "Details about the subscription that created this invoice.",
+ "nullable": true
+ },
"subscription_proration_date": {
"description": "Only set for upcoming invoices that preview prorations. The time used to calculate prorations.",
"type": "integer"
@@ -14330,7 +15848,7 @@
"type": "integer"
},
"subtotal_excluding_tax": {
- "description": "The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated",
+ "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",
"nullable": true,
"type": "integer"
},
@@ -14375,7 +15893,7 @@
"type": "array"
},
"total_excluding_tax": {
- "description": "The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.",
+ "description": "The integer amount in cents (or local equivalent) representing the total amount of the invoice including all discounts but excluding all tax.",
"nullable": true,
"type": "integer"
},
@@ -14458,6 +15976,7 @@
"pre_payment_credit_notes_amount",
"quote",
"receipt_number",
+ "rendering",
"rendering_options",
"shipping_cost",
"shipping_details",
@@ -14466,6 +15985,7 @@
"status",
"status_transitions",
"subscription",
+ "subscription_details",
"subtotal",
"subtotal_excluding_tax",
"tax",
@@ -14502,11 +16022,13 @@
"payment_intent",
"payment_settings",
"quote",
+ "rendering",
"rendering_options",
"shipping_cost",
"shipping_details",
"status_transitions",
"subscription",
+ "subscription_details",
"test_clock",
"threshold_reason",
"total_discount_amounts",
@@ -14611,22 +16133,215 @@
"class_name": "Invoice",
"has_collection_class": true,
"has_search_result_class": true,
- "in_package": "",
- "inner_classes": [
- "automatic_tax",
- "invoice_item_threshold_reason",
- "invoice_setting_custom_field",
- "invoice_setting_rendering_options",
- "invoice_tax_amount",
- "invoice_threshold_reason",
- "invoice_transfer_data",
- "invoices_from_invoice",
- "invoices_payment_method_options",
- "invoices_payment_settings",
- "invoices_resource_invoice_tax_id",
- "invoices_shipping_cost",
- "invoices_status_transitions"
- ]
+ "in_package": ""
+ }
+ },
+ "invoice.created": {
+ "description": "Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see [Using Webhooks with Subscriptions](/docs/subscriptions/webhooks).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.created"
+ }
+ },
+ "invoice.deleted": {
+ "description": "Occurs whenever a draft invoice is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.deleted"
+ }
+ },
+ "invoice.finalization_failed": {
+ "description": "Occurs whenever a draft invoice cannot be finalized. See the invoice’s [last finalization error](/docs/api/invoices/object#invoice_object-last_finalization_error) for details.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.finalization_failed"
+ }
+ },
+ "invoice.finalized": {
+ "description": "Occurs whenever a draft invoice is finalized and updated to be an open invoice.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.finalized"
+ }
+ },
+ "invoice.marked_uncollectible": {
+ "description": "Occurs whenever an invoice is marked uncollectible.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.marked_uncollectible"
+ }
+ },
+ "invoice.paid": {
+ "description": "Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.paid"
+ }
+ },
+ "invoice.payment_action_required": {
+ "description": "Occurs whenever an invoice payment attempt requires further user action to complete.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.payment_action_required"
+ }
+ },
+ "invoice.payment_failed": {
+ "description": "Occurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.payment_failed"
+ }
+ },
+ "invoice.payment_succeeded": {
+ "description": "Occurs whenever an invoice payment attempt succeeds.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.payment_succeeded"
+ }
+ },
+ "invoice.sent": {
+ "description": "Occurs whenever an invoice email is sent out.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.sent"
+ }
+ },
+ "invoice.upcoming": {
+ "description": "Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your [subscriptions settings](https://dashboard.stripe.com/account/billing/automatic). Note: The received `Invoice` object will not have an invoice ID.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.upcoming"
+ }
+ },
+ "invoice.updated": {
+ "description": "Occurs whenever an invoice changes (e.g., the invoice amount).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.updated"
+ }
+ },
+ "invoice.voided": {
+ "description": "Occurs whenever an invoice is voided.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoice.voided"
}
},
"invoice_installments_card": {
@@ -14646,7 +16361,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Installments",
- "in_class": "invoice_payment_method_options_card"
+ "in_package": ""
}
},
"invoice_item_threshold_reason": {
@@ -14674,7 +16389,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ThresholdItemReason",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoice_line_item_period": {
@@ -14737,7 +16452,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "subscription_payment_method_options_card"
+ "in_package": ""
}
},
"invoice_payment_method_options_acss_debit": {
@@ -14764,10 +16479,7 @@
],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "invoices_payment_method_options",
- "inner_classes": [
- "invoice_payment_method_options_acss_debit_mandate_options"
- ]
+ "in_package": ""
}
},
"invoice_payment_method_options_acss_debit_mandate_options": {
@@ -14791,7 +16503,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "invoice_payment_method_options_acss_debit"
+ "in_package": ""
}
},
"invoice_payment_method_options_bancontact": {
@@ -14816,7 +16528,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "invoices_payment_method_options"
+ "in_package": ""
}
},
"invoice_payment_method_options_card": {
@@ -14845,10 +16557,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "invoices_payment_method_options",
- "inner_classes": [
- "invoice_installments_card"
- ]
+ "in_package": ""
}
},
"invoice_payment_method_options_customer_balance": {
@@ -14876,10 +16585,7 @@
],
"x-stripeResource": {
"class_name": "CustomerBalance",
- "in_class": "invoices_payment_method_options",
- "inner_classes": [
- "invoice_payment_method_options_customer_balance_bank_transfer"
- ]
+ "in_package": ""
}
},
"invoice_payment_method_options_customer_balance_bank_transfer": {
@@ -14904,10 +16610,7 @@
],
"x-stripeResource": {
"class_name": "BankTransfer",
- "in_class": "invoice_payment_method_options_customer_balance",
- "inner_classes": [
- "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer"
- ]
+ "in_package": ""
}
},
"invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": {
@@ -14934,7 +16637,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EuBankTransfer",
- "in_class": "invoice_payment_method_options_customer_balance_bank_transfer"
+ "in_package": ""
}
},
"invoice_payment_method_options_konbini": {
@@ -14945,7 +16648,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Konbini",
- "in_class": "invoices_payment_method_options"
+ "in_package": ""
}
},
"invoice_payment_method_options_us_bank_account": {
@@ -14972,10 +16675,7 @@
],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "invoices_payment_method_options",
- "inner_classes": [
- "invoice_payment_method_options_us_bank_account_linked_account_options"
- ]
+ "in_package": ""
}
},
"invoice_payment_method_options_us_bank_account_linked_account_options": {
@@ -14993,14 +16693,54 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "Data features requested to be retrieved upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "nullable": true,
+ "type": "array"
}
},
+ "required": [
+ "prefetch"
+ ],
"title": "invoice_payment_method_options_us_bank_account_linked_account_options",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FinancialConnections",
- "in_class": "invoice_payment_method_options_us_bank_account"
+ "in_package": ""
+ }
+ },
+ "invoice_rendering_pdf": {
+ "description": "",
+ "properties": {
+ "page_size": {
+ "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.",
+ "enum": [
+ "a4",
+ "auto",
+ "letter"
+ ],
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "page_size"
+ ],
+ "title": "InvoiceRenderingPdf",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "InvoiceRenderingPdfResource",
+ "in_package": ""
}
},
"invoice_setting_custom_field": {
@@ -15026,7 +16766,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomField",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoice_setting_customer_setting": {
@@ -15091,14 +16831,14 @@
],
"x-stripeResource": {
"class_name": "InvoiceSettings",
- "in_class": "customer"
+ "in_package": ""
}
},
- "invoice_setting_phase_setting": {
+ "invoice_setting_quote_setting": {
"description": "",
"properties": {
"days_until_due": {
- "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`.",
+ "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`.",
"nullable": true,
"type": "integer"
}
@@ -15106,53 +16846,53 @@
"required": [
"days_until_due"
],
- "title": "InvoiceSettingPhaseSetting",
+ "title": "InvoiceSettingQuoteSetting",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "InvoiceSettings",
- "in_class": "subscription_schedule_phase_configuration"
+ "in_package": ""
}
},
- "invoice_setting_quote_setting": {
+ "invoice_setting_rendering_options": {
"description": "",
"properties": {
- "days_until_due": {
- "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`.",
+ "amount_tax_display": {
+ "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
+ "maxLength": 5000,
"nullable": true,
- "type": "integer"
+ "type": "string"
}
},
"required": [
- "days_until_due"
+ "amount_tax_display"
],
- "title": "InvoiceSettingQuoteSetting",
+ "title": "InvoiceSettingRenderingOptions",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_class": "quote"
+ "class_name": "RenderingOptions",
+ "in_package": ""
}
},
- "invoice_setting_rendering_options": {
+ "invoice_setting_subscription_schedule_phase_setting": {
"description": "",
"properties": {
- "amount_tax_display": {
- "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
- "maxLength": 5000,
+ "days_until_due": {
+ "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`.",
"nullable": true,
- "type": "string"
+ "type": "integer"
}
},
"required": [
- "amount_tax_display"
+ "days_until_due"
],
- "title": "InvoiceSettingRenderingOptions",
+ "title": "InvoiceSettingSubscriptionSchedulePhaseSetting",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
- "class_name": "RenderingOptions",
- "in_class": "invoice"
+ "class_name": "InvoiceSettings",
+ "in_package": ""
}
},
"invoice_setting_subscription_schedule_setting": {
@@ -15172,14 +16912,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "InvoiceSettings",
- "in_class": "subscription_schedule"
+ "in_package": ""
}
},
"invoice_tax_amount": {
"description": "",
"properties": {
"amount": {
- "description": "The amount, in %s, of the tax.",
+ "description": "The amount, in cents (or local equivalent), of the tax.",
"type": "integer"
},
"inclusive": {
@@ -15229,7 +16969,7 @@
"x-stripeBypassValidation": true
},
"taxable_amount": {
- "description": "The amount on which tax is calculated, in %s.",
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
"nullable": true,
"type": "integer"
}
@@ -15248,7 +16988,7 @@
],
"x-stripeResource": {
"class_name": "TaxAmount",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoice_threshold_reason": {
@@ -15278,14 +17018,14 @@
],
"x-stripeResource": {
"class_name": "ThresholdReason",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoice_transfer_data": {
"description": "",
"properties": {
"amount": {
- "description": "The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.",
+ "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.",
"nullable": true,
"type": "integer"
},
@@ -15320,7 +17060,7 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoiceitem": {
@@ -15617,6 +17357,38 @@
"in_package": ""
}
},
+ "invoiceitem.created": {
+ "description": "Occurs whenever an invoice item is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoiceitem"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoiceitem.created"
+ }
+ },
+ "invoiceitem.deleted": {
+ "description": "Occurs whenever an invoice item is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/invoiceitem"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "invoiceitem.deleted"
+ }
+ },
"invoices_from_invoice": {
"description": "",
"properties": {
@@ -15656,7 +17428,40 @@
],
"x-stripeResource": {
"class_name": "FromInvoice",
- "in_class": "invoice"
+ "in_package": ""
+ }
+ },
+ "invoices_invoice_rendering": {
+ "description": "",
+ "properties": {
+ "amount_tax_display": {
+ "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "pdf": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/invoice_rendering_pdf"
+ }
+ ],
+ "description": "Invoice pdf rendering options",
+ "nullable": true
+ }
+ },
+ "required": [
+ "amount_tax_display",
+ "pdf"
+ ],
+ "title": "InvoicesInvoiceRendering",
+ "type": "object",
+ "x-expandableFields": [
+ "pdf"
+ ],
+ "x-stripeResource": {
+ "class_name": "InvoiceRendering",
+ "in_package": ""
}
},
"invoices_payment_method_options": {
@@ -15737,15 +17542,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodOptions",
- "in_class": "invoice",
- "inner_classes": [
- "invoice_payment_method_options_acss_debit",
- "invoice_payment_method_options_bancontact",
- "invoice_payment_method_options_card",
- "invoice_payment_method_options_customer_balance",
- "invoice_payment_method_options_konbini",
- "invoice_payment_method_options_us_bank_account"
- ]
+ "in_package": ""
}
},
"invoices_payment_settings": {
@@ -15814,7 +17611,7 @@
],
"x-stripeResource": {
"class_name": "PaymentSettings",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoices_resource_invoice_tax_id": {
@@ -15909,7 +17706,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomerTaxId",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoices_resource_line_items_credited_items": {
@@ -16024,7 +17821,7 @@
],
"x-stripeResource": {
"class_name": "ShippingCost",
- "in_class": "invoice"
+ "in_package": ""
}
},
"invoices_status_transitions": {
@@ -16066,7 +17863,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "invoice"
+ "in_package": ""
}
},
"issuing.authorization": {
@@ -16208,6 +18005,26 @@
],
"type": "string"
},
+ "token": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ ],
+ "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.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ ]
+ }
+ },
"transactions": {
"description": "List of [transactions](https://stripe.com/docs/api/issuing/transactions) associated with this authorization.",
"items": {
@@ -16270,6 +18087,7 @@
"network_data",
"pending_request",
"request_history",
+ "token",
"transactions",
"treasury",
"verification_data"
@@ -16310,21 +18128,47 @@
"method_type": "custom",
"operation": "post",
"path": "/v1/issuing/authorizations/{authorization}/decline"
+ },
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/authorizations"
+ },
+ {
+ "method_name": "increment",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/authorizations/{authorization}/increment"
+ },
+ {
+ "method_name": "reverse",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/authorizations/{authorization}/reverse"
+ },
+ {
+ "method_name": "expire",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/authorizations/{authorization}/expire"
+ },
+ {
+ "method_name": "capture",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/authorizations/{authorization}/capture"
}
],
"x-stripeResource": {
"class_name": "Authorization",
"has_collection_class": true,
"in_package": "Issuing",
- "inner_classes": [
- "issuing_authorization_amount_details",
- "issuing_authorization_merchant_data",
- "issuing_authorization_network_data",
- "issuing_authorization_pending_request",
- "issuing_authorization_request",
- "issuing_authorization_treasury",
- "issuing_authorization_verification_data"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
@@ -16600,12 +18444,7 @@
"x-stripeResource": {
"class_name": "Card",
"has_collection_class": true,
- "in_package": "Issuing",
- "inner_classes": [
- "issuing_card_authorization_controls",
- "issuing_card_shipping",
- "issuing_card_wallets"
- ]
+ "in_package": "Issuing"
}
},
"issuing.cardholder": {
@@ -16785,14 +18624,7 @@
"x-stripeResource": {
"class_name": "Cardholder",
"has_collection_class": true,
- "in_package": "Issuing",
- "inner_classes": [
- "issuing_cardholder_address",
- "issuing_cardholder_authorization_controls",
- "issuing_cardholder_company",
- "issuing_cardholder_individual",
- "issuing_cardholder_requirements"
- ]
+ "in_package": "Issuing"
}
},
"issuing.dispute": {
@@ -16949,15 +18781,148 @@
"class_name": "Dispute",
"has_collection_class": true,
"in_package": "Issuing",
- "inner_classes": [
- "issuing_dispute_evidence",
- "issuing_dispute_treasury"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
}
},
+ "issuing.token": {
+ "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.",
+ "properties": {
+ "card": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ ],
+ "description": "Card associated with this token.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ ]
+ }
+ },
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "device_fingerprint": {
+ "description": "The hashed ID derived from the device ID from the card network associated with the token",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "last4": {
+ "description": "The last four digits of the token.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "network": {
+ "description": "The token service provider / card network associated with the token.",
+ "enum": [
+ "mastercard",
+ "visa"
+ ],
+ "type": "string"
+ },
+ "network_data": {
+ "$ref": "#/components/schemas/issuing_network_token_network_data"
+ },
+ "network_updated_at": {
+ "description": "Time at which the token was last updated by the card network. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "issuing.token"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "description": "The usage state of the token.",
+ "enum": [
+ "active",
+ "deleted",
+ "requested",
+ "suspended"
+ ],
+ "type": "string"
+ },
+ "wallet_provider": {
+ "description": "The digital wallet for this token, if one was used.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "card",
+ "created",
+ "device_fingerprint",
+ "id",
+ "livemode",
+ "network",
+ "network_updated_at",
+ "object",
+ "status"
+ ],
+ "title": "IssuingNetworkToken",
+ "type": "object",
+ "x-expandableFields": [
+ "card",
+ "network_data"
+ ],
+ "x-resourceId": "issuing.token",
+ "x-stripeOperations": [
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/issuing/tokens"
+ },
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/issuing/tokens/{token}"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/issuing/tokens/{token}"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "Token",
+ "has_collection_class": true,
+ "in_package": "Issuing"
+ }
+ },
"issuing.transaction": {
"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)",
"properties": {
@@ -17126,6 +19091,26 @@
"description": "Additional purchase information that is optionally provided by the merchant.",
"nullable": true
},
+ "token": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ ],
+ "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.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ ]
+ }
+ },
"treasury": {
"anyOf": [
{
@@ -17187,6 +19172,7 @@
"dispute",
"merchant_data",
"purchase_details",
+ "token",
"treasury"
],
"x-resourceId": "issuing.transaction",
@@ -17211,22 +19197,86 @@
"method_type": "update",
"operation": "post",
"path": "/v1/issuing/transactions/{transaction}"
+ },
+ {
+ "method_name": "create_force_capture",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/transactions/create_force_capture"
+ },
+ {
+ "method_name": "create_unlinked_refund",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/transactions/create_unlinked_refund"
+ },
+ {
+ "method_name": "refund",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/test_helpers/issuing/transactions/{transaction}/refund"
}
],
"x-stripeResource": {
"class_name": "Transaction",
"has_collection_class": true,
"in_package": "Issuing",
- "inner_classes": [
- "issuing_transaction_amount_details",
- "issuing_transaction_purchase_details",
- "issuing_transaction_treasury"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
}
},
+ "issuing_authorization.created": {
+ "description": "Occurs whenever an authorization is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_authorization.created"
+ }
+ },
+ "issuing_authorization.request": {
+ "description": "Represents a synchronous request for authorization, see [Using your integration to handle authorization requests](/docs/issuing/purchases/authorizations#authorization-handling).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_authorization.request"
+ }
+ },
+ "issuing_authorization.updated": {
+ "description": "Occurs whenever an authorization is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_authorization.updated"
+ }
+ },
"issuing_authorization_amount_details": {
"description": "",
"properties": {
@@ -17234,17 +19284,23 @@
"description": "The fee charged by the ATM for the cash withdrawal.",
"nullable": true,
"type": "integer"
+ },
+ "cashback_amount": {
+ "description": "The amount of cash requested by the cardholder.",
+ "nullable": true,
+ "type": "integer"
}
},
"required": [
- "atm_fee"
+ "atm_fee",
+ "cashback_amount"
],
"title": "IssuingAuthorizationAmountDetails",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AmountDetails",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_merchant_data": {
@@ -17318,7 +19374,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MerchantData",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_network_data": {
@@ -17339,7 +19395,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NetworkData",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_pending_request": {
@@ -17390,7 +19446,7 @@
],
"x-stripeResource": {
"class_name": "PendingRequest",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_request": {
@@ -17413,6 +19469,12 @@
"description": "Whether this request was approved.",
"type": "boolean"
},
+ "authorization_code": {
+ "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.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
@@ -17464,6 +19526,7 @@
"amount",
"amount_details",
"approved",
+ "authorization_code",
"created",
"currency",
"merchant_amount",
@@ -17478,7 +19541,7 @@
],
"x-stripeResource": {
"class_name": "RequestHistory",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_treasury": {
@@ -17517,7 +19580,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Treasury",
- "in_class": "issuing.authorization"
+ "in_package": ""
}
},
"issuing_authorization_verification_data": {
@@ -17558,20 +19621,59 @@
"not_provided"
],
"type": "string"
+ },
+ "postal_code": {
+ "description": "The postal code submitted as part of the authorization used for postal code verification.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
"address_line1_check",
"address_postal_code_check",
"cvc_check",
- "expiry_check"
+ "expiry_check",
+ "postal_code"
],
"title": "IssuingAuthorizationVerificationData",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "VerificationData",
- "in_class": "issuing.authorization"
+ "in_package": ""
+ }
+ },
+ "issuing_card.created": {
+ "description": "Occurs whenever a card is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_card.created"
+ }
+ },
+ "issuing_card.updated": {
+ "description": "Occurs whenever a card is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_card.updated"
}
},
"issuing_card_apple_pay": {
@@ -17601,7 +19703,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ApplePay",
- "in_class": "issuing_card_wallets"
+ "in_package": ""
}
},
"issuing_card_authorization_controls": {
@@ -18244,10 +20346,7 @@
],
"x-stripeResource": {
"class_name": "SpendingControls",
- "in_class": "issuing.card",
- "inner_classes": [
- "issuing_card_spending_limit"
- ]
+ "in_package": ""
}
},
"issuing_card_google_pay": {
@@ -18277,7 +20376,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GooglePay",
- "in_class": "issuing_card_wallets"
+ "in_package": ""
}
},
"issuing_card_shipping": {
@@ -18318,7 +20417,7 @@
"type": "string"
},
"phone_number": {
- "description": "The phone number of the receiver of the bulk shipment. This phone number will be provided to the shipping company, who might use it to contact the receiver in case of delivery issues.",
+ "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.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -18349,8 +20448,7 @@
"shipped"
],
"nullable": true,
- "type": "string",
- "x-stripeBypassValidation": true
+ "type": "string"
},
"tracking_number": {
"description": "A tracking number for a card shipment.",
@@ -18395,10 +20493,7 @@
],
"x-stripeResource": {
"class_name": "Shipping",
- "in_class": "issuing.card",
- "inner_classes": [
- "issuing_card_shipping_customs"
- ]
+ "in_package": ""
}
},
"issuing_card_shipping_customs": {
@@ -18419,7 +20514,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Customs",
- "in_class": "issuing_card_shipping"
+ "in_package": ""
}
},
"issuing_card_spending_limit": {
@@ -18757,7 +20852,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SpendingLimit",
- "in_class": "issuing_card_authorization_controls"
+ "in_package": ""
}
},
"issuing_card_wallets": {
@@ -18789,11 +20884,39 @@
],
"x-stripeResource": {
"class_name": "Wallets",
- "in_class": "issuing.card",
- "inner_classes": [
- "issuing_card_apple_pay",
- "issuing_card_google_pay"
- ]
+ "in_package": ""
+ }
+ },
+ "issuing_cardholder.created": {
+ "description": "Occurs whenever a cardholder is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.cardholder"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_cardholder.created"
+ }
+ },
+ "issuing_cardholder.updated": {
+ "description": "Occurs whenever a cardholder is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.cardholder"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_cardholder.updated"
}
},
"issuing_cardholder_address": {
@@ -18813,7 +20936,7 @@
],
"x-stripeResource": {
"class_name": "Billing",
- "in_class": "issuing.cardholder"
+ "in_package": ""
}
},
"issuing_cardholder_authorization_controls": {
@@ -19456,10 +21579,7 @@
],
"x-stripeResource": {
"class_name": "SpendingControls",
- "in_class": "issuing.cardholder",
- "inner_classes": [
- "issuing_cardholder_spending_limit"
- ]
+ "in_package": ""
}
},
"issuing_cardholder_card_issuing": {
@@ -19485,10 +21605,7 @@
],
"x-stripeResource": {
"class_name": "CardIssuing",
- "in_class": "issuing_cardholder_individual",
- "inner_classes": [
- "issuing_cardholder_user_terms_acceptance"
- ]
+ "in_package": ""
}
},
"issuing_cardholder_company": {
@@ -19507,7 +21624,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Company",
- "in_class": "issuing.cardholder"
+ "in_package": ""
}
},
"issuing_cardholder_id_document": {
@@ -19566,7 +21683,7 @@
],
"x-stripeResource": {
"class_name": "Document",
- "in_class": "issuing_cardholder_verification"
+ "in_package": ""
}
},
"issuing_cardholder_individual": {
@@ -19628,12 +21745,7 @@
],
"x-stripeResource": {
"class_name": "Individual",
- "in_class": "issuing.cardholder",
- "inner_classes": [
- "issuing_cardholder_card_issuing",
- "issuing_cardholder_individual_dob",
- "issuing_cardholder_verification"
- ]
+ "in_package": ""
}
},
"issuing_cardholder_individual_dob": {
@@ -19665,7 +21777,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "issuing_cardholder_individual"
+ "in_package": ""
}
},
"issuing_cardholder_requirements": {
@@ -19712,7 +21824,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Requirements",
- "in_class": "issuing.cardholder"
+ "in_package": ""
}
},
"issuing_cardholder_spending_limit": {
@@ -20050,7 +22162,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SpendingLimit",
- "in_class": "issuing_cardholder_authorization_controls"
+ "in_package": ""
}
},
"issuing_cardholder_user_terms_acceptance": {
@@ -20085,7 +22197,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UserTermsAcceptance",
- "in_class": "issuing_cardholder_card_issuing"
+ "in_package": ""
}
},
"issuing_cardholder_verification": {
@@ -20111,118 +22223,195 @@
],
"x-stripeResource": {
"class_name": "Verification",
- "in_class": "issuing_cardholder_individual",
- "inner_classes": [
- "issuing_cardholder_id_document"
- ]
+ "in_package": ""
}
},
- "issuing_dispute_canceled_evidence": {
- "description": "",
+ "issuing_dispute.closed": {
+ "description": "Occurs whenever a dispute is won, lost or expired.",
"properties": {
- "additional_documentation": {
- "anyOf": [
- {
- "maxLength": 5000,
- "type": "string"
- },
- {
- "$ref": "#/components/schemas/file"
- }
- ],
- "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
- "nullable": true,
- "x-expansionResources": {
- "oneOf": [
- {
- "$ref": "#/components/schemas/file"
- }
- ]
- }
- },
- "canceled_at": {
- "description": "Date when order was canceled.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "cancellation_policy_provided": {
- "description": "Whether the cardholder was provided with a cancellation policy.",
- "nullable": true,
- "type": "boolean"
- },
- "cancellation_reason": {
- "description": "Reason for canceling the order.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "expected_at": {
- "description": "Date when the cardholder expected to receive the product.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "product_type": {
- "description": "Whether the product was a merchandise or service.",
- "enum": [
- "merchandise",
- "service"
- ],
- "nullable": true,
- "type": "string"
- },
- "return_status": {
- "description": "Result of cardholder's attempt to return the product.",
- "enum": [
- "merchant_rejected",
- "successful"
- ],
- "nullable": true,
- "type": "string"
- },
- "returned_at": {
- "description": "Date when the product was returned or attempted to be returned.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
+ "object": {
+ "$ref": "#/components/schemas/issuing.dispute"
}
},
"required": [
- "additional_documentation",
- "canceled_at",
- "cancellation_policy_provided",
- "cancellation_reason",
- "expected_at",
- "explanation",
- "product_description",
- "product_type",
- "return_status",
- "returned_at"
+ "object"
],
- "title": "IssuingDisputeCanceledEvidence",
"type": "object",
- "x-expandableFields": [
- "additional_documentation"
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_dispute.closed"
+ }
+ },
+ "issuing_dispute.created": {
+ "description": "Occurs whenever a dispute is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.dispute"
+ }
+ },
+ "required": [
+ "object"
],
- "x-stripeResource": {
- "class_name": "Canceled",
- "in_class": "issuing_dispute_evidence"
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_dispute.created"
}
},
- "issuing_dispute_duplicate_evidence": {
+ "issuing_dispute.funds_reinstated": {
+ "description": "Occurs whenever funds are reinstated to your account for an Issuing dispute.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_dispute.funds_reinstated"
+ }
+ },
+ "issuing_dispute.submitted": {
+ "description": "Occurs whenever a dispute is submitted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_dispute.submitted"
+ }
+ },
+ "issuing_dispute.updated": {
+ "description": "Occurs whenever a dispute is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.dispute"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_dispute.updated"
+ }
+ },
+ "issuing_dispute_canceled_evidence": {
+ "description": "",
+ "properties": {
+ "additional_documentation": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/file"
+ }
+ ],
+ "description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/file"
+ }
+ ]
+ }
+ },
+ "canceled_at": {
+ "description": "Date when order was canceled.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "cancellation_policy_provided": {
+ "description": "Whether the cardholder was provided with a cancellation policy.",
+ "nullable": true,
+ "type": "boolean"
+ },
+ "cancellation_reason": {
+ "description": "Reason for canceling the order.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "expected_at": {
+ "description": "Date when the cardholder expected to receive the product.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "explanation": {
+ "description": "Explanation of why the cardholder is disputing this transaction.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "product_description": {
+ "description": "Description of the merchandise or service that was purchased.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "product_type": {
+ "description": "Whether the product was a merchandise or service.",
+ "enum": [
+ "merchandise",
+ "service"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "return_status": {
+ "description": "Result of cardholder's attempt to return the product.",
+ "enum": [
+ "merchant_rejected",
+ "successful"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "returned_at": {
+ "description": "Date when the product was returned or attempted to be returned.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "additional_documentation",
+ "canceled_at",
+ "cancellation_policy_provided",
+ "cancellation_reason",
+ "expected_at",
+ "explanation",
+ "product_description",
+ "product_type",
+ "return_status",
+ "returned_at"
+ ],
+ "title": "IssuingDisputeCanceledEvidence",
+ "type": "object",
+ "x-expandableFields": [
+ "additional_documentation"
+ ],
+ "x-stripeResource": {
+ "class_name": "Canceled",
+ "in_package": ""
+ }
+ },
+ "issuing_dispute_duplicate_evidence": {
"description": "",
"properties": {
"additional_documentation": {
@@ -20336,7 +22525,7 @@
],
"x-stripeResource": {
"class_name": "Duplicate",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_evidence": {
@@ -20394,16 +22583,7 @@
],
"x-stripeResource": {
"class_name": "Evidence",
- "in_class": "issuing.dispute",
- "inner_classes": [
- "issuing_dispute_canceled_evidence",
- "issuing_dispute_duplicate_evidence",
- "issuing_dispute_fraudulent_evidence",
- "issuing_dispute_merchandise_not_as_described_evidence",
- "issuing_dispute_not_received_evidence",
- "issuing_dispute_other_evidence",
- "issuing_dispute_service_not_as_described_evidence"
- ]
+ "in_package": ""
}
},
"issuing_dispute_fraudulent_evidence": {
@@ -20447,7 +22627,7 @@
],
"x-stripeResource": {
"class_name": "Fraudulent",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_merchandise_not_as_described_evidence": {
@@ -20522,7 +22702,7 @@
],
"x-stripeResource": {
"class_name": "MerchandiseNotAsDescribed",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_not_received_evidence": {
@@ -20590,7 +22770,7 @@
],
"x-stripeResource": {
"class_name": "NotReceived",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_other_evidence": {
@@ -20651,7 +22831,7 @@
],
"x-stripeResource": {
"class_name": "Other",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_service_not_as_described_evidence": {
@@ -20716,7 +22896,7 @@
],
"x-stripeResource": {
"class_name": "ServiceNotAsDescribed",
- "in_class": "issuing_dispute_evidence"
+ "in_package": ""
}
},
"issuing_dispute_treasury": {
@@ -20743,7 +22923,357 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Treasury",
- "in_class": "issuing.dispute"
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_address": {
+ "description": "",
+ "properties": {
+ "line1": {
+ "description": "The street address of the cardholder tokenizing the card.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "The postal code of the cardholder tokenizing the card.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "line1",
+ "postal_code"
+ ],
+ "title": "IssuingNetworkTokenAddress",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "CardholderAddress",
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_device": {
+ "description": "",
+ "properties": {
+ "device_fingerprint": {
+ "description": "An obfuscated ID derived from the device ID.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "ip_address": {
+ "description": "The IP address of the device at provisioning time.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "location": {
+ "description": "The geographic latitude/longitude coordinates of the device at provisioning time. The format is [+-]decimal/[+-]decimal.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "name": {
+ "description": "The name of the device used for tokenization.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "phone_number": {
+ "description": "The phone number of the device used for tokenization.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of device used for tokenization.",
+ "enum": [
+ "other",
+ "phone",
+ "watch"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "IssuingNetworkTokenDevice",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "Device",
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_mastercard": {
+ "description": "",
+ "properties": {
+ "card_reference_id": {
+ "description": "A unique reference ID from MasterCard to represent the card account number.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_reference_id": {
+ "description": "The network-unique identifier for the token.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_requestor_id": {
+ "description": "The ID of the entity requesting tokenization, specific to MasterCard.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_requestor_name": {
+ "description": "The name of the entity requesting tokenization, if known. This is directly provided from MasterCard.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "token_reference_id",
+ "token_requestor_id"
+ ],
+ "title": "IssuingNetworkTokenMastercard",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "Mastercard",
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_network_data": {
+ "description": "",
+ "properties": {
+ "device": {
+ "$ref": "#/components/schemas/issuing_network_token_device"
+ },
+ "mastercard": {
+ "$ref": "#/components/schemas/issuing_network_token_mastercard"
+ },
+ "type": {
+ "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.",
+ "enum": [
+ "mastercard",
+ "visa"
+ ],
+ "type": "string"
+ },
+ "visa": {
+ "$ref": "#/components/schemas/issuing_network_token_visa"
+ },
+ "wallet_provider": {
+ "$ref": "#/components/schemas/issuing_network_token_wallet_provider"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "IssuingNetworkTokenNetworkData",
+ "type": "object",
+ "x-expandableFields": [
+ "device",
+ "mastercard",
+ "visa",
+ "wallet_provider"
+ ],
+ "x-stripeResource": {
+ "class_name": "NetworkData",
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_visa": {
+ "description": "",
+ "properties": {
+ "card_reference_id": {
+ "description": "A unique reference ID from Visa to represent the card account number.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_reference_id": {
+ "description": "The network-unique identifier for the token.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_requestor_id": {
+ "description": "The ID of the entity requesting tokenization, specific to Visa.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "token_risk_score": {
+ "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.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "card_reference_id",
+ "token_reference_id",
+ "token_requestor_id"
+ ],
+ "title": "IssuingNetworkTokenVisa",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "Visa",
+ "in_package": ""
+ }
+ },
+ "issuing_network_token_wallet_provider": {
+ "description": "",
+ "properties": {
+ "account_id": {
+ "description": "The wallet provider-given account ID of the digital wallet the token belongs to.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "account_trust_score": {
+ "description": "An evaluation on the trustworthiness of the wallet account between 1 and 5. A higher score indicates more trustworthy.",
+ "type": "integer"
+ },
+ "card_number_source": {
+ "description": "The method used for tokenizing a card.",
+ "enum": [
+ "app",
+ "manual",
+ "on_file",
+ "other"
+ ],
+ "type": "string"
+ },
+ "cardholder_address": {
+ "$ref": "#/components/schemas/issuing_network_token_address"
+ },
+ "cardholder_name": {
+ "description": "The name of the cardholder tokenizing the card.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "device_trust_score": {
+ "description": "An evaluation on the trustworthiness of the device. A higher score indicates more trustworthy.",
+ "type": "integer"
+ },
+ "hashed_account_email_address": {
+ "description": "The hashed email address of the cardholder's account with the wallet provider.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "reason_codes": {
+ "description": "The reasons for suggested tokenization given by the card network.",
+ "items": {
+ "enum": [
+ "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"
+ ],
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "suggested_decision": {
+ "description": "The recommendation on responding to the tokenization request.",
+ "enum": [
+ "approve",
+ "decline",
+ "require_auth"
+ ],
+ "type": "string"
+ },
+ "suggested_decision_version": {
+ "description": "The version of the standard for mapping reason codes followed by the wallet provider.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "IssuingNetworkTokenWalletProvider",
+ "type": "object",
+ "x-expandableFields": [
+ "cardholder_address"
+ ],
+ "x-stripeResource": {
+ "class_name": "WalletProvider",
+ "in_package": ""
+ }
+ },
+ "issuing_token.created": {
+ "description": "Occurs whenever an issuing digital wallet token is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_token.created"
+ }
+ },
+ "issuing_token.updated": {
+ "description": "Occurs whenever an issuing digital wallet token is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_token.updated"
+ }
+ },
+ "issuing_transaction.created": {
+ "description": "Occurs whenever an issuing transaction is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.transaction"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_transaction.created"
+ }
+ },
+ "issuing_transaction.updated": {
+ "description": "Occurs whenever an issuing transaction is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/issuing.transaction"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "issuing_transaction.updated"
}
},
"issuing_transaction_amount_details": {
@@ -20753,17 +23283,23 @@
"description": "The fee charged by the ATM for the cash withdrawal.",
"nullable": true,
"type": "integer"
+ },
+ "cashback_amount": {
+ "description": "The amount of cash requested by the cardholder.",
+ "nullable": true,
+ "type": "integer"
}
},
"required": [
- "atm_fee"
+ "atm_fee",
+ "cashback_amount"
],
"title": "IssuingTransactionAmountDetails",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AmountDetails",
- "in_class": "issuing.transaction"
+ "in_package": ""
}
},
"issuing_transaction_flight_data": {
@@ -20814,10 +23350,7 @@
],
"x-stripeResource": {
"class_name": "Flight",
- "in_class": "issuing_transaction_purchase_details",
- "inner_classes": [
- "issuing_transaction_flight_data_leg"
- ]
+ "in_package": ""
}
},
"issuing_transaction_flight_data_leg": {
@@ -20872,7 +23405,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Segments",
- "in_class": "issuing_transaction_flight_data"
+ "in_package": ""
}
},
"issuing_transaction_fuel_data": {
@@ -20911,7 +23444,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fuel",
- "in_class": "issuing_transaction_purchase_details"
+ "in_package": ""
}
},
"issuing_transaction_lodging_data": {
@@ -20937,7 +23470,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Lodging",
- "in_class": "issuing_transaction_purchase_details"
+ "in_package": ""
}
},
"issuing_transaction_purchase_details": {
@@ -21002,13 +23535,7 @@
],
"x-stripeResource": {
"class_name": "PurchaseDetails",
- "in_class": "issuing.transaction",
- "inner_classes": [
- "issuing_transaction_flight_data",
- "issuing_transaction_fuel_data",
- "issuing_transaction_lodging_data",
- "issuing_transaction_receipt_data"
- ]
+ "in_package": ""
}
},
"issuing_transaction_receipt_data": {
@@ -21047,7 +23574,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Receipt",
- "in_class": "issuing_transaction_purchase_details"
+ "in_package": ""
}
},
"issuing_transaction_treasury": {
@@ -21075,7 +23602,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Treasury",
- "in_class": "issuing.transaction"
+ "in_package": ""
}
},
"item": {
@@ -21170,11 +23697,7 @@
"x-stripeResource": {
"class_name": "LineItem",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "line_items_discount_amount",
- "line_items_tax_amount"
- ]
+ "in_package": ""
}
},
"legal_entity_company": {
@@ -21264,6 +23787,7 @@
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
+ "incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
@@ -21278,7 +23802,8 @@
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
- "unincorporated_non_profit"
+ "unincorporated_non_profit",
+ "unincorporated_partnership"
],
"type": "string",
"x-stripeBypassValidation": true
@@ -21317,11 +23842,7 @@
],
"x-stripeResource": {
"class_name": "Company",
- "in_class": "account",
- "inner_classes": [
- "legal_entity_company_verification",
- "legal_entity_ubo_declaration"
- ]
+ "in_package": ""
}
},
"legal_entity_company_verification": {
@@ -21341,10 +23862,7 @@
],
"x-stripeResource": {
"class_name": "Verification",
- "in_class": "legal_entity_company",
- "inner_classes": [
- "legal_entity_company_verification_document"
- ]
+ "in_package": ""
}
},
"legal_entity_company_verification_document": {
@@ -21417,7 +23935,7 @@
],
"x-stripeResource": {
"class_name": "VerificationDocument",
- "in_class": "legal_entity_company_verification"
+ "in_package": ""
}
},
"legal_entity_dob": {
@@ -21449,7 +23967,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "person"
+ "in_package": ""
}
},
"legal_entity_japan_address": {
@@ -21512,7 +24030,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "JapanAddress",
- "in_class": "person"
+ "in_package": ""
}
},
"legal_entity_person_verification": {
@@ -21559,7 +24077,7 @@
],
"x-stripeResource": {
"class_name": "Verification",
- "in_class": "person"
+ "in_package": ""
}
},
"legal_entity_person_verification_document": {
@@ -21632,7 +24150,7 @@
],
"x-stripeResource": {
"class_name": "VerificationDocument",
- "in_class": "person"
+ "in_package": ""
}
},
"legal_entity_ubo_declaration": {
@@ -21667,7 +24185,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "OwnershipDeclaration",
- "in_class": "legal_entity_company"
+ "in_package": ""
}
},
"level3": {
@@ -21710,10 +24228,7 @@
],
"x-stripeResource": {
"class_name": "Level3",
- "in_class": "charge",
- "inner_classes": [
- "level3_line_items"
- ]
+ "in_package": ""
}
},
"level3_line_items": {
@@ -21757,18 +24272,18 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LineItem",
- "in_class": "level3"
+ "in_package": ""
}
},
"line_item": {
"description": "",
"properties": {
"amount": {
- "description": "The amount, in %s.",
+ "description": "The amount, in cents (or local equivalent).",
"type": "integer"
},
"amount_excluding_tax": {
- "description": "The integer amount in %s representing the amount for this line item, excluding all tax and discounts.",
+ "description": "The integer amount in cents (or local equivalent) representing the amount for this line item, excluding all tax and discounts.",
"nullable": true,
"type": "integer"
},
@@ -21961,7 +24476,7 @@
"type": "string"
},
"unit_amount_excluding_tax": {
- "description": "The amount in %s representing the unit amount for this line item, excluding all tax and discounts.",
+ "description": "The amount in cents (or local equivalent) representing the unit amount for this line item, excluding all tax and discounts.",
"format": "decimal",
"nullable": true,
"type": "string"
@@ -22049,7 +24564,7 @@
],
"x-stripeResource": {
"class_name": "Discount",
- "in_class": "item"
+ "in_package": ""
}
},
"line_items_tax_amount": {
@@ -22086,7 +24601,7 @@
"x-stripeBypassValidation": true
},
"taxable_amount": {
- "description": "The amount on which tax is calculated, in %s.",
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
"nullable": true,
"type": "integer"
}
@@ -22104,7 +24619,7 @@
],
"x-stripeResource": {
"class_name": "Tax",
- "in_class": "item"
+ "in_package": ""
}
},
"linked_account_options_us_bank_account": {
@@ -22123,18 +24638,33 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "Data features requested to be retrieved upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "nullable": true,
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
"type": "string"
}
},
+ "required": [
+ "prefetch"
+ ],
"title": "linked_account_options_us_bank_account",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FinancialConnections",
- "in_class": "payment_intent_payment_method_options_us_bank_account"
+ "in_package": ""
}
},
"login_link": {
@@ -22182,7 +24712,7 @@
}
},
"mandate": {
- "description": "A Mandate is a record of the permission a customer has given you to debit their payment method.",
+ "description": "A Mandate is a record of the permission that your customer gives you to debit their payment method.",
"properties": {
"customer_acceptance": {
"$ref": "#/components/schemas/customer_acceptance"
@@ -22207,7 +24737,7 @@
"type": "string"
},
"on_behalf_of": {
- "description": "The account (if any) for which the mandate is intended.",
+ "description": "The account (if any) that the mandate is intended for.",
"maxLength": 5000,
"type": "string"
},
@@ -22237,7 +24767,7 @@
"$ref": "#/components/schemas/mandate_single_use"
},
"status": {
- "description": "The status of the mandate, which indicates whether it can be used to initiate a payment.",
+ "description": "The mandate status indicates whether or not you can use it to initiate a payment.",
"enum": [
"active",
"inactive",
@@ -22285,16 +24815,23 @@
],
"x-stripeResource": {
"class_name": "Mandate",
- "in_package": "",
- "inner_classes": [
- "customer_acceptance",
- "mandate_au_becs_debit",
- "mandate_bacs_debit",
- "mandate_multi_use",
- "mandate_payment_method_details",
- "mandate_paypal",
- "mandate_single_use"
- ]
+ "in_package": ""
+ }
+ },
+ "mandate.updated": {
+ "description": "Occurs whenever a Mandate is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/mandate"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "mandate.updated"
}
},
"mandate_acss_debit": {
@@ -22345,7 +24882,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"mandate_au_becs_debit": {
@@ -22365,7 +24902,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "mandate"
+ "in_package": ""
}
},
"mandate_bacs_debit": {
@@ -22402,43 +24939,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "mandate"
- }
- },
- "mandate_blik": {
- "description": "",
- "properties": {
- "expires_after": {
- "description": "Date at which the mandate expires.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "off_session": {
- "$ref": "#/components/schemas/mandate_options_off_session_details_blik"
- },
- "type": {
- "description": "Type of the mandate.",
- "enum": [
- "off_session",
- "on_session"
- ],
- "nullable": true,
- "type": "string"
- }
- },
- "required": [
- "expires_after",
- "type"
- ],
- "title": "mandate_blik",
- "type": "object",
- "x-expandableFields": [
- "off_session"
- ],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"mandate_cashapp": {
@@ -22449,7 +24950,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"mandate_link": {
@@ -22460,7 +24961,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"mandate_multi_use": {
@@ -22471,52 +24972,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MultiUse",
- "in_class": "mandate"
- }
- },
- "mandate_options_off_session_details_blik": {
- "description": "",
- "properties": {
- "amount": {
- "description": "Amount of each recurring payment.",
- "nullable": true,
- "type": "integer"
- },
- "currency": {
- "description": "Currency of each recurring payment.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
- "interval": {
- "description": "Frequency interval of each recurring payment.",
- "enum": [
- "day",
- "month",
- "week",
- "year"
- ],
- "nullable": true,
- "type": "string"
- },
- "interval_count": {
- "description": "Frequency indicator of each recurring payment.",
- "nullable": true,
- "type": "integer"
- }
- },
- "required": [
- "amount",
- "currency",
- "interval",
- "interval_count"
- ],
- "title": "mandate_options_off_session_details_blik",
- "type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BlikMandateOptionsOffSessionDetails",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"mandate_payment_method_details": {
@@ -22531,9 +24987,6 @@
"bacs_debit": {
"$ref": "#/components/schemas/mandate_bacs_debit"
},
- "blik": {
- "$ref": "#/components/schemas/mandate_blik"
- },
"card": {
"$ref": "#/components/schemas/card_mandate_payment_method_details"
},
@@ -22550,7 +25003,7 @@
"$ref": "#/components/schemas/mandate_sepa_debit"
},
"type": {
- "description": "The type of the payment method associated with this mandate. An additional hash is included on `payment_method_details` with a name matching this value. It contains mandate information specific to the payment method.",
+ "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.",
"maxLength": 5000,
"type": "string"
},
@@ -22567,7 +25020,6 @@
"acss_debit",
"au_becs_debit",
"bacs_debit",
- "blik",
"card",
"cashapp",
"link",
@@ -22577,16 +25029,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodDetails",
- "in_class": "mandate",
- "inner_classes": [
- "card_mandate_payment_method_details",
- "mandate_acss_debit",
- "mandate_blik",
- "mandate_cashapp",
- "mandate_link",
- "mandate_sepa_debit",
- "mandate_us_bank_account"
- ]
+ "in_package": ""
}
},
"mandate_paypal": {
@@ -22613,7 +25056,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "mandate"
+ "in_package": ""
}
},
"mandate_sepa_debit": {
@@ -22639,18 +25082,18 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"mandate_single_use": {
"description": "",
"properties": {
"amount": {
- "description": "On a single use mandate, the amount of the payment.",
+ "description": "The amount of the payment on a single use mandate.",
"type": "integer"
},
"currency": {
- "description": "On a single use mandate, the currency of the payment.",
+ "description": "The currency of the payment on a single use mandate.",
"type": "string"
}
},
@@ -22663,7 +25106,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SingleUse",
- "in_class": "mandate"
+ "in_package": ""
}
},
"mandate_us_bank_account": {
@@ -22674,7 +25117,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "mandate_payment_method_details"
+ "in_package": ""
}
},
"networks": {
@@ -22704,7 +25147,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Networks",
- "in_class": "payment_method_card"
+ "in_package": ""
}
},
"notification_event_data": {
@@ -22766,20 +25209,20 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Offline",
- "in_class": "customer_acceptance"
+ "in_package": ""
}
},
"online_acceptance": {
"description": "",
"properties": {
"ip_address": {
- "description": "The IP address from which the Mandate was accepted by the customer.",
+ "description": "The customer accepts the mandate from this IP address.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
+ "description": "The customer accepts the mandate using the user agent of the browser.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -22794,7 +25237,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Online",
- "in_class": "customer_acceptance"
+ "in_package": ""
}
},
"outbound_payments_payment_method_details": {
@@ -22831,11 +25274,7 @@
],
"x-stripeResource": {
"class_name": "DestinationPaymentMethodDetails",
- "in_class": "treasury.outbound_payment",
- "inner_classes": [
- "outbound_payments_payment_method_details_financial_account",
- "outbound_payments_payment_method_details_us_bank_account"
- ]
+ "in_package": ""
}
},
"outbound_payments_payment_method_details_financial_account": {
@@ -22863,7 +25302,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FinancialAccount",
- "in_class": "outbound_payments_payment_method_details"
+ "in_package": ""
}
},
"outbound_payments_payment_method_details_us_bank_account": {
@@ -22934,7 +25373,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "outbound_payments_payment_method_details"
+ "in_package": ""
}
},
"outbound_transfers_payment_method_details": {
@@ -22967,10 +25406,7 @@
],
"x-stripeResource": {
"class_name": "DestinationPaymentMethodDetails",
- "in_class": "treasury.outbound_transfer",
- "inner_classes": [
- "outbound_transfers_payment_method_details_us_bank_account"
- ]
+ "in_package": ""
}
},
"outbound_transfers_payment_method_details_us_bank_account": {
@@ -23041,7 +25477,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "outbound_transfers_payment_method_details"
+ "in_package": ""
}
},
"package_dimensions": {
@@ -23092,10 +25528,7 @@
],
"x-stripeResource": {
"class_name": "AmountDetails",
- "in_class": "payment_intent",
- "inner_classes": [
- "payment_flows_amount_details_resource_tip"
- ]
+ "in_package": ""
}
},
"payment_flows_amount_details_resource_tip": {
@@ -23111,7 +25544,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Tip",
- "in_class": "payment_flows_amount_details"
+ "in_package": ""
}
},
"payment_flows_automatic_payment_methods_payment_intent": {
@@ -23189,7 +25622,7 @@
],
"x-stripeResource": {
"class_name": "Installments",
- "in_class": "payment_intent_type_specific_payment_method_options_client"
+ "in_package": ""
}
},
"payment_flows_private_payment_methods_alipay": {
@@ -23200,7 +25633,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Alipay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_flows_private_payment_methods_alipay_details": {
@@ -23233,7 +25666,104 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Alipay",
- "in_class": "payment_method_details"
+ "in_package": ""
+ }
+ },
+ "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": {
+ "description": "",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the capture window is extended beyond the standard authorization.",
+ "enum": [
+ "disabled",
+ "enabled"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "ExtendedAuthorizationRequest",
+ "in_package": ""
+ }
+ },
+ "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": {
+ "description": "",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not the incremental authorization feature is supported.",
+ "enum": [
+ "available",
+ "unavailable"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "IncrementalAuthorizationRequest",
+ "in_package": ""
+ }
+ },
+ "payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": {
+ "description": "",
+ "properties": {
+ "maximum_amount_capturable": {
+ "description": "The maximum amount that can be captured.",
+ "type": "integer"
+ },
+ "status": {
+ "description": "Indicates whether or not the authorized amount can be over-captured.",
+ "enum": [
+ "available",
+ "unavailable"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "maximum_amount_capturable",
+ "status"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "OvercaptureRequest",
+ "in_package": ""
+ }
+ },
+ "payment_flows_private_payment_methods_card_details_api_resource_multicapture": {
+ "description": "",
+ "properties": {
+ "status": {
+ "description": "Indicates whether or not multiple captures are supported.",
+ "enum": [
+ "available",
+ "unavailable"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "MulticaptureRequest",
+ "in_package": ""
}
},
"payment_flows_private_payment_methods_klarna_dob": {
@@ -23265,7 +25795,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DateOfBirth",
- "in_class": "payment_method_klarna"
+ "in_package": ""
}
},
"payment_intent": {
@@ -23283,7 +25813,7 @@
"$ref": "#/components/schemas/payment_flows_amount_details"
},
"amount_received": {
- "description": "Amount that was collected by this PaymentIntent.",
+ "description": "Amount that this PaymentIntent collects.",
"type": "integer"
},
"application": {
@@ -23447,7 +25977,7 @@
"$ref": "#/components/schemas/charge"
}
],
- "description": "The latest charge created by this payment intent.",
+ "description": "The latest charge created by this PaymentIntent.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -23466,7 +25996,7 @@
"maxLength": 500,
"type": "string"
},
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. For more information, see the [documentation](https://stripe.com/docs/payments/payment-intents/creating-payment-intents#storing-information-in-metadata).",
+ "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).",
"type": "object"
},
"next_action": {
@@ -23525,6 +26055,15 @@
]
}
},
+ "payment_method_configuration_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
+ }
+ ],
+ "description": "Information about the payment method configuration used for this PaymentIntent.",
+ "nullable": true
+ },
"payment_method_options": {
"anyOf": [
{
@@ -23652,11 +26191,11 @@
"$ref": "#/components/schemas/transfer_data"
}
],
- "description": "The data with which to automatically create a Transfer when the payment is finalized. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
+ "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).",
"nullable": true
},
"transfer_group": {
- "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/payments/connected-accounts) for details.",
+ "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).",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -23714,6 +26253,7 @@
"next_action",
"on_behalf_of",
"payment_method",
+ "payment_method_configuration_details",
"payment_method_options",
"processing",
"review",
@@ -23805,21 +26345,135 @@
"class_name": "PaymentIntent",
"has_collection_class": true,
"has_search_result_class": true,
- "in_package": "",
- "inner_classes": [
- "payment_flows_amount_details",
- "payment_intent_next_action",
- "payment_intent_next_action_alipay_handle_redirect",
- "payment_intent_next_action_boleto",
- "payment_intent_next_action_card_await_notification",
- "payment_intent_next_action_display_bank_transfer_instructions",
- "payment_intent_next_action_display_oxxo_details",
- "payment_intent_next_action_konbini",
- "payment_intent_next_action_redirect_to_url",
- "payment_intent_payment_method_options",
- "payment_intent_processing",
- "transfer_data"
- ]
+ "in_package": ""
+ }
+ },
+ "payment_intent.amount_capturable_updated": {
+ "description": "Occurs when a PaymentIntent has funds to be captured. Check the `amount_capturable` property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an `amount_to_capture` value up to the specified amount. [Learn more about capturing PaymentIntents.](https://stripe.com/docs/api/payment_intents/capture)",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.amount_capturable_updated"
+ }
+ },
+ "payment_intent.canceled": {
+ "description": "Occurs when a PaymentIntent is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.canceled"
+ }
+ },
+ "payment_intent.created": {
+ "description": "Occurs when a new PaymentIntent is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.created"
+ }
+ },
+ "payment_intent.partially_funded": {
+ "description": "Occurs when funds are applied to a customer_balance PaymentIntent and the 'amount_remaining' changes.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.partially_funded"
+ }
+ },
+ "payment_intent.payment_failed": {
+ "description": "Occurs when a PaymentIntent has failed the attempt to create a payment method or a payment.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.payment_failed"
+ }
+ },
+ "payment_intent.processing": {
+ "description": "Occurs when a PaymentIntent has started processing.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.processing"
+ }
+ },
+ "payment_intent.requires_action": {
+ "description": "Occurs when a PaymentIntent transitions to requires_action state",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.requires_action"
+ }
+ },
+ "payment_intent.succeeded": {
+ "description": "Occurs when a PaymentIntent has successfully completed payment.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_intent.succeeded"
}
},
"payment_intent_card_processing": {
@@ -23836,10 +26490,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "payment_intent_processing",
- "inner_classes": [
- "payment_intent_processing_customer_notification"
- ]
+ "in_package": ""
}
},
"payment_intent_next_action": {
@@ -23924,18 +26575,7 @@
],
"x-stripeResource": {
"class_name": "NextAction",
- "in_class": "payment_intent",
- "inner_classes": [
- "payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code",
- "payment_intent_next_action_cashapp_qr_code",
- "payment_intent_next_action_paynow_display_qr_code",
- "payment_intent_next_action_pix_display_qr_code",
- "payment_intent_next_action_promptpay_display_qr_code",
- "payment_intent_next_action_verify_with_microdeposits",
- "payment_intent_next_action_wechat_pay_display_qr_code",
- "payment_intent_next_action_wechat_pay_redirect_to_android_app",
- "payment_intent_next_action_wechat_pay_redirect_to_ios_app"
- ]
+ "in_package": ""
}
},
"payment_intent_next_action_alipay_handle_redirect": {
@@ -23977,7 +26617,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionAlipayHandleRedirect",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_boleto": {
@@ -24019,7 +26659,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionDisplayBoletoDetails",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_card_await_notification": {
@@ -24046,7 +26686,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionCardAwaitNotification",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_cashapp_handle_redirect_or_display_qr_code": {
@@ -24078,7 +26718,7 @@
],
"x-stripeResource": {
"class_name": "CashappHandleRedirectOrDisplayQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_cashapp_qr_code": {
@@ -24110,7 +26750,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CashappQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_display_bank_transfer_instructions": {
@@ -24172,7 +26812,7 @@
],
"x-stripeResource": {
"class_name": "NextActionDisplayBankTransferInstructions",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_display_oxxo_details": {
@@ -24207,7 +26847,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionOxxoDisplayDetails",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_konbini": {
@@ -24240,10 +26880,7 @@
],
"x-stripeResource": {
"class_name": "NextActionKonbiniDisplayDetails",
- "in_class": "payment_intent",
- "inner_classes": [
- "payment_intent_next_action_konbini_stores"
- ]
+ "in_package": ""
}
},
"payment_intent_next_action_konbini_familymart": {
@@ -24268,7 +26905,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Familymart",
- "in_class": "payment_intent_next_action_konbini_stores"
+ "in_package": ""
}
},
"payment_intent_next_action_konbini_lawson": {
@@ -24293,7 +26930,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Lawson",
- "in_class": "payment_intent_next_action_konbini_stores"
+ "in_package": ""
}
},
"payment_intent_next_action_konbini_ministop": {
@@ -24318,7 +26955,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Ministop",
- "in_class": "payment_intent_next_action_konbini_stores"
+ "in_package": ""
}
},
"payment_intent_next_action_konbini_seicomart": {
@@ -24343,7 +26980,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Seicomart",
- "in_class": "payment_intent_next_action_konbini_stores"
+ "in_package": ""
}
},
"payment_intent_next_action_konbini_stores": {
@@ -24402,13 +27039,7 @@
],
"x-stripeResource": {
"class_name": "Stores",
- "in_class": "payment_intent_next_action_konbini",
- "inner_classes": [
- "payment_intent_next_action_konbini_familymart",
- "payment_intent_next_action_konbini_lawson",
- "payment_intent_next_action_konbini_ministop",
- "payment_intent_next_action_konbini_seicomart"
- ]
+ "in_package": ""
}
},
"payment_intent_next_action_paynow_display_qr_code": {
@@ -24447,7 +27078,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PaynowDisplayQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_pix_display_qr_code": {
@@ -24483,7 +27114,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PixDisplayQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_promptpay_display_qr_code": {
@@ -24521,7 +27152,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PromptpayDisplayQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_redirect_to_url": {
@@ -24549,7 +27180,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionRedirectToUrl",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"payment_intent_next_action_verify_with_microdeposits": {
@@ -24585,7 +27216,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "VerifyWithMicrodeposits",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_wechat_pay_display_qr_code": {
@@ -24629,7 +27260,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPayDisplayQrCode",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_wechat_pay_redirect_to_android_app": {
@@ -24685,7 +27316,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPayRedirectToAndroidApp",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_next_action_wechat_pay_redirect_to_ios_app": {
@@ -24705,7 +27336,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPayRedirectToIosApp",
- "in_class": "payment_intent_next_action"
+ "in_package": ""
}
},
"payment_intent_payment_method_options": {
@@ -24850,45 +27481,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodOptions",
- "in_class": "payment_intent",
- "inner_classes": [
- "mandate_options_off_session_details_blik",
- "payment_intent_payment_method_options_acss_debit",
- "payment_intent_payment_method_options_au_becs_debit",
- "payment_intent_payment_method_options_blik",
- "payment_intent_payment_method_options_card",
- "payment_intent_payment_method_options_eps",
- "payment_intent_payment_method_options_link",
- "payment_intent_payment_method_options_mandate_options_sepa_debit",
- "payment_intent_payment_method_options_sepa_debit",
- "payment_intent_payment_method_options_us_bank_account",
- "payment_method_options_affirm",
- "payment_method_options_afterpay_clearpay",
- "payment_method_options_alipay",
- "payment_method_options_bacs_debit",
- "payment_method_options_bancontact",
- "payment_method_options_boleto",
- "payment_method_options_card_present",
- "payment_method_options_cashapp",
- "payment_method_options_customer_balance",
- "payment_method_options_customer_balance_bank_transfer",
- "payment_method_options_fpx",
- "payment_method_options_giropay",
- "payment_method_options_grabpay",
- "payment_method_options_ideal",
- "payment_method_options_interac_present",
- "payment_method_options_klarna",
- "payment_method_options_konbini",
- "payment_method_options_oxxo",
- "payment_method_options_p24",
- "payment_method_options_paynow",
- "payment_method_options_paypal",
- "payment_method_options_pix",
- "payment_method_options_promptpay",
- "payment_method_options_sofort",
- "payment_method_options_wechat_pay",
- "payment_method_options_zip"
- ]
+ "in_package": ""
}
},
"payment_intent_payment_method_options_acss_debit": {
@@ -24924,10 +27517,7 @@
],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "payment_intent_payment_method_options",
- "inner_classes": [
- "payment_intent_payment_method_options_mandate_options_acss_debit"
- ]
+ "in_package": ""
}
},
"payment_intent_payment_method_options_au_becs_debit": {
@@ -24948,7 +27538,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_blik": {
@@ -24959,7 +27549,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Blik",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_card": {
@@ -25008,6 +27598,38 @@
"nullable": true,
"type": "string"
},
+ "request_extended_authorization": {
+ "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_multicapture": {
+ "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_overcapture": {
+ "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_three_d_secure": {
"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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
@@ -25052,11 +27674,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "payment_intent_payment_method_options",
- "inner_classes": [
- "payment_method_options_card_installments",
- "payment_method_options_card_mandate_options"
- ]
+ "in_package": ""
}
},
"payment_intent_payment_method_options_eps": {
@@ -25075,7 +27693,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Eps",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_link": {
@@ -25089,7 +27707,7 @@
"type": "string"
},
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -25111,7 +27729,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_mandate_options_acss_debit": {
@@ -25158,7 +27776,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "payment_intent_payment_method_options_acss_debit"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_mandate_options_sepa_debit": {
@@ -25169,7 +27787,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebitMandateOptions",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_sepa_debit": {
@@ -25195,7 +27813,7 @@
],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_intent_payment_method_options_us_bank_account": {
@@ -25204,6 +27822,14 @@
"financial_connections": {
"$ref": "#/components/schemas/linked_account_options_us_bank_account"
},
+ "preferred_settlement_speed": {
+ "description": "Preferred transaction settlement speed",
+ "enum": [
+ "fastest",
+ "standard"
+ ],
+ "type": "string"
+ },
"setup_future_usage": {
"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).",
"enum": [
@@ -25231,10 +27857,7 @@
],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "payment_intent_payment_method_options",
- "inner_classes": [
- "linked_account_options_us_bank_account"
- ]
+ "in_package": ""
}
},
"payment_intent_processing": {
@@ -25261,10 +27884,7 @@
],
"x-stripeResource": {
"class_name": "Processing",
- "in_class": "payment_intent",
- "inner_classes": [
- "payment_intent_card_processing"
- ]
+ "in_package": ""
}
},
"payment_intent_processing_customer_notification": {
@@ -25291,7 +27911,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomerNotification",
- "in_class": "payment_intent_card_processing"
+ "in_package": ""
}
},
"payment_intent_type_specific_payment_method_options_client": {
@@ -25335,10 +27955,7 @@
],
"x-stripeResource": {
"class_name": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
- "in_package": "",
- "inner_classes": [
- "payment_flows_installment_options"
- ]
+ "in_package": ""
}
},
"payment_link": {
@@ -25355,13 +27972,39 @@
"description": "Whether user redeemable promotion codes are enabled.",
"type": "boolean"
},
+ "application": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/application"
+ },
+ {
+ "$ref": "#/components/schemas/deleted_application"
+ }
+ ],
+ "description": "The ID of the Connect application that created the Payment Link.",
+ "nullable": true,
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/application"
+ },
+ {
+ "$ref": "#/components/schemas/deleted_application"
+ }
+ ]
+ }
+ },
"application_fee_amount": {
"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.",
"nullable": true,
"type": "integer"
},
"application_fee_percent": {
- "description": "This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.",
+ "description": "This represents the percentage of the subscription invoice total that will be transferred to the application owner's Stripe account.",
"nullable": true,
"type": "number"
},
@@ -25615,6 +28258,7 @@
"active",
"after_completion",
"allow_promotion_codes",
+ "application",
"application_fee_amount",
"application_fee_percent",
"automatic_tax",
@@ -25646,6 +28290,7 @@
"type": "object",
"x-expandableFields": [
"after_completion",
+ "application",
"automatic_tax",
"consent_collection",
"custom_fields",
@@ -25702,23 +28347,39 @@
"x-stripeResource": {
"class_name": "PaymentLink",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "payment_links_resource_after_completion",
- "payment_links_resource_automatic_tax",
- "payment_links_resource_consent_collection",
- "payment_links_resource_custom_fields",
- "payment_links_resource_custom_text",
- "payment_links_resource_invoice_creation",
- "payment_links_resource_invoice_settings",
- "payment_links_resource_payment_intent_data",
- "payment_links_resource_phone_number_collection",
- "payment_links_resource_shipping_address_collection",
- "payment_links_resource_shipping_option",
- "payment_links_resource_subscription_data",
- "payment_links_resource_tax_id_collection",
- "payment_links_resource_transfer_data"
- ]
+ "in_package": ""
+ }
+ },
+ "payment_link.created": {
+ "description": "Occurs when a payment link is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_link"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_link.created"
+ }
+ },
+ "payment_link.updated": {
+ "description": "Occurs when a payment link is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_link"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_link.updated"
}
},
"payment_links_resource_after_completion": {
@@ -25750,11 +28411,7 @@
],
"x-stripeResource": {
"class_name": "AfterCompletion",
- "in_class": "payment_link",
- "inner_classes": [
- "payment_links_resource_completion_behavior_confirmation_page",
- "payment_links_resource_completion_behavior_redirect"
- ]
+ "in_package": ""
}
},
"payment_links_resource_automatic_tax": {
@@ -25773,7 +28430,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_completion_behavior_confirmation_page": {
@@ -25794,7 +28451,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "HostedConfirmation",
- "in_class": "payment_links_resource_after_completion"
+ "in_package": ""
}
},
"payment_links_resource_completion_behavior_redirect": {
@@ -25814,7 +28471,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Redirect",
- "in_class": "payment_links_resource_after_completion"
+ "in_package": ""
}
},
"payment_links_resource_consent_collection": {
@@ -25848,20 +28505,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ConsentCollection",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_custom_fields": {
"description": "",
"properties": {
"dropdown": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown"
- }
- ],
- "description": "Configuration for `type=dropdown` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_links_resource_custom_fields_dropdown"
},
"key": {
"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.",
@@ -25872,26 +28523,14 @@
"$ref": "#/components/schemas/payment_links_resource_custom_fields_label"
},
"numeric": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric"
- }
- ],
- "description": "Configuration for `type=numeric` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_links_resource_custom_fields_numeric"
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
"type": "boolean"
},
"text": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_links_resource_custom_fields_text"
- }
- ],
- "description": "Configuration for `type=text` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_links_resource_custom_fields_text"
},
"type": {
"description": "The type of the field.",
@@ -25904,12 +28543,9 @@
}
},
"required": [
- "dropdown",
"key",
"label",
- "numeric",
"optional",
- "text",
"type"
],
"title": "PaymentLinksResourceCustomFields",
@@ -25922,13 +28558,7 @@
],
"x-stripeResource": {
"class_name": "CustomField",
- "in_class": "payment_link",
- "inner_classes": [
- "payment_links_resource_custom_fields_dropdown",
- "payment_links_resource_custom_fields_label",
- "payment_links_resource_custom_fields_numeric",
- "payment_links_resource_custom_fields_text"
- ]
+ "in_package": ""
}
},
"payment_links_resource_custom_fields_dropdown": {
@@ -25952,10 +28582,7 @@
],
"x-stripeResource": {
"class_name": "CustomFieldDropdown",
- "in_class": "payment_links_resource_custom_fields",
- "inner_classes": [
- "payment_links_resource_custom_fields_dropdown_option"
- ]
+ "in_package": ""
}
},
"payment_links_resource_custom_fields_dropdown_option": {
@@ -25981,7 +28608,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldDropdownOption",
- "in_class": "payment_links_resource_custom_fields_dropdown"
+ "in_package": ""
}
},
"payment_links_resource_custom_fields_label": {
@@ -26010,7 +28637,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldLabel",
- "in_class": "payment_links_resource_custom_fields"
+ "in_package": ""
}
},
"payment_links_resource_custom_fields_numeric": {
@@ -26036,7 +28663,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldNumeric",
- "in_class": "payment_links_resource_custom_fields"
+ "in_package": ""
}
},
"payment_links_resource_custom_fields_text": {
@@ -26062,7 +28689,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldText",
- "in_class": "payment_links_resource_custom_fields"
+ "in_package": ""
}
},
"payment_links_resource_custom_text": {
@@ -26085,31 +28712,39 @@
],
"description": "Custom text that should be displayed alongside the payment confirmation button.",
"nullable": true
+ },
+ "terms_of_service_acceptance": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
+ }
+ ],
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
+ "nullable": true
}
},
"required": [
"shipping_address",
- "submit"
+ "submit",
+ "terms_of_service_acceptance"
],
"title": "PaymentLinksResourceCustomText",
"type": "object",
"x-expandableFields": [
"shipping_address",
- "submit"
+ "submit",
+ "terms_of_service_acceptance"
],
"x-stripeResource": {
"class_name": "CustomText",
- "in_class": "payment_link",
- "inner_classes": [
- "payment_links_resource_custom_text_position"
- ]
+ "in_package": ""
}
},
"payment_links_resource_custom_text_position": {
"description": "",
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
+ "description": "Text may be up to 1200 characters in length.",
"maxLength": 500,
"type": "string"
}
@@ -26122,7 +28757,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Position",
- "in_class": "payment_links_resource_custom_text"
+ "in_package": ""
}
},
"payment_links_resource_invoice_creation": {
@@ -26153,7 +28788,7 @@
],
"x-stripeResource": {
"class_name": "InvoiceCreation",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_invoice_settings": {
@@ -26244,7 +28879,7 @@
],
"x-stripeResource": {
"class_name": "InvoiceSettings",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_payment_intent_data": {
@@ -26260,6 +28895,14 @@
"nullable": true,
"type": "string"
},
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "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.",
+ "type": "object"
+ },
"setup_future_usage": {
"description": "Indicates that you intend to make future payments with the payment method collected during checkout.",
"enum": [
@@ -26268,18 +28911,33 @@
],
"nullable": true,
"type": "string"
+ },
+ "statement_descriptor": {
+ "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "statement_descriptor_suffix": {
+ "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.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
"capture_method",
- "setup_future_usage"
+ "metadata",
+ "setup_future_usage",
+ "statement_descriptor",
+ "statement_descriptor_suffix"
],
"title": "PaymentLinksResourcePaymentIntentData",
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PaymentIntentData",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_phone_number_collection": {
@@ -26298,7 +28956,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PhoneNumberCollection",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_shipping_address_collection": {
@@ -26559,7 +29217,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ShippingAddressCollection",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_shipping_option": {
@@ -26600,7 +29258,7 @@
],
"x-stripeResource": {
"class_name": "ShippingOption",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_subscription_data": {
@@ -26612,6 +29270,14 @@
"nullable": true,
"type": "string"
},
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "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.",
+ "type": "object"
+ },
"trial_period_days": {
"description": "Integer representing the number of trial period days before the customer is charged for the first time.",
"nullable": true,
@@ -26620,6 +29286,7 @@
},
"required": [
"description",
+ "metadata",
"trial_period_days"
],
"title": "PaymentLinksResourceSubscriptionData",
@@ -26627,7 +29294,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SubscriptionData",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_tax_id_collection": {
@@ -26646,14 +29313,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TaxIdCollection",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_links_resource_transfer_data": {
"description": "",
"properties": {
"amount": {
- "description": "The amount in %s that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"nullable": true,
"type": "integer"
},
@@ -26688,7 +29355,7 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "payment_link"
+ "in_package": ""
}
},
"payment_method": {
@@ -26988,43 +29655,71 @@
"x-stripeResource": {
"class_name": "PaymentMethod",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "billing_details",
- "payment_flows_private_payment_methods_alipay",
- "payment_method_acss_debit",
- "payment_method_affirm",
- "payment_method_afterpay_clearpay",
- "payment_method_au_becs_debit",
- "payment_method_bacs_debit",
- "payment_method_bancontact",
- "payment_method_blik",
- "payment_method_boleto",
- "payment_method_card",
- "payment_method_card_present",
- "payment_method_cashapp",
- "payment_method_customer_balance",
- "payment_method_eps",
- "payment_method_fpx",
- "payment_method_giropay",
- "payment_method_grabpay",
- "payment_method_ideal",
- "payment_method_interac_present",
- "payment_method_klarna",
- "payment_method_konbini",
- "payment_method_link",
- "payment_method_oxxo",
- "payment_method_p24",
- "payment_method_paynow",
- "payment_method_paypal",
- "payment_method_pix",
- "payment_method_promptpay",
- "payment_method_sepa_debit",
- "payment_method_sofort",
- "payment_method_us_bank_account",
- "payment_method_wechat_pay",
- "payment_method_zip"
- ]
+ "in_package": ""
+ }
+ },
+ "payment_method.attached": {
+ "description": "Occurs whenever a new payment method is attached to a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_method.attached"
+ }
+ },
+ "payment_method.automatically_updated": {
+ "description": "Occurs whenever a payment method's details are automatically updated by the network.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_method.automatically_updated"
+ }
+ },
+ "payment_method.detached": {
+ "description": "Occurs whenever a payment method is detached from a customer.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_method.detached"
+ }
+ },
+ "payment_method.updated": {
+ "description": "Occurs whenever a payment method is updated via the [PaymentMethod update API](https://stripe.com/docs/api/payment_methods/update).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payment_method"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payment_method.updated"
}
},
"payment_method_acss_debit": {
@@ -27073,7 +29768,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_affirm": {
@@ -27084,7 +29779,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Affirm",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_afterpay_clearpay": {
@@ -27095,7 +29790,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AfterpayClearpay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_au_becs_debit": {
@@ -27130,7 +29825,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_bacs_debit": {
@@ -27165,7 +29860,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_bancontact": {
@@ -27176,7 +29871,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_blik": {
@@ -27187,7 +29882,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Blik",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_boleto": {
@@ -27207,7 +29902,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Boleto",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_card": {
@@ -27248,7 +29943,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -27325,13 +30020,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "payment_method",
- "inner_classes": [
- "networks",
- "payment_method_card_checks",
- "payment_method_card_wallet",
- "three_d_secure_usage"
- ]
+ "in_package": ""
}
},
"payment_method_card_checks": {
@@ -27366,7 +30055,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Checks",
- "in_class": "payment_method_card"
+ "in_package": ""
}
},
"payment_method_card_present": {
@@ -27405,7 +30094,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -27475,10 +30164,7 @@
],
"x-stripeResource": {
"class_name": "CardPresent",
- "in_class": "payment_method",
- "inner_classes": [
- "payment_method_card_present_networks"
- ]
+ "in_package": ""
}
},
"payment_method_card_present_networks": {
@@ -27508,7 +30194,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Networks",
- "in_class": "payment_method_card_present"
+ "in_package": ""
}
},
"payment_method_card_wallet": {
@@ -27572,16 +30258,7 @@
],
"x-stripeResource": {
"class_name": "Wallet",
- "in_class": "payment_method_card",
- "inner_classes": [
- "payment_method_card_wallet_amex_express_checkout",
- "payment_method_card_wallet_apple_pay",
- "payment_method_card_wallet_google_pay",
- "payment_method_card_wallet_link",
- "payment_method_card_wallet_masterpass",
- "payment_method_card_wallet_samsung_pay",
- "payment_method_card_wallet_visa_checkout"
- ]
+ "in_package": ""
}
},
"payment_method_card_wallet_amex_express_checkout": {
@@ -27592,7 +30269,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AmexExpressCheckout",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_apple_pay": {
@@ -27603,7 +30280,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ApplePay",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_google_pay": {
@@ -27614,7 +30291,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GooglePay",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_link": {
@@ -27625,7 +30302,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_masterpass": {
@@ -27676,7 +30353,7 @@
],
"x-stripeResource": {
"class_name": "Masterpass",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_samsung_pay": {
@@ -27687,7 +30364,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SamsungPay",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_card_wallet_visa_checkout": {
@@ -27738,7 +30415,7 @@
],
"x-stripeResource": {
"class_name": "VisaCheckout",
- "in_class": "payment_method_card_wallet"
+ "in_package": ""
}
},
"payment_method_cashapp": {
@@ -27766,7 +30443,342 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "payment_method"
+ "in_package": ""
+ }
+ },
+ "payment_method_config_biz_payment_method_configuration_details": {
+ "description": "",
+ "properties": {
+ "id": {
+ "description": "ID of the payment method configuration used.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "parent": {
+ "description": "ID of the parent payment method configuration used.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "parent"
+ ],
+ "title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodConfigurationDetails",
+ "in_package": ""
+ }
+ },
+ "payment_method_config_resource_display_preference": {
+ "description": "",
+ "properties": {
+ "overridable": {
+ "description": "For child configs, whether or not the account's preference will be observed. If `false`, the parent configuration's default is used.",
+ "nullable": true,
+ "type": "boolean"
+ },
+ "preference": {
+ "description": "The account's display preference.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ },
+ "value": {
+ "description": "The effective display preference value.",
+ "enum": [
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "overridable",
+ "preference",
+ "value"
+ ],
+ "title": "PaymentMethodConfigResourceDisplayPreference",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "DisplayPreference",
+ "in_package": ""
+ }
+ },
+ "payment_method_config_resource_payment_method_properties": {
+ "description": "",
+ "properties": {
+ "available": {
+ "description": "Whether this payment method may be offered at checkout. True if `display_preference` is `on` and the payment method's capability is active.",
+ "type": "boolean"
+ },
+ "display_preference": {
+ "$ref": "#/components/schemas/payment_method_config_resource_display_preference"
+ }
+ },
+ "required": [
+ "available",
+ "display_preference"
+ ],
+ "title": "PaymentMethodConfigResourcePaymentMethodProperties",
+ "type": "object",
+ "x-expandableFields": [
+ "display_preference"
+ ],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodProperties",
+ "in_package": ""
+ }
+ },
+ "payment_method_configuration": {
+ "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)",
+ "properties": {
+ "acss_debit": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "active": {
+ "description": "Whether the configuration can be used for new payments.",
+ "type": "boolean"
+ },
+ "affirm": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "afterpay_clearpay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "alipay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "apple_pay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "application": {
+ "description": "For child configs, the Connect application associated with the configuration.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "au_becs_debit": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "bacs_debit": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "bancontact": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "blik": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "boleto": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "card": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "cartes_bancaires": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "cashapp": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "eps": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "fpx": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "giropay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "google_pay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "grabpay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "id_bank_transfer": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "ideal": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "is_default": {
+ "description": "The default configuration is used whenever a payment method configuration is not specified.",
+ "type": "boolean"
+ },
+ "jcb": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "klarna": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "konbini": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "link": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "multibanco": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "name": {
+ "description": "The configuration's name.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "netbanking": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "payment_method_configuration"
+ ],
+ "type": "string"
+ },
+ "oxxo": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "p24": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "parent": {
+ "description": "For child configs, the configuration's parent configuration.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "pay_by_bank": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "paynow": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "paypal": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "promptpay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "sepa_debit": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "sofort": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "upi": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "us_bank_account": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ },
+ "wechat_pay": {
+ "$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
+ }
+ },
+ "required": [
+ "active",
+ "application",
+ "id",
+ "is_default",
+ "livemode",
+ "name",
+ "object",
+ "parent"
+ ],
+ "title": "PaymentMethodConfigResourcePaymentMethodConfiguration",
+ "type": "object",
+ "x-expandableFields": [
+ "acss_debit",
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "apple_pay",
+ "au_becs_debit",
+ "bacs_debit",
+ "bancontact",
+ "blik",
+ "boleto",
+ "card",
+ "cartes_bancaires",
+ "cashapp",
+ "eps",
+ "fpx",
+ "giropay",
+ "google_pay",
+ "grabpay",
+ "id_bank_transfer",
+ "ideal",
+ "jcb",
+ "klarna",
+ "konbini",
+ "link",
+ "multibanco",
+ "netbanking",
+ "oxxo",
+ "p24",
+ "pay_by_bank",
+ "paynow",
+ "paypal",
+ "promptpay",
+ "sepa_debit",
+ "sofort",
+ "upi",
+ "us_bank_account",
+ "wechat_pay"
+ ],
+ "x-resourceId": "payment_method_configuration",
+ "x-stripeOperations": [
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/payment_method_configurations"
+ },
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/payment_method_configurations/{configuration}"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/payment_method_configurations/{configuration}"
+ },
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/payment_method_configurations"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodConfiguration",
+ "has_collection_class": true,
+ "in_package": ""
}
},
"payment_method_customer_balance": {
@@ -27777,7 +30789,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomerBalance",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_details": {
@@ -27954,49 +30966,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodDetails",
- "in_class": "charge",
- "inner_classes": [
- "payment_flows_private_payment_methods_alipay_details",
- "payment_method_details_ach_credit_transfer",
- "payment_method_details_ach_debit",
- "payment_method_details_acss_debit",
- "payment_method_details_affirm",
- "payment_method_details_afterpay_clearpay",
- "payment_method_details_au_becs_debit",
- "payment_method_details_bacs_debit",
- "payment_method_details_bancontact",
- "payment_method_details_blik",
- "payment_method_details_boleto",
- "payment_method_details_card",
- "payment_method_details_card_present",
- "payment_method_details_cashapp",
- "payment_method_details_customer_balance",
- "payment_method_details_eps",
- "payment_method_details_fpx",
- "payment_method_details_giropay",
- "payment_method_details_grabpay",
- "payment_method_details_ideal",
- "payment_method_details_interac_present",
- "payment_method_details_klarna",
- "payment_method_details_konbini",
- "payment_method_details_konbini_store",
- "payment_method_details_link",
- "payment_method_details_multibanco",
- "payment_method_details_oxxo",
- "payment_method_details_p24",
- "payment_method_details_paynow",
- "payment_method_details_paypal",
- "payment_method_details_pix",
- "payment_method_details_promptpay",
- "payment_method_details_sepa_credit_transfer",
- "payment_method_details_sepa_debit",
- "payment_method_details_sofort",
- "payment_method_details_stripe_account",
- "payment_method_details_us_bank_account",
- "payment_method_details_wechat",
- "payment_method_details_wechat_pay",
- "payment_method_details_zip"
- ]
+ "in_package": ""
}
},
"payment_method_details_ach_credit_transfer": {
@@ -28038,7 +31008,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AchCreditTransfer",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_ach_debit": {
@@ -28097,7 +31067,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AchDebit",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_acss_debit": {
@@ -28151,7 +31121,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_affirm": {
@@ -28162,7 +31132,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Affirm",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_afterpay_clearpay": {
@@ -28190,7 +31160,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AfterpayClearpay",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_au_becs_debit": {
@@ -28230,7 +31200,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_bacs_debit": {
@@ -28272,7 +31242,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_bancontact": {
@@ -28378,7 +31348,7 @@
],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_blik": {
@@ -28389,7 +31359,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Blik",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_boleto": {
@@ -28409,12 +31379,17 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Boleto",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_card": {
"description": "",
"properties": {
+ "amount_authorized": {
+ "description": "The authorized amount.",
+ "nullable": true,
+ "type": "integer"
+ },
"brand": {
"description": "Card brand. Can be `amex`, `diners`, `discover`, `eftpos_au`, `jcb`, `mastercard`, `unionpay`, `visa`, or `unknown`.",
"maxLength": 5000,
@@ -28450,8 +31425,11 @@
"description": "Four-digit number representing the card's expiration year.",
"type": "integer"
},
+ "extended_authorization": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization"
+ },
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -28468,6 +31446,9 @@
"nullable": true,
"type": "string"
},
+ "incremental_authorization": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization"
+ },
"installments": {
"anyOf": [
{
@@ -28500,6 +31481,9 @@
"nullable": true,
"type": "boolean"
},
+ "multicapture": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_multicapture"
+ },
"network": {
"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`.",
"maxLength": 5000,
@@ -28515,10 +31499,13 @@
"description": "If this card has network token credentials, this contains the details of the network token credentials.",
"nullable": true
},
+ "overcapture": {
+ "$ref": "#/components/schemas/payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture"
+ },
"three_d_secure": {
"anyOf": [
{
- "$ref": "#/components/schemas/three_d_secure_details"
+ "$ref": "#/components/schemas/three_d_secure_details_charge"
}
],
"description": "Populated if this transaction used 3D Secure authentication.",
@@ -28552,21 +31539,18 @@
"type": "object",
"x-expandableFields": [
"checks",
+ "extended_authorization",
+ "incremental_authorization",
"installments",
+ "multicapture",
"network_token",
+ "overcapture",
"three_d_secure",
"wallet"
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "payment_method_details",
- "inner_classes": [
- "payment_method_details_card_checks",
- "payment_method_details_card_installments",
- "payment_method_details_card_network_token",
- "payment_method_details_card_wallet",
- "three_d_secure_details"
- ]
+ "in_package": ""
}
},
"payment_method_details_card_checks": {
@@ -28601,7 +31585,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Checks",
- "in_class": "payment_method_details_card"
+ "in_package": ""
}
},
"payment_method_details_card_installments": {
@@ -28627,7 +31611,7 @@
],
"x-stripeResource": {
"class_name": "Installments",
- "in_class": "payment_method_details_card"
+ "in_package": ""
}
},
"payment_method_details_card_installments_plan": {
@@ -28664,7 +31648,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Plan",
- "in_class": "payment_method_options_card_installments"
+ "in_package": ""
}
},
"payment_method_details_card_network_token": {
@@ -28683,7 +31667,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NetworkToken",
- "in_class": "payment_method_details_card"
+ "in_package": ""
}
},
"payment_method_details_card_present": {
@@ -28738,7 +31722,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -28834,10 +31818,7 @@
],
"x-stripeResource": {
"class_name": "CardPresent",
- "in_class": "payment_method_details",
- "inner_classes": [
- "payment_method_details_card_present_receipt"
- ]
+ "in_package": ""
}
},
"payment_method_details_card_present_receipt": {
@@ -28918,7 +31899,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Receipt",
- "in_class": "payment_method_details_card_present"
+ "in_package": ""
}
},
"payment_method_details_card_wallet": {
@@ -28982,16 +31963,7 @@
],
"x-stripeResource": {
"class_name": "Wallet",
- "in_class": "payment_method_details_card",
- "inner_classes": [
- "payment_method_details_card_wallet_amex_express_checkout",
- "payment_method_details_card_wallet_apple_pay",
- "payment_method_details_card_wallet_google_pay",
- "payment_method_details_card_wallet_link",
- "payment_method_details_card_wallet_masterpass",
- "payment_method_details_card_wallet_samsung_pay",
- "payment_method_details_card_wallet_visa_checkout"
- ]
+ "in_package": ""
}
},
"payment_method_details_card_wallet_amex_express_checkout": {
@@ -29002,7 +31974,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AmexExpressCheckout",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_apple_pay": {
@@ -29013,7 +31985,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ApplePay",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_google_pay": {
@@ -29024,7 +31996,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GooglePay",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_link": {
@@ -29035,7 +32007,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_masterpass": {
@@ -29086,7 +32058,7 @@
],
"x-stripeResource": {
"class_name": "Masterpass",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_samsung_pay": {
@@ -29097,7 +32069,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SamsungPay",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_card_wallet_visa_checkout": {
@@ -29148,7 +32120,7 @@
],
"x-stripeResource": {
"class_name": "VisaCheckout",
- "in_class": "payment_method_details_card_wallet"
+ "in_package": ""
}
},
"payment_method_details_cashapp": {
@@ -29176,7 +32148,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_customer_balance": {
@@ -29187,7 +32159,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomerBalance",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_eps": {
@@ -29244,7 +32216,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Eps",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_fpx": {
@@ -29304,7 +32276,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fpx",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_giropay": {
@@ -29346,7 +32318,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Giropay",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_grabpay": {
@@ -29367,14 +32339,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Grabpay",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_ideal": {
"description": "",
"properties": {
"bank": {
- "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
+ "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
"enum": [
"abn_amro",
"asn_bank",
@@ -29383,6 +32355,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -29406,6 +32379,7 @@
"INGBNL2A",
"KNABNL2H",
"MOYONL21",
+ "NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
@@ -29485,7 +32459,7 @@
],
"x-stripeResource": {
"class_name": "Ideal",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_interac_present": {
@@ -29530,7 +32504,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -29625,10 +32599,7 @@
],
"x-stripeResource": {
"class_name": "InteracPresent",
- "in_class": "payment_method_details",
- "inner_classes": [
- "payment_method_details_interac_present_receipt"
- ]
+ "in_package": ""
}
},
"payment_method_details_interac_present_receipt": {
@@ -29708,7 +32679,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Receipt",
- "in_class": "payment_method_details_interac_present"
+ "in_package": ""
}
},
"payment_method_details_klarna": {
@@ -29736,7 +32707,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Klarna",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_konbini": {
@@ -29762,7 +32733,7 @@
],
"x-stripeResource": {
"class_name": "Konbini",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_konbini_store": {
@@ -29788,7 +32759,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Store",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_link": {
@@ -29809,7 +32780,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_multibanco": {
@@ -29837,7 +32808,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Multibanco",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_oxxo": {
@@ -29858,7 +32829,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Oxxo",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_p24": {
@@ -29919,7 +32890,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "P24",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_paynow": {
@@ -29940,7 +32911,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paynow",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_paypal": {
@@ -29987,7 +32958,7 @@
],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_pix": {
@@ -30005,7 +32976,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Pix",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_promptpay": {
@@ -30026,7 +32997,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Promptpay",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_sepa_credit_transfer": {
@@ -30061,7 +33032,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaCreditTransfer",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_sepa_debit": {
@@ -30117,7 +33088,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_sofort": {
@@ -30233,7 +33204,7 @@
],
"x-stripeResource": {
"class_name": "Sofort",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_stripe_account": {
@@ -30244,7 +33215,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StripeAccount",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_us_bank_account": {
@@ -30306,7 +33277,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_wechat": {
@@ -30317,7 +33288,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Wechat",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_wechat_pay": {
@@ -30345,7 +33316,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPay",
- "in_class": "payment_method_details"
+ "in_package": ""
}
},
"payment_method_details_zip": {
@@ -30356,7 +33327,165 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Zip",
- "in_class": "payment_method_details"
+ "in_package": ""
+ }
+ },
+ "payment_method_domain": {
+ "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).",
+ "properties": {
+ "apple_pay": {
+ "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
+ },
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "domain_name": {
+ "description": "The domain name that this payment method domain object represents.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "enabled": {
+ "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.",
+ "type": "boolean"
+ },
+ "google_pay": {
+ "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "link": {
+ "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "payment_method_domain"
+ ],
+ "type": "string"
+ },
+ "paypal": {
+ "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status"
+ }
+ },
+ "required": [
+ "apple_pay",
+ "created",
+ "domain_name",
+ "enabled",
+ "google_pay",
+ "id",
+ "link",
+ "livemode",
+ "object",
+ "paypal"
+ ],
+ "title": "PaymentMethodDomainResourcePaymentMethodDomain",
+ "type": "object",
+ "x-expandableFields": [
+ "apple_pay",
+ "google_pay",
+ "link",
+ "paypal"
+ ],
+ "x-resourceId": "payment_method_domain",
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/payment_method_domains/{payment_method_domain}"
+ },
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/payment_method_domains"
+ },
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/payment_method_domains"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/payment_method_domains/{payment_method_domain}"
+ },
+ {
+ "method_name": "validate",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/payment_method_domains/{payment_method_domain}/validate"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodDomain",
+ "has_collection_class": true,
+ "in_package": ""
+ }
+ },
+ "payment_method_domain_resource_payment_method_status": {
+ "description": "Indicates the status of a specific payment method on a payment method domain.",
+ "properties": {
+ "status": {
+ "description": "The status of the payment method on the domain.",
+ "enum": [
+ "active",
+ "inactive"
+ ],
+ "type": "string"
+ },
+ "status_details": {
+ "$ref": "#/components/schemas/payment_method_domain_resource_payment_method_status_details"
+ }
+ },
+ "required": [
+ "status"
+ ],
+ "title": "PaymentMethodDomainResourcePaymentMethodStatus",
+ "type": "object",
+ "x-expandableFields": [
+ "status_details"
+ ],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodDomainPaymentMethodStatus",
+ "in_package": ""
+ }
+ },
+ "payment_method_domain_resource_payment_method_status_details": {
+ "description": "Contains additional details about the status of a payment method for a specific payment method domain.",
+ "properties": {
+ "error_message": {
+ "description": "The error message associated with the status of the payment method on the domain.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "error_message"
+ ],
+ "title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "PaymentMethodDomainPaymentMethodStatusDetails",
+ "in_package": ""
}
},
"payment_method_eps": {
@@ -30406,7 +33535,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Eps",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_fpx": {
@@ -30459,7 +33588,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fpx",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_giropay": {
@@ -30470,7 +33599,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Giropay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_grabpay": {
@@ -30481,14 +33610,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Grabpay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_ideal": {
"description": "",
"properties": {
"bank": {
- "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
+ "description": "The customer's bank, if provided. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
"enum": [
"abn_amro",
"asn_bank",
@@ -30497,6 +33626,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -30520,6 +33650,7 @@
"INGBNL2A",
"KNABNL2H",
"MOYONL21",
+ "NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
@@ -30540,7 +33671,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Ideal",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_interac_present": {
@@ -30579,7 +33710,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -30659,7 +33790,7 @@
],
"x-stripeResource": {
"class_name": "InteracPresent",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_klarna": {
@@ -30685,10 +33816,7 @@
],
"x-stripeResource": {
"class_name": "Klarna",
- "in_class": "payment_method",
- "inner_classes": [
- "payment_flows_private_payment_methods_klarna_dob"
- ]
+ "in_package": ""
}
},
"payment_method_konbini": {
@@ -30699,17 +33827,12 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Konbini",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_link": {
"description": "",
"properties": {
- "country": {
- "description": "Two-letter ISO code representing the funding source (i.e. card, bank) country beneath the Link payment method.\nYou could use this attribute to get a sense of the international breakdown of funding sources you've collected.",
- "maxLength": 5000,
- "type": "string"
- },
"email": {
"description": "Account owner's email address.",
"maxLength": 5000,
@@ -30717,7 +33840,7 @@
"type": "string"
},
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
}
@@ -30730,7 +33853,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_options_affirm": {
@@ -30761,7 +33884,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Affirm",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_afterpay_clearpay": {
@@ -30775,7 +33898,7 @@
"type": "string"
},
"reference": {
- "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
+ "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.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -30797,7 +33920,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AfterpayClearpay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_alipay": {
@@ -30817,7 +33940,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Alipay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_bacs_debit": {
@@ -30838,7 +33961,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_bancontact": {
@@ -30871,7 +33994,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_boleto": {
@@ -30899,7 +34022,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Boleto",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_card_installments": {
@@ -30940,10 +34063,7 @@
],
"x-stripeResource": {
"class_name": "Installments",
- "in_class": "payment_intent_payment_method_options_card",
- "inner_classes": [
- "payment_method_details_card_installments_plan"
- ]
+ "in_package": ""
}
},
"payment_method_options_card_mandate_options": {
@@ -31027,7 +34147,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "payment_intent_payment_method_options_card"
+ "in_package": ""
}
},
"payment_method_options_card_present": {
@@ -31053,7 +34173,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CardPresent",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_cashapp": {
@@ -31081,7 +34201,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_customer_balance": {
@@ -31116,7 +34236,7 @@
],
"x-stripeResource": {
"class_name": "CustomerBalance",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_customer_balance_bank_transfer": {
@@ -31166,10 +34286,7 @@
],
"x-stripeResource": {
"class_name": "BankTransfer",
- "in_class": "payment_intent_payment_method_options",
- "inner_classes": [
- "payment_method_options_customer_balance_eu_bank_account"
- ]
+ "in_package": ""
}
},
"payment_method_options_customer_balance_eu_bank_account": {
@@ -31196,7 +34313,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EuBankTransfer",
- "in_class": "payment_method_options_customer_balance_bank_transfer"
+ "in_package": ""
}
},
"payment_method_options_fpx": {
@@ -31215,7 +34332,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Fpx",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_giropay": {
@@ -31234,7 +34351,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Giropay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_grabpay": {
@@ -31253,7 +34370,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Grabpay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_ideal": {
@@ -31273,7 +34390,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Ideal",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_interac_present": {
@@ -31284,7 +34401,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "InteracPresent",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_klarna": {
@@ -31319,7 +34436,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Klarna",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_konbini": {
@@ -31367,7 +34484,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Konbini",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_oxxo": {
@@ -31393,7 +34510,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Oxxo",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_p24": {
@@ -31412,7 +34529,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "P24",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_paynow": {
@@ -31431,7 +34548,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paynow",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_paypal": {
@@ -31473,7 +34590,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_pix": {
@@ -31506,7 +34623,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Pix",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_promptpay": {
@@ -31525,7 +34642,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Promptpay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_sofort": {
@@ -31562,7 +34679,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Sofort",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_wechat_pay": {
@@ -31602,7 +34719,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPay",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_options_zip": {
@@ -31621,7 +34738,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Zip",
- "in_class": "payment_intent_payment_method_options"
+ "in_package": ""
}
},
"payment_method_oxxo": {
@@ -31632,7 +34749,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Oxxo",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_p24": {
@@ -31680,7 +34797,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "P24",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_paynow": {
@@ -31691,7 +34808,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paynow",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_paypal": {
@@ -31715,7 +34832,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_pix": {
@@ -31726,7 +34843,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Pix",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_promptpay": {
@@ -31737,7 +34854,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Promptpay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_sepa_debit": {
@@ -31798,10 +34915,7 @@
],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "payment_method",
- "inner_classes": [
- "sepa_debit_generated_from"
- ]
+ "in_package": ""
}
},
"payment_method_sofort": {
@@ -31822,7 +34936,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Sofort",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_us_bank_account": {
@@ -31899,10 +35013,12 @@
"account_holder_type",
"account_type",
"bank_name",
+ "financial_connections_account",
"fingerprint",
"last4",
"networks",
- "routing_number"
+ "routing_number",
+ "status_details"
],
"title": "payment_method_us_bank_account",
"type": "object",
@@ -31912,11 +35028,7 @@
],
"x-stripeResource": {
"class_name": "USBankAccount",
- "in_class": "payment_method",
- "inner_classes": [
- "payment_method_us_bank_account_status_details",
- "us_bank_account_networks"
- ]
+ "in_package": ""
}
},
"payment_method_us_bank_account_blocked": {
@@ -31964,7 +35076,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusDetailsBlocked",
- "in_class": "payment_method_us_bank_account_status_details"
+ "in_package": ""
}
},
"payment_method_us_bank_account_status_details": {
@@ -31981,10 +35093,7 @@
],
"x-stripeResource": {
"class_name": "StatusDetails",
- "in_class": "payment_method_us_bank_account",
- "inner_classes": [
- "payment_method_us_bank_account_blocked"
- ]
+ "in_package": ""
}
},
"payment_method_wechat_pay": {
@@ -31995,7 +35104,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "WechatPay",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_method_zip": {
@@ -32006,7 +35115,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Zip",
- "in_class": "payment_method"
+ "in_package": ""
}
},
"payment_pages_checkout_session_after_expiration": {
@@ -32032,10 +35141,7 @@
],
"x-stripeResource": {
"class_name": "AfterExpiration",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_after_expiration_recovery"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_after_expiration_recovery": {
@@ -32073,7 +35179,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Recovery",
- "in_class": "payment_pages_checkout_session_after_expiration"
+ "in_package": ""
}
},
"payment_pages_checkout_session_automatic_tax": {
@@ -32103,7 +35209,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_consent": {
@@ -32137,7 +35243,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Consent",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_consent_collection": {
@@ -32171,7 +35277,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ConsentCollection",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_currency_conversion": {
@@ -32207,20 +35313,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrencyConversion",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields": {
"description": "",
"properties": {
"dropdown": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"
- }
- ],
- "description": "Configuration for `type=dropdown` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_dropdown"
},
"key": {
"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.",
@@ -32231,26 +35331,14 @@
"$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_label"
},
"numeric": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"
- }
- ],
- "description": "Configuration for `type=numeric` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_numeric"
},
"optional": {
"description": "Whether the customer is required to complete the field before completing the Checkout Session. Defaults to `false`.",
"type": "boolean"
},
"text": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text"
- }
- ],
- "description": "Configuration for `type=text` fields.",
- "nullable": true
+ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_fields_text"
},
"type": {
"description": "The type of the field.",
@@ -32263,12 +35351,9 @@
}
},
"required": [
- "dropdown",
"key",
"label",
- "numeric",
"optional",
- "text",
"type"
],
"title": "PaymentPagesCheckoutSessionCustomFields",
@@ -32281,13 +35366,7 @@
],
"x-stripeResource": {
"class_name": "CustomField",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_custom_fields_dropdown",
- "payment_pages_checkout_session_custom_fields_label",
- "payment_pages_checkout_session_custom_fields_numeric",
- "payment_pages_checkout_session_custom_fields_text"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields_dropdown": {
@@ -32318,10 +35397,7 @@
],
"x-stripeResource": {
"class_name": "CustomFieldDropdown",
- "in_class": "payment_pages_checkout_session_custom_fields",
- "inner_classes": [
- "payment_pages_checkout_session_custom_fields_option"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields_label": {
@@ -32350,7 +35426,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldLabel",
- "in_class": "payment_pages_checkout_session_custom_fields"
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields_numeric": {
@@ -32383,7 +35459,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldNumeric",
- "in_class": "payment_pages_checkout_session_custom_fields"
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields_option": {
@@ -32409,7 +35485,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldDropdownOption",
- "in_class": "payment_pages_checkout_session_custom_fields_dropdown"
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_fields_text": {
@@ -32442,7 +35518,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomFieldText",
- "in_class": "payment_pages_checkout_session_custom_fields"
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_text": {
@@ -32465,31 +35541,39 @@
],
"description": "Custom text that should be displayed alongside the payment confirmation button.",
"nullable": true
+ },
+ "terms_of_service_acceptance": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
+ }
+ ],
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text.",
+ "nullable": true
}
},
"required": [
"shipping_address",
- "submit"
+ "submit",
+ "terms_of_service_acceptance"
],
"title": "PaymentPagesCheckoutSessionCustomText",
"type": "object",
"x-expandableFields": [
"shipping_address",
- "submit"
+ "submit",
+ "terms_of_service_acceptance"
],
"x-stripeResource": {
"class_name": "CustomText",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_custom_text_position"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_custom_text_position": {
"description": "",
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
+ "description": "Text may be up to 1200 characters in length.",
"maxLength": 500,
"type": "string"
}
@@ -32502,7 +35586,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Position",
- "in_class": "payment_pages_checkout_session_custom_text"
+ "in_package": ""
}
},
"payment_pages_checkout_session_customer_details": {
@@ -32570,10 +35654,7 @@
],
"x-stripeResource": {
"class_name": "CustomerDetails",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_tax_id"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_invoice_creation": {
@@ -32598,10 +35679,7 @@
],
"x-stripeResource": {
"class_name": "InvoiceCreation",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_invoice_settings"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_invoice_settings": {
@@ -32692,7 +35770,7 @@
],
"x-stripeResource": {
"class_name": "InvoiceData",
- "in_class": "payment_pages_checkout_session_invoice_creation"
+ "in_package": ""
}
},
"payment_pages_checkout_session_phone_number_collection": {
@@ -32711,7 +35789,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PhoneNumberCollection",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_shipping_address_collection": {
@@ -32972,7 +36050,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ShippingAddressCollection",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_shipping_cost": {
@@ -33032,7 +36110,7 @@
],
"x-stripeResource": {
"class_name": "ShippingCost",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_shipping_option": {
@@ -33073,7 +36151,7 @@
],
"x-stripeResource": {
"class_name": "ShippingOption",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_tax_id": {
@@ -33168,7 +36246,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TaxID",
- "in_class": "payment_pages_checkout_session_customer_details"
+ "in_package": ""
}
},
"payment_pages_checkout_session_tax_id_collection": {
@@ -33187,7 +36265,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TaxIDCollection",
- "in_class": "checkout.session"
+ "in_package": ""
}
},
"payment_pages_checkout_session_total_details": {
@@ -33222,10 +36300,7 @@
],
"x-stripeResource": {
"class_name": "TotalDetails",
- "in_class": "checkout.session",
- "inner_classes": [
- "payment_pages_checkout_session_total_details_resource_breakdown"
- ]
+ "in_package": ""
}
},
"payment_pages_checkout_session_total_details_resource_breakdown": {
@@ -33258,7 +36333,7 @@
],
"x-stripeResource": {
"class_name": "Breakdown",
- "in_class": "payment_pages_checkout_session_total_details"
+ "in_package": ""
}
},
"payment_source": {
@@ -33329,19 +36404,19 @@
}
},
"payout": {
- "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,\nas well as 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)",
+ "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)",
"properties": {
"amount": {
- "description": "Amount (in %s) to be transferred to your bank account or debit card.",
+ "description": "The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.",
"type": "integer"
},
"arrival_date": {
- "description": "Date the payout is expected to arrive in the bank. This factors in delays like weekends or bank holidays.",
+ "description": "Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.",
"format": "unix-time",
"type": "integer"
},
"automatic": {
- "description": "Returns `true` if the payout was created by an [automated payout schedule](https://stripe.com/docs/payouts#payout-schedule), and `false` if it was [requested manually](https://stripe.com/docs/payouts#manual-payouts).",
+ "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).",
"type": "boolean"
},
"balance_transaction": {
@@ -33392,7 +36467,7 @@
"$ref": "#/components/schemas/deleted_external_account"
}
],
- "description": "ID of the bank account or card the payout was sent to.",
+ "description": "ID of the bank account or card the payout is sent to.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -33415,7 +36490,7 @@
"$ref": "#/components/schemas/balance_transaction"
}
],
- "description": "If the payout failed or was canceled, this will be the ID of the balance transaction that reversed the initial balance transaction, and puts the funds from the failed payout back in your balance.",
+ "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.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -33426,13 +36501,13 @@
}
},
"failure_code": {
- "description": "Error code explaining reason for payout failure if available. See [Types of payout failures](https://stripe.com/docs/api#payout_failures) for a list of failure codes.",
+ "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).",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"failure_message": {
- "description": "Message to user further explaining reason for payout failure if available.",
+ "description": "Message that provides the reason for a payout failure, if available.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -33456,7 +36531,7 @@
"type": "object"
},
"method": {
- "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces](https://stripe.com/blog/instant-payouts-for-marketplaces) for more information.)",
+ "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).",
"maxLength": 5000,
"type": "string"
},
@@ -33488,7 +36563,7 @@
}
},
"reconciliation_status": {
- "description": "If `completed`, the [Balance Transactions API](https://stripe.com/docs/api/balance_transactions/list#balance_transaction_list-payout) may be used to list all Balance Transactions that were paid out in this payout.",
+ "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.",
"enum": [
"completed",
"in_progress",
@@ -33506,7 +36581,7 @@
"$ref": "#/components/schemas/payout"
}
],
- "description": "If the payout was reversed, this is the ID of the payout that reverses this payout.",
+ "description": "If the payout reverses, this is the ID of the payout that reverses this payout.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -33517,18 +36592,18 @@
}
},
"source_type": {
- "description": "The source balance this payout came from. One of `card`, `fpx`, or `bank_account`.",
+ "description": "The source balance this payout came from, which can be one of the following: `card`, `fpx`, or `bank_account`.",
"maxLength": 5000,
"type": "string"
},
"statement_descriptor": {
- "description": "Extra information about a payout to be displayed on the user's bank statement.",
+ "description": "Extra information about a payout that displays on the user's bank statement.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"status": {
- "description": "Current status of the payout: `paid`, `pending`, `in_transit`, `canceled` or `failed`. A payout is `pending` until it is submitted to the bank, when it becomes `in_transit`. The status then changes to `paid` if the transaction goes through, or to `failed` or `canceled` (within 5 business days). Some failed payouts may initially show as `paid` but then change to `failed`.",
+ "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`.",
"maxLength": 5000,
"type": "string"
},
@@ -33630,6 +36705,102 @@
]
}
},
+ "payout.canceled": {
+ "description": "Occurs whenever a payout is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.canceled"
+ }
+ },
+ "payout.created": {
+ "description": "Occurs whenever a payout is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.created"
+ }
+ },
+ "payout.failed": {
+ "description": "Occurs whenever a payout attempt fails.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.failed"
+ }
+ },
+ "payout.paid": {
+ "description": "Occurs whenever a payout is *expected* to be available in the destination account. If the payout fails, a `payout.failed` notification is also sent, at a later time.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.paid"
+ }
+ },
+ "payout.reconciliation_completed": {
+ "description": "Occurs whenever balance transactions paid out in an automatic payout can be queried.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.reconciliation_completed"
+ }
+ },
+ "payout.updated": {
+ "description": "Occurs whenever a payout is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/payout"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "payout.updated"
+ }
+ },
"paypal_seller_protection": {
"description": "",
"properties": {
@@ -33693,17 +36864,20 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Period",
- "in_class": "usage_record_summary"
+ "in_package": ""
}
},
"person": {
- "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.\n\nRelated guide: [Handling identity verification with the API](https://stripe.com/docs/connect/identity-verification-api#person-information)",
+ "description": "This is an object representing a person associated with a Stripe account.\n\nA platform cannot access a Standard or Express account's persons after the account starts onboarding, such as after generating an account link for the account.\nSee the [Standard onboarding](https://stripe.com/docs/connect/standard-accounts) or [Express onboarding documentation](https://stripe.com/docs/connect/express-accounts) for information about platform prefilling and account onboarding steps.\n\nRelated guide: [Handling identity verification with the API](https://stripe.com/docs/connect/handling-api-verification#person-information)",
"properties": {
"account": {
"description": "The account the person is associated with.",
"maxLength": 5000,
"type": "string"
},
+ "additional_tos_acceptances": {
+ "$ref": "#/components/schemas/person_additional_tos_acceptances"
+ },
"address": {
"$ref": "#/components/schemas/address"
},
@@ -33771,7 +36945,7 @@
"$ref": "#/components/schemas/person_future_requirements"
}
],
- "description": "Information about the upcoming new requirements for this person, including what information needs to be collected, and by when.",
+ "description": "Information about the [upcoming new requirements for this person](https://stripe.com/docs/connect/custom-accounts/future-requirements), including what information needs to be collected, and by when.",
"nullable": true
},
"gender": {
@@ -33785,7 +36959,7 @@
"type": "string"
},
"id_number_provided": {
- "description": "Whether the person's `id_number` was provided.",
+ "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`).",
"type": "boolean"
},
"id_number_secondary_provided": {
@@ -33882,6 +37056,7 @@
"title": "Person",
"type": "object",
"x-expandableFields": [
+ "additional_tos_acceptances",
"address",
"address_kana",
"address_kanji",
@@ -33954,16 +37129,110 @@
"x-stripeResource": {
"class_name": "Person",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "legal_entity_dob",
- "legal_entity_japan_address",
- "legal_entity_person_verification",
- "legal_entity_person_verification_document",
- "person_future_requirements",
- "person_relationship",
- "person_requirements"
- ]
+ "in_package": ""
+ }
+ },
+ "person.created": {
+ "description": "Occurs whenever a person associated with an account is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/person"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "person.created"
+ }
+ },
+ "person.deleted": {
+ "description": "Occurs whenever a person associated with an account is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/person"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "person.deleted"
+ }
+ },
+ "person.updated": {
+ "description": "Occurs whenever a person associated with an account is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/person"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "person.updated"
+ }
+ },
+ "person_additional_tos_acceptance": {
+ "description": "",
+ "properties": {
+ "date": {
+ "description": "The Unix timestamp marking when the legal guardian accepted the service agreement.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "ip": {
+ "description": "The IP address from which the legal guardian accepted the service agreement.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "user_agent": {
+ "description": "The user agent of the browser from which the legal guardian accepted the service agreement.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "date",
+ "ip",
+ "user_agent"
+ ],
+ "title": "PersonAdditionalTOSAcceptance",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "PersonAdditionalTosAcceptance",
+ "in_package": ""
+ }
+ },
+ "person_additional_tos_acceptances": {
+ "description": "",
+ "properties": {
+ "account": {
+ "$ref": "#/components/schemas/person_additional_tos_acceptance"
+ }
+ },
+ "required": [
+ "account"
+ ],
+ "title": "PersonAdditionalTOSAcceptances",
+ "type": "object",
+ "x-expandableFields": [
+ "account"
+ ],
+ "x-stripeResource": {
+ "class_name": "PersonAdditionalTosAcceptances",
+ "in_package": ""
}
},
"person_future_requirements": {
@@ -34033,7 +37302,7 @@
],
"x-stripeResource": {
"class_name": "FutureRequirements",
- "in_class": "person"
+ "in_package": ""
}
},
"person_relationship": {
@@ -34049,6 +37318,11 @@
"nullable": true,
"type": "boolean"
},
+ "legal_guardian": {
+ "description": "Whether the person is the legal guardian of the account's representative.",
+ "nullable": true,
+ "type": "boolean"
+ },
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
"nullable": true,
@@ -34074,6 +37348,7 @@
"required": [
"director",
"executive",
+ "legal_guardian",
"owner",
"percent_ownership",
"representative",
@@ -34084,7 +37359,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Relationship",
- "in_class": "person"
+ "in_package": ""
}
},
"person_requirements": {
@@ -34154,7 +37429,7 @@
],
"x-stripeResource": {
"class_name": "Requirements",
- "in_class": "person"
+ "in_package": ""
}
},
"plan": {
@@ -34176,12 +37451,12 @@
"type": "string"
},
"amount": {
- "description": "The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"nullable": true,
"type": "integer"
},
"amount_decimal": {
- "description": "The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"format": "decimal",
"nullable": true,
"type": "string"
@@ -34382,11 +37657,55 @@
"x-stripeResource": {
"class_name": "Plan",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "plan_tier",
- "transform_usage"
- ]
+ "in_package": ""
+ }
+ },
+ "plan.created": {
+ "description": "Occurs whenever a plan is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/plan"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "plan.created"
+ }
+ },
+ "plan.deleted": {
+ "description": "Occurs whenever a plan is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/plan"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "plan.deleted"
+ }
+ },
+ "plan.updated": {
+ "description": "Occurs whenever a plan is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/plan"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "plan.updated"
}
},
"plan_tier": {
@@ -34432,7 +37751,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Tier",
- "in_class": "plan"
+ "in_package": ""
}
},
"platform_tax_fee": {
@@ -34516,7 +37835,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BusinessProfile",
- "in_class": "billing_portal.configuration"
+ "in_package": ""
}
},
"portal_customer_update": {
@@ -34551,7 +37870,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CustomerUpdate",
- "in_class": "portal_features"
+ "in_package": ""
}
},
"portal_features": {
@@ -34596,15 +37915,7 @@
],
"x-stripeResource": {
"class_name": "Features",
- "in_class": "billing_portal.configuration",
- "inner_classes": [
- "portal_customer_update",
- "portal_invoice_list",
- "portal_payment_method_update",
- "portal_subscription_cancel",
- "portal_subscription_pause",
- "portal_subscription_update"
- ]
+ "in_package": ""
}
},
"portal_flows_after_completion_hosted_confirmation": {
@@ -34625,7 +37936,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "HostedConfirmation",
- "in_class": "portal_flows_flow_after_completion"
+ "in_package": ""
}
},
"portal_flows_after_completion_redirect": {
@@ -34645,7 +37956,27 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Redirect",
- "in_class": "portal_flows_flow_after_completion"
+ "in_package": ""
+ }
+ },
+ "portal_flows_coupon_offer": {
+ "description": "",
+ "properties": {
+ "coupon": {
+ "description": "The ID of the coupon to be offered.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "coupon"
+ ],
+ "title": "PortalFlowsCouponOffer",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "CouponOffer",
+ "in_package": ""
}
},
"portal_flows_flow": {
@@ -34709,15 +38040,7 @@
],
"x-stripeResource": {
"class_name": "Flow",
- "in_class": "billing_portal.session",
- "inner_classes": [
- "portal_flows_flow_after_completion",
- "portal_flows_flow_subscription_cancel",
- "portal_flows_flow_subscription_update",
- "portal_flows_flow_subscription_update_confirm",
- "portal_flows_subscription_update_confirm_discount",
- "portal_flows_subscription_update_confirm_item"
- ]
+ "in_package": ""
}
},
"portal_flows_flow_after_completion": {
@@ -34764,16 +38087,21 @@
],
"x-stripeResource": {
"class_name": "AfterCompletion",
- "in_class": "portal_flows_flow",
- "inner_classes": [
- "portal_flows_after_completion_hosted_confirmation",
- "portal_flows_after_completion_redirect"
- ]
+ "in_package": ""
}
},
"portal_flows_flow_subscription_cancel": {
"description": "",
"properties": {
+ "retention": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/portal_flows_retention"
+ }
+ ],
+ "description": "Specify a retention strategy to be used in the cancellation flow.",
+ "nullable": true
+ },
"subscription": {
"description": "The ID of the subscription to be canceled.",
"maxLength": 5000,
@@ -34781,14 +38109,17 @@
}
},
"required": [
+ "retention",
"subscription"
],
"title": "PortalFlowsFlowSubscriptionCancel",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "retention"
+ ],
"x-stripeResource": {
"class_name": "SubscriptionCancel",
- "in_class": "portal_flows_flow"
+ "in_package": ""
}
},
"portal_flows_flow_subscription_update": {
@@ -34808,7 +38139,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SubscriptionUpdate",
- "in_class": "portal_flows_flow"
+ "in_package": ""
}
},
"portal_flows_flow_subscription_update_confirm": {
@@ -34848,7 +38179,41 @@
],
"x-stripeResource": {
"class_name": "SubscriptionUpdateConfirm",
- "in_class": "portal_flows_flow"
+ "in_package": ""
+ }
+ },
+ "portal_flows_retention": {
+ "description": "",
+ "properties": {
+ "coupon_offer": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/portal_flows_coupon_offer"
+ }
+ ],
+ "description": "Configuration when `retention.type=coupon_offer`.",
+ "nullable": true
+ },
+ "type": {
+ "description": "Type of retention strategy that will be used.",
+ "enum": [
+ "coupon_offer"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "coupon_offer",
+ "type"
+ ],
+ "title": "PortalFlowsRetention",
+ "type": "object",
+ "x-expandableFields": [
+ "coupon_offer"
+ ],
+ "x-stripeResource": {
+ "class_name": "Retention",
+ "in_package": ""
}
},
"portal_flows_subscription_update_confirm_discount": {
@@ -34876,7 +38241,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Discount",
- "in_class": "portal_flows_flow"
+ "in_package": ""
}
},
"portal_flows_subscription_update_confirm_item": {
@@ -34889,7 +38254,7 @@
"type": "string"
},
"price": {
- "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`](docs/api/customer_portal/configuration#portal_configuration_object-features-subscription_update-products).",
+ "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).",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -34908,7 +38273,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Item",
- "in_class": "portal_flows_flow"
+ "in_package": ""
}
},
"portal_invoice_list": {
@@ -34927,7 +38292,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "InvoiceHistory",
- "in_class": "portal_features"
+ "in_package": ""
}
},
"portal_login_page": {
@@ -34953,7 +38318,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LoginPage",
- "in_class": "billing_portal.configuration"
+ "in_package": ""
}
},
"portal_payment_method_update": {
@@ -34972,7 +38337,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PaymentMethodUpdate",
- "in_class": "portal_features"
+ "in_package": ""
}
},
"portal_subscription_cancel": {
@@ -35016,10 +38381,7 @@
],
"x-stripeResource": {
"class_name": "SubscriptionCancel",
- "in_class": "portal_features",
- "inner_classes": [
- "portal_subscription_cancellation_reason"
- ]
+ "in_package": ""
}
},
"portal_subscription_cancellation_reason": {
@@ -35056,7 +38418,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CancellationReason",
- "in_class": "portal_subscription_cancel"
+ "in_package": ""
}
},
"portal_subscription_pause": {
@@ -35075,7 +38437,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SubscriptionPause",
- "in_class": "portal_features"
+ "in_package": ""
}
},
"portal_subscription_update": {
@@ -35128,10 +38490,7 @@
],
"x-stripeResource": {
"class_name": "SubscriptionUpdate",
- "in_class": "portal_features",
- "inner_classes": [
- "portal_subscription_update_product"
- ]
+ "in_package": ""
}
},
"portal_subscription_update_product": {
@@ -35160,7 +38519,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Product",
- "in_class": "portal_subscription_update"
+ "in_package": ""
}
},
"price": {
@@ -35317,12 +38676,12 @@
"type": "string"
},
"unit_amount": {
- "description": "The unit amount in %s to be charged, represented as a whole integer if possible. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"nullable": true,
"type": "integer"
},
"unit_amount_decimal": {
- "description": "The unit amount in %s to be charged, represented as a decimal string with at most 12 decimal places. Only set if `billing_scheme=per_unit`.",
+ "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`.",
"format": "decimal",
"nullable": true,
"type": "string"
@@ -35401,14 +38760,55 @@
"class_name": "Price",
"has_collection_class": true,
"has_search_result_class": true,
- "in_package": "",
- "inner_classes": [
- "currency_option",
- "custom_unit_amount",
- "price_tier",
- "recurring",
- "transform_quantity"
- ]
+ "in_package": ""
+ }
+ },
+ "price.created": {
+ "description": "Occurs whenever a price is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/price"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "price.created"
+ }
+ },
+ "price.deleted": {
+ "description": "Occurs whenever a price is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/price"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "price.deleted"
+ }
+ },
+ "price.updated": {
+ "description": "Occurs whenever a price is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/price"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "price.updated"
}
},
"price_tier": {
@@ -35454,7 +38854,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Tier",
- "in_class": "price"
+ "in_package": ""
}
},
"product": {
@@ -35464,34 +38864,11 @@
"description": "Whether the product is currently available for purchase.",
"type": "boolean"
},
- "attributes": {
- "description": "A list of up to 5 attributes that each SKU can provide values for (e.g., `[\"color\", \"size\"]`).",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "nullable": true,
- "type": "array"
- },
- "caption": {
- "description": "A short one-line description of the product, meant to be displayable to the customer. Only applicable to products of `type=good`.",
- "maxLength": 5000,
- "nullable": true,
- "type": "string"
- },
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
- "deactivate_on": {
- "description": "An array of connect application identifiers that cannot purchase this product. Only applicable to products of `type=good`.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
"default_price": {
"anyOf": [
{
@@ -35518,6 +38895,13 @@
"nullable": true,
"type": "string"
},
+ "features": {
+ "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).",
+ "items": {
+ "$ref": "#/components/schemas/product_feature"
+ },
+ "type": "array"
+ },
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
@@ -35623,9 +39007,9 @@
},
"required": [
"active",
- "attributes",
"created",
"description",
+ "features",
"id",
"images",
"livemode",
@@ -35643,6 +39027,7 @@
"type": "object",
"x-expandableFields": [
"default_price",
+ "features",
"package_dimensions",
"tax_code"
],
@@ -35698,6 +39083,74 @@
"in_package": ""
}
},
+ "product.created": {
+ "description": "Occurs whenever a product is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/product"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "product.created"
+ }
+ },
+ "product.deleted": {
+ "description": "Occurs whenever a product is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/product"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "product.deleted"
+ }
+ },
+ "product.updated": {
+ "description": "Occurs whenever a product is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/product"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "product.updated"
+ }
+ },
+ "product_feature": {
+ "description": "",
+ "properties": {
+ "name": {
+ "description": "The feature's name. Up to 80 characters long.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "title": "ProductFeature",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "ProductFeature",
+ "in_package": ""
+ }
+ },
"promotion_code": {
"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.",
"properties": {
@@ -35844,11 +39297,39 @@
"x-stripeResource": {
"class_name": "PromotionCode",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "promotion_code_currency_option",
- "promotion_codes_resource_restrictions"
- ]
+ "in_package": ""
+ }
+ },
+ "promotion_code.created": {
+ "description": "Occurs whenever a promotion code is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/promotion_code"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "promotion_code.created"
+ }
+ },
+ "promotion_code.updated": {
+ "description": "Occurs whenever a promotion code is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/promotion_code"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "promotion_code.updated"
}
},
"promotion_code_currency_option": {
@@ -35867,7 +39348,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrencyOption",
- "in_class": "promotion_code"
+ "in_package": ""
}
},
"promotion_codes_resource_restrictions": {
@@ -35908,7 +39389,7 @@
],
"x-stripeResource": {
"class_name": "Restrictions",
- "in_class": "promotion_code"
+ "in_package": ""
}
},
"quote": {
@@ -35954,7 +39435,7 @@
"type": "integer"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. Only applicable if there are line items with recurring prices on the quote.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -36432,19 +39913,71 @@
"x-stripeResource": {
"class_name": "Quote",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "invoice_setting_quote_setting",
- "quotes_resource_automatic_tax",
- "quotes_resource_computed",
- "quotes_resource_from_quote",
- "quotes_resource_recurring",
- "quotes_resource_status_transitions",
- "quotes_resource_subscription_data_subscription_data",
- "quotes_resource_total_details",
- "quotes_resource_transfer_data",
- "quotes_resource_upfront"
- ]
+ "in_package": ""
+ }
+ },
+ "quote.accepted": {
+ "description": "Occurs whenever a quote is accepted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/quote"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "quote.accepted"
+ }
+ },
+ "quote.canceled": {
+ "description": "Occurs whenever a quote is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/quote"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "quote.canceled"
+ }
+ },
+ "quote.created": {
+ "description": "Occurs whenever a quote is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/quote"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "quote.created"
+ }
+ },
+ "quote.finalized": {
+ "description": "Occurs whenever a quote is finalized.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/quote"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "quote.finalized"
}
},
"quotes_resource_automatic_tax": {
@@ -36474,7 +40007,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_computed": {
@@ -36505,7 +40038,7 @@
],
"x-stripeResource": {
"class_name": "Computed",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_from_quote": {
@@ -36546,7 +40079,7 @@
],
"x-stripeResource": {
"class_name": "FromQuote",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_recurring": {
@@ -36592,7 +40125,7 @@
],
"x-stripeResource": {
"class_name": "Recurring",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_status_transitions": {
@@ -36627,7 +40160,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_subscription_data_subscription_data": {
@@ -36661,7 +40194,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SubscriptionData",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_total_details": {
@@ -36696,10 +40229,7 @@
],
"x-stripeResource": {
"class_name": "TotalDetails",
- "in_class": "quote",
- "inner_classes": [
- "quotes_resource_total_details_resource_breakdown"
- ]
+ "in_package": ""
}
},
"quotes_resource_total_details_resource_breakdown": {
@@ -36732,19 +40262,19 @@
],
"x-stripeResource": {
"class_name": "Breakdown",
- "in_class": "quotes_resource_total_details"
+ "in_package": ""
}
},
"quotes_resource_transfer_data": {
"description": "",
"properties": {
"amount": {
- "description": "The amount in %s that will be transferred to the destination account when the invoice is paid. By default, the entire amount is transferred to the destination.",
+ "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.",
"nullable": true,
"type": "integer"
},
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount will be transferred to the destination.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -36780,7 +40310,7 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "quote"
+ "in_package": ""
}
},
"quotes_resource_upfront": {
@@ -36850,7 +40380,7 @@
],
"x-stripeResource": {
"class_name": "Upfront",
- "in_class": "quote"
+ "in_package": ""
}
},
"radar.early_fraud_warning": {
@@ -36963,6 +40493,38 @@
"in_package": "Radar"
}
},
+ "radar.early_fraud_warning.created": {
+ "description": "Occurs whenever an early fraud warning is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/radar.early_fraud_warning"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "radar.early_fraud_warning.created"
+ }
+ },
+ "radar.early_fraud_warning.updated": {
+ "description": "Occurs whenever an early fraud warning is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/radar.early_fraud_warning"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "radar.early_fraud_warning.updated"
+ }
+ },
"radar.value_list": {
"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)",
"properties": {
@@ -36987,7 +40549,7 @@
"type": "string"
},
"item_type": {
- "description": "The type of items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`.",
+ "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`.",
"enum": [
"card_bin",
"card_fingerprint",
@@ -36996,7 +40558,9 @@
"customer_id",
"email",
"ip_address",
- "string"
+ "sepa_debit_fingerprint",
+ "string",
+ "us_bank_account_fingerprint"
],
"type": "string"
},
@@ -37228,7 +40792,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "RadarOptions",
- "in_class": "charge"
+ "in_package": ""
}
},
"radar_review_resource_location": {
@@ -37275,7 +40839,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Location",
- "in_class": "review"
+ "in_package": ""
}
},
"radar_review_resource_session": {
@@ -37317,7 +40881,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Session",
- "in_class": "review"
+ "in_package": ""
}
},
"received_payment_method_details_financial_account": {
@@ -37345,7 +40909,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FinancialAccount",
- "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
+ "in_package": ""
}
},
"recurring": {
@@ -37402,14 +40966,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Recurring",
- "in_class": "price"
+ "in_package": ""
}
},
"refund": {
- "description": "`Refund` objects allow you to refund a charge that has previously been created\nbut not yet refunded. Funds will be refunded to the credit or debit card that\nwas originally charged.\n\nRelated guide: [Refunds](https://stripe.com/docs/refunds)",
+ "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)",
"properties": {
"amount": {
- "description": "Amount, in %s.",
+ "description": "Amount, in cents (or local equivalent).",
"type": "integer"
},
"balance_transaction": {
@@ -37442,7 +41006,7 @@
"$ref": "#/components/schemas/charge"
}
],
- "description": "ID of the charge that was refunded.",
+ "description": "ID of the charge that's refunded.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -37462,7 +41026,7 @@
"type": "string"
},
"description": {
- "description": "An arbitrary string attached to the object. Often useful for displaying to users. (Available on non-card refunds only)",
+ "description": "An arbitrary string attached to the object. You can use this for displaying to users (available on non-card refunds only).",
"maxLength": 5000,
"type": "string"
},
@@ -37476,7 +41040,7 @@
"$ref": "#/components/schemas/balance_transaction"
}
],
- "description": "If the refund failed, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.",
+ "description": "After the refund fails, this balance transaction describes the adjustment made on your account balance that reverses the initial balance transaction.",
"x-expansionResources": {
"oneOf": [
{
@@ -37486,7 +41050,7 @@
}
},
"failure_reason": {
- "description": "If the refund failed, the reason for refund failure if known. Possible values are `lost_or_stolen_card`, `expired_or_canceled_card`, `charge_for_pending_refund_disputed`, `insufficient_funds`, `declined`, `merchant_request` or `unknown`.",
+ "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`.",
"maxLength": 5000,
"type": "string"
},
@@ -37496,7 +41060,7 @@
"type": "string"
},
"instructions_email": {
- "description": "For payment methods without native refund support (e.g., Konbini, PromptPay), email for the customer to receive refund instructions.",
+ "description": "For payment methods without native refund support (for example, Konbini, PromptPay), provide an email address for the customer to receive refund instructions.",
"maxLength": 5000,
"type": "string"
},
@@ -37529,7 +41093,7 @@
"$ref": "#/components/schemas/payment_intent"
}
],
- "description": "ID of the PaymentIntent that was refunded.",
+ "description": "ID of the PaymentIntent that's refunded.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -37540,7 +41104,7 @@
}
},
"reason": {
- "description": "Reason for the refund, either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).",
+ "description": "Reason for the refund, which is either user-provided (`duplicate`, `fraudulent`, or `requested_by_customer`) or generated by Stripe internally (`expired_uncaptured_charge`).",
"enum": [
"duplicate",
"expired_uncaptured_charge",
@@ -37567,7 +41131,7 @@
"$ref": "#/components/schemas/transfer_reversal"
}
],
- "description": "The transfer reversal that is associated with the refund. Only present if the charge came from another Stripe account. See the Connect documentation for details.",
+ "description": "The transfer reversal that's associated with the refund. Only present if the charge came from another Stripe account.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -37578,7 +41142,7 @@
}
},
"status": {
- "description": "Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Refer to our [refunds](https://stripe.com/docs/refunds#failed-refunds) documentation for more details.",
+ "description": "Status of the refund. For credit card refunds, this can be `pending`, `succeeded`, or `failed`. For other types of refunds, it can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -37593,7 +41157,7 @@
"$ref": "#/components/schemas/transfer_reversal"
}
],
- "description": "If the accompanying transfer was reversed, the transfer reversal object. Only applicable if the charge was created using the destination parameter.",
+ "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.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
@@ -37694,15 +41258,43 @@
"class_name": "Refund",
"has_collection_class": true,
"in_package": "",
- "inner_classes": [
- "refund_next_action",
- "refund_next_action_display_details"
- ],
"polymorphic_groups": [
"balance_transaction_source"
]
}
},
+ "refund.created": {
+ "description": "Occurs whenever a refund from a customer's cash balance is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/refund"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "refund.created"
+ }
+ },
+ "refund.updated": {
+ "description": "Occurs whenever a refund from a customer's cash balance is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/refund"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "refund.updated"
+ }
+ },
"refund_next_action": {
"description": "",
"properties": {
@@ -37732,7 +41324,7 @@
],
"x-stripeResource": {
"class_name": "NextAction",
- "in_class": "refund"
+ "in_package": ""
}
},
"refund_next_action_display_details": {
@@ -37758,10 +41350,7 @@
],
"x-stripeResource": {
"class_name": "NextActionDisplayDetails",
- "in_class": "refund",
- "inner_classes": [
- "email_sent"
- ]
+ "in_package": ""
}
},
"reporting.report_run": {
@@ -37868,10 +41457,39 @@
"x-stripeResource": {
"class_name": "ReportRun",
"has_collection_class": true,
- "in_package": "Reporting",
- "inner_classes": [
- "financial_reporting_finance_report_run_run_parameters"
- ]
+ "in_package": "Reporting"
+ }
+ },
+ "reporting.report_run.failed": {
+ "description": "Occurs whenever a requested `ReportRun` failed to complete.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/reporting.report_run"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "reporting.report_run.failed"
+ }
+ },
+ "reporting.report_run.succeeded": {
+ "description": "Occurs whenever a requested `ReportRun` completed successfully.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/reporting.report_run"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "reporting.report_run.succeeded"
}
},
"reporting.report_type": {
@@ -37964,6 +41582,22 @@
"in_package": "Reporting"
}
},
+ "reporting.report_type.updated": {
+ "description": "Occurs whenever a `ReportType` is updated (typically to indicate that a new day's data has come available).",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/reporting.report_type"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "reporting.report_type.updated"
+ }
+ },
"reserve_transaction": {
"description": "",
"properties": {
@@ -38184,11 +41818,39 @@
"x-stripeResource": {
"class_name": "Review",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "radar_review_resource_location",
- "radar_review_resource_session"
- ]
+ "in_package": ""
+ }
+ },
+ "review.closed": {
+ "description": "Occurs whenever a review is closed. The review's `reason` field indicates why: `approved`, `disputed`, `refunded`, or `refunded_as_fraud`.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/review"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "review.closed"
+ }
+ },
+ "review.opened": {
+ "description": "Occurs whenever a review is opened.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/review"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "review.opened"
}
},
"rule": {
@@ -38323,10 +41985,7 @@
"x-stripeResource": {
"class_name": "ScheduledQueryRun",
"has_collection_class": true,
- "in_package": "Sigma",
- "inner_classes": [
- "sigma_scheduled_query_run_error"
- ]
+ "in_package": "Sigma"
}
},
"schedules_phase_automatic_tax": {
@@ -38345,7 +42004,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "subscription_schedule_phase_configuration"
+ "in_package": ""
}
},
"secret_service_resource_scope": {
@@ -38373,7 +42032,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Scope",
- "in_class": "apps.secret"
+ "in_package": ""
}
},
"sepa_debit_generated_from": {
@@ -38432,11 +42091,11 @@
],
"x-stripeResource": {
"class_name": "GeneratedFrom",
- "in_class": "payment_method_sepa_debit"
+ "in_package": ""
}
},
"setup_attempt": {
- "description": "A SetupAttempt describes one attempted confirmation of a SetupIntent,\nwhether that confirmation was successful or unsuccessful. You can use\nSetupAttempts to inspect details of a specific attempt at setting up a\npayment method using a SetupIntent.",
+ "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.",
"properties": {
"application": {
"anyOf": [
@@ -38642,10 +42301,7 @@
"x-stripeResource": {
"class_name": "SetupAttempt",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "setup_attempt_payment_method_details"
- ]
+ "in_package": ""
}
},
"setup_attempt_payment_method_details": {
@@ -38663,9 +42319,6 @@
"bancontact": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_bancontact"
},
- "blik": {
- "$ref": "#/components/schemas/setup_attempt_payment_method_details_blik"
- },
"boleto": {
"$ref": "#/components/schemas/setup_attempt_payment_method_details_boleto"
},
@@ -38715,7 +42368,6 @@
"au_becs_debit",
"bacs_debit",
"bancontact",
- "blik",
"boleto",
"card",
"card_present",
@@ -38730,25 +42382,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodDetails",
- "in_class": "setup_attempt",
- "inner_classes": [
- "setup_attempt_payment_method_details_acss_debit",
- "setup_attempt_payment_method_details_au_becs_debit",
- "setup_attempt_payment_method_details_bacs_debit",
- "setup_attempt_payment_method_details_bancontact",
- "setup_attempt_payment_method_details_blik",
- "setup_attempt_payment_method_details_boleto",
- "setup_attempt_payment_method_details_card",
- "setup_attempt_payment_method_details_card_present",
- "setup_attempt_payment_method_details_cashapp",
- "setup_attempt_payment_method_details_ideal",
- "setup_attempt_payment_method_details_klarna",
- "setup_attempt_payment_method_details_link",
- "setup_attempt_payment_method_details_paypal",
- "setup_attempt_payment_method_details_sepa_debit",
- "setup_attempt_payment_method_details_sofort",
- "setup_attempt_payment_method_details_us_bank_account"
- ]
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_acss_debit": {
@@ -38759,7 +42393,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_au_becs_debit": {
@@ -38770,7 +42404,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AuBecsDebit",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_bacs_debit": {
@@ -38781,7 +42415,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebit",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_bancontact": {
@@ -38887,18 +42521,7 @@
],
"x-stripeResource": {
"class_name": "Bancontact",
- "in_class": "setup_attempt_payment_method_details"
- }
- },
- "setup_attempt_payment_method_details_blik": {
- "description": "",
- "properties": {},
- "title": "setup_attempt_payment_method_details_blik",
- "type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_boleto": {
@@ -38909,7 +42532,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Boleto",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_card": {
@@ -38953,7 +42576,7 @@
"type": "integer"
},
"fingerprint": {
- "description": "Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.\n\n*Starting May 1, 2021, card fingerprint in India for Connect will change to allow two fingerprints for the same card --- one for India and one for the rest of the world.*",
+ "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.*",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -39028,10 +42651,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "setup_attempt_payment_method_details",
- "inner_classes": [
- "setup_attempt_payment_method_details_card_wallet"
- ]
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_card_present": {
@@ -39068,7 +42688,7 @@
],
"x-stripeResource": {
"class_name": "CardPresent",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_card_wallet": {
@@ -39101,7 +42721,7 @@
],
"x-stripeResource": {
"class_name": "Wallet",
- "in_class": "setup_attempt_payment_method_details_card"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_cashapp": {
@@ -39112,14 +42732,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Cashapp",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_ideal": {
"description": "",
"properties": {
"bank": {
- "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
+ "description": "The customer's bank. Can be one of `abn_amro`, `asn_bank`, `bunq`, `handelsbanken`, `ing`, `knab`, `moneyou`, `n26`, `rabobank`, `regiobank`, `revolut`, `sns_bank`, `triodos_bank`, `van_lanschot`, or `yoursafe`.",
"enum": [
"abn_amro",
"asn_bank",
@@ -39128,6 +42748,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -39151,6 +42772,7 @@
"INGBNL2A",
"KNABNL2H",
"MOYONL21",
+ "NTSBDEB1",
"RABONL2U",
"RBRBNL21",
"REVOIE23",
@@ -39230,7 +42852,7 @@
],
"x-stripeResource": {
"class_name": "Ideal",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_klarna": {
@@ -39241,7 +42863,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Klarna",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_link": {
@@ -39252,7 +42874,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_paypal": {
@@ -39263,7 +42885,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_sepa_debit": {
@@ -39274,7 +42896,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_sofort": {
@@ -39380,7 +43002,7 @@
],
"x-stripeResource": {
"class_name": "Sofort",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_attempt_payment_method_details_us_bank_account": {
@@ -39391,11 +43013,11 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "setup_attempt_payment_method_details"
+ "in_package": ""
}
},
"setup_intent": {
- "description": "A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.\nFor example, you could 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 as soon as you're ready to collect your customer's payment credentials.\nDo not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.\nThe SetupIntent then transitions through multiple [statuses](https://stripe.com/docs/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](/guides/strong-customer-authentication) may need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) at the time of payment method collection\nin order to streamline later [off-session payments](https://stripe.com/docs/payments/setup-intents).\nIf the SetupIntent is used with a [Customer](https://stripe.com/docs/api#setup_intent_object-customer), upon success,\nit will automatically attach the resulting payment method to that Customer.\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 in order to prevent saving invalid or unoptimized payment methods.\n\nBy using SetupIntents, you ensure that your customers experience the minimum set of required friction,\neven as regulations change over time.\n\nRelated guide: [Setup Intents API](https://stripe.com/docs/payments/setup-intents)",
+ "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://stripe.com/docs/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](/guides/strong-customer-authentication) might need to be run through\n[Strong Customer Authentication](https://stripe.com/docs/strong-customer-authentication) during payment method collection\nto streamline later [off-session payments](https://stripe.com/docs/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://stripe.com/docs/payments/setup-intents)",
"properties": {
"application": {
"anyOf": [
@@ -39427,7 +43049,7 @@
"$ref": "#/components/schemas/payment_flows_automatic_payment_methods_setup_intent"
}
],
- "description": "Settings for automatic payment methods compatible with this Setup Intent",
+ "description": "Settings for dynamic payment methods compatible with this Setup Intent",
"nullable": true
},
"cancellation_reason": {
@@ -39618,13 +43240,22 @@
]
}
},
+ "payment_method_configuration_details": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_config_biz_payment_method_configuration_details"
+ }
+ ],
+ "description": "Information about the payment method configuration used for this Setup Intent.",
+ "nullable": true
+ },
"payment_method_options": {
"anyOf": [
{
"$ref": "#/components/schemas/setup_intent_payment_method_options"
}
],
- "description": "Payment-method-specific configuration for this SetupIntent.",
+ "description": "Payment method-specific configuration for this SetupIntent.",
"nullable": true
},
"payment_method_types": {
@@ -39710,6 +43341,7 @@
"next_action",
"on_behalf_of",
"payment_method",
+ "payment_method_configuration_details",
"payment_method_options",
"single_use_mandate"
],
@@ -39768,12 +43400,87 @@
"x-stripeResource": {
"class_name": "SetupIntent",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "setup_intent_next_action",
- "setup_intent_next_action_redirect_to_url",
- "setup_intent_payment_method_options"
- ]
+ "in_package": ""
+ }
+ },
+ "setup_intent.canceled": {
+ "description": "Occurs when a SetupIntent is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/setup_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "setup_intent.canceled"
+ }
+ },
+ "setup_intent.created": {
+ "description": "Occurs when a new SetupIntent is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/setup_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "setup_intent.created"
+ }
+ },
+ "setup_intent.requires_action": {
+ "description": "Occurs when a SetupIntent is in requires_action state.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/setup_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "setup_intent.requires_action"
+ }
+ },
+ "setup_intent.setup_failed": {
+ "description": "Occurs when a SetupIntent has failed the attempt to setup a payment method.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/setup_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "setup_intent.setup_failed"
+ }
+ },
+ "setup_intent.succeeded": {
+ "description": "Occurs when an SetupIntent has successfully setup a payment method.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/setup_intent"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "setup_intent.succeeded"
}
},
"setup_intent_next_action": {
@@ -39810,10 +43517,7 @@
],
"x-stripeResource": {
"class_name": "NextAction",
- "in_class": "setup_intent",
- "inner_classes": [
- "setup_intent_next_action_verify_with_microdeposits"
- ]
+ "in_package": ""
}
},
"setup_intent_next_action_redirect_to_url": {
@@ -39841,7 +43545,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "NextActionRedirectToUrl",
- "in_class": "setup_intent"
+ "in_package": ""
}
},
"setup_intent_next_action_verify_with_microdeposits": {
@@ -39877,7 +43581,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "VerifyWithMicrodeposits",
- "in_class": "setup_intent_next_action"
+ "in_package": ""
}
},
"setup_intent_payment_method_options": {
@@ -39886,9 +43590,6 @@
"acss_debit": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_acss_debit"
},
- "blik": {
- "$ref": "#/components/schemas/setup_intent_payment_method_options_blik"
- },
"card": {
"$ref": "#/components/schemas/setup_intent_payment_method_options_card"
},
@@ -39909,7 +43610,6 @@
"type": "object",
"x-expandableFields": [
"acss_debit",
- "blik",
"card",
"link",
"paypal",
@@ -39918,18 +43618,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodOptions",
- "in_class": "setup_intent",
- "inner_classes": [
- "setup_intent_payment_method_options_acss_debit",
- "setup_intent_payment_method_options_blik",
- "setup_intent_payment_method_options_card",
- "setup_intent_payment_method_options_link",
- "setup_intent_payment_method_options_mandate_options_blik",
- "setup_intent_payment_method_options_mandate_options_sepa_debit",
- "setup_intent_payment_method_options_paypal",
- "setup_intent_payment_method_options_sepa_debit",
- "setup_intent_payment_method_options_us_bank_account"
- ]
+ "in_package": ""
}
},
"setup_intent_payment_method_options_acss_debit": {
@@ -39968,27 +43657,7 @@
],
"x-stripeResource": {
"class_name": "AcssDebit",
- "in_class": "setup_intent_payment_method_options",
- "inner_classes": [
- "setup_intent_payment_method_options_mandate_options_acss_debit"
- ]
- }
- },
- "setup_intent_payment_method_options_blik": {
- "description": "",
- "properties": {
- "mandate_options": {
- "$ref": "#/components/schemas/setup_intent_payment_method_options_mandate_options_blik"
- }
- },
- "title": "setup_intent_payment_method_options_blik",
- "type": "object",
- "x-expandableFields": [
- "mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_card": {
@@ -40044,10 +43713,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "setup_intent_payment_method_options",
- "inner_classes": [
- "setup_intent_payment_method_options_card_mandate_options"
- ]
+ "in_package": ""
}
},
"setup_intent_payment_method_options_card_mandate_options": {
@@ -40136,14 +43802,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "setup_intent_payment_method_options_card"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_link": {
"description": "",
"properties": {
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -40157,7 +43823,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Link",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_mandate_options_acss_debit": {
@@ -40215,43 +43881,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "MandateOptions",
- "in_class": "setup_intent_payment_method_options_acss_debit"
- }
- },
- "setup_intent_payment_method_options_mandate_options_blik": {
- "description": "",
- "properties": {
- "expires_after": {
- "description": "Date at which the mandate expires.",
- "format": "unix-time",
- "nullable": true,
- "type": "integer"
- },
- "off_session": {
- "$ref": "#/components/schemas/mandate_options_off_session_details_blik"
- },
- "type": {
- "description": "Type of the mandate.",
- "enum": [
- "off_session",
- "on_session"
- ],
- "nullable": true,
- "type": "string"
- }
- },
- "required": [
- "expires_after",
- "type"
- ],
- "title": "setup_intent_payment_method_options_mandate_options_blik",
- "type": "object",
- "x-expandableFields": [
- "off_session"
- ],
- "x-stripeResource": {
- "class_name": "BlikMandateOptions",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_mandate_options_sepa_debit": {
@@ -40262,7 +43892,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebitMandateOptions",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_paypal": {
@@ -40283,7 +43913,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Paypal",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_sepa_debit": {
@@ -40300,7 +43930,7 @@
],
"x-stripeResource": {
"class_name": "SepaDebit",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_payment_method_options_us_bank_account": {
@@ -40327,7 +43957,7 @@
],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "setup_intent_payment_method_options"
+ "in_package": ""
}
},
"setup_intent_type_specific_payment_method_options_client": {
@@ -40538,12 +44168,7 @@
"x-stripeResource": {
"class_name": "ShippingRate",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "shipping_rate_currency_option",
- "shipping_rate_delivery_estimate",
- "shipping_rate_fixed_amount"
- ]
+ "in_package": ""
}
},
"shipping_rate_currency_option": {
@@ -40572,7 +44197,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrencyOption",
- "in_class": "shipping_rate"
+ "in_package": ""
}
},
"shipping_rate_delivery_estimate": {
@@ -40609,10 +44234,7 @@
],
"x-stripeResource": {
"class_name": "DeliveryEstimate",
- "in_class": "shipping_rate",
- "inner_classes": [
- "shipping_rate_delivery_estimate_bound"
- ]
+ "in_package": ""
}
},
"shipping_rate_delivery_estimate_bound": {
@@ -40643,7 +44265,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "DeliveryEstimateBound",
- "in_class": "shipping_rate_delivery_estimate"
+ "in_package": ""
}
},
"shipping_rate_fixed_amount": {
@@ -40676,7 +44298,23 @@
],
"x-stripeResource": {
"class_name": "FixedAmount",
- "in_class": "shipping_rate"
+ "in_package": ""
+ }
+ },
+ "sigma.scheduled_query_run.created": {
+ "description": "Occurs whenever a Sigma scheduled query run finishes.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/scheduled_query_run"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "sigma.scheduled_query_run.created"
}
},
"sigma_scheduled_query_run_error": {
@@ -40696,7 +44334,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "RunError",
- "in_class": "scheduled_query_run"
+ "in_package": ""
}
},
"source": {
@@ -40952,39 +44590,124 @@
"x-stripeResource": {
"class_name": "Source",
"in_package": "",
- "inner_classes": [
- "source_code_verification_flow",
- "source_order",
- "source_order_item",
- "source_owner",
- "source_receiver_flow",
- "source_redirect_flow",
- "source_type_ach_credit_transfer",
- "source_type_ach_debit",
- "source_type_acss_debit",
- "source_type_alipay",
- "source_type_au_becs_debit",
- "source_type_bancontact",
- "source_type_card",
- "source_type_card_present",
- "source_type_eps",
- "source_type_giropay",
- "source_type_ideal",
- "source_type_klarna",
- "source_type_multibanco",
- "source_type_p24",
- "source_type_sepa_credit_transfer",
- "source_type_sepa_debit",
- "source_type_sofort",
- "source_type_three_d_secure",
- "source_type_wechat"
- ],
"polymorphic_groups": [
"deleted_payment_source",
"payment_source"
]
}
},
+ "source.canceled": {
+ "description": "Occurs whenever a source is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.canceled"
+ }
+ },
+ "source.chargeable": {
+ "description": "Occurs whenever a source transitions to chargeable.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.chargeable"
+ }
+ },
+ "source.failed": {
+ "description": "Occurs whenever a source fails.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.failed"
+ }
+ },
+ "source.mandate_notification": {
+ "description": "Occurs whenever a source mandate notification method is set to manual.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source_mandate_notification"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.mandate_notification"
+ }
+ },
+ "source.refund_attributes_required": {
+ "description": "Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.refund_attributes_required"
+ }
+ },
+ "source.transaction.created": {
+ "description": "Occurs whenever a source transaction is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source_transaction"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.transaction.created"
+ }
+ },
+ "source.transaction.updated": {
+ "description": "Occurs whenever a source transaction is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/source_transaction"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "source.transaction.updated"
+ }
+ },
"source_code_verification_flow": {
"description": "",
"properties": {
@@ -41007,7 +44730,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CodeVerificationFlow",
- "in_class": "source"
+ "in_package": ""
}
},
"source_mandate_notification": {
@@ -41088,12 +44811,7 @@
],
"x-stripeResource": {
"class_name": "SourceMandateNotification",
- "in_package": "",
- "inner_classes": [
- "source_mandate_notification_acss_debit_data",
- "source_mandate_notification_bacs_debit_data",
- "source_mandate_notification_sepa_debit_data"
- ]
+ "in_package": ""
}
},
"source_mandate_notification_acss_debit_data": {
@@ -41110,7 +44828,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AcssDebitData",
- "in_class": "source_mandate_notification"
+ "in_package": ""
}
},
"source_mandate_notification_bacs_debit_data": {
@@ -41127,7 +44845,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BacsDebitData",
- "in_class": "source_mandate_notification"
+ "in_package": ""
}
},
"source_mandate_notification_sepa_debit_data": {
@@ -41154,7 +44872,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaDebitData",
- "in_class": "source_mandate_notification"
+ "in_package": ""
}
},
"source_order": {
@@ -41198,7 +44916,7 @@
],
"x-stripeResource": {
"class_name": "Order",
- "in_class": "source"
+ "in_package": ""
}
},
"source_order_item": {
@@ -41250,7 +44968,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "OrderItem",
- "in_class": "source"
+ "in_package": ""
}
},
"source_owner": {
@@ -41329,7 +45047,7 @@
],
"x-stripeResource": {
"class_name": "Owner",
- "in_class": "source"
+ "in_package": ""
}
},
"source_receiver_flow": {
@@ -41377,7 +45095,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ReceiverFlow",
- "in_class": "source"
+ "in_package": ""
}
},
"source_redirect_flow": {
@@ -41416,7 +45134,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "RedirectFlow",
- "in_class": "source"
+ "in_package": ""
}
},
"source_transaction": {
@@ -41523,14 +45241,7 @@
"x-stripeResource": {
"class_name": "SourceTransaction",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "source_transaction_ach_credit_transfer_data",
- "source_transaction_chf_credit_transfer_data",
- "source_transaction_gbp_credit_transfer_data",
- "source_transaction_paper_check_data",
- "source_transaction_sepa_credit_transfer_data"
- ]
+ "in_package": ""
}
},
"source_transaction_ach_credit_transfer_data": {
@@ -41562,7 +45273,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AchCreditTransferData",
- "in_class": "source_transaction"
+ "in_package": ""
}
},
"source_transaction_chf_credit_transfer_data": {
@@ -41599,7 +45310,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ChfCreditTransferData",
- "in_class": "source_transaction"
+ "in_package": ""
}
},
"source_transaction_gbp_credit_transfer_data": {
@@ -41646,7 +45357,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "GbpCreditTransferData",
- "in_class": "source_transaction"
+ "in_package": ""
}
},
"source_transaction_paper_check_data": {
@@ -41668,7 +45379,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PaperCheckData",
- "in_class": "source_transaction"
+ "in_package": ""
}
},
"source_transaction_sepa_credit_transfer_data": {
@@ -41695,7 +45406,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "SepaCreditTransferData",
- "in_class": "source_transaction"
+ "in_package": ""
}
},
"source_type_ach_credit_transfer": {
@@ -41735,8 +45446,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "AchCreditTransfer",
- "in_class": "source"
+ "class_name": "AchCreditTransfer"
}
},
"source_type_ach_debit": {
@@ -41768,8 +45478,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "AchDebit",
- "in_class": "source"
+ "class_name": "AchDebit"
}
},
"source_type_acss_debit": {
@@ -41817,8 +45526,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "AcssDebit",
- "in_class": "source"
+ "class_name": "AcssDebit"
}
},
"source_type_alipay": {
@@ -41838,8 +45546,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Alipay",
- "in_class": "source"
+ "class_name": "Alipay"
}
},
"source_type_au_becs_debit": {
@@ -41859,8 +45566,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_class": "source"
+ "class_name": "AuBecsDebit"
}
},
"source_type_bancontact": {
@@ -41892,8 +45598,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Bancontact",
- "in_class": "source"
+ "class_name": "Bancontact"
}
},
"source_type_card": {
@@ -41964,8 +45669,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Card",
- "in_class": "source"
+ "class_name": "Card"
}
},
"source_type_card_present": {
@@ -42064,8 +45768,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "CardPresent",
- "in_class": "source"
+ "class_name": "CardPresent"
}
},
"source_type_eps": {
@@ -42081,8 +45784,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Eps",
- "in_class": "source"
+ "class_name": "Eps"
}
},
"source_type_giropay": {
@@ -42106,8 +45808,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Giropay",
- "in_class": "source"
+ "class_name": "Giropay"
}
},
"source_type_ideal": {
@@ -42131,8 +45832,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Ideal",
- "in_class": "source"
+ "class_name": "Ideal"
}
},
"source_type_klarna": {
@@ -42219,8 +45919,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Klarna",
- "in_class": "source"
+ "class_name": "Klarna"
}
},
"source_type_multibanco": {
@@ -42268,8 +45967,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Multibanco",
- "in_class": "source"
+ "class_name": "Multibanco"
}
},
"source_type_p24": {
@@ -42281,8 +45979,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "P24",
- "in_class": "source"
+ "class_name": "P24"
}
},
"source_type_sepa_credit_transfer": {
@@ -42334,8 +46031,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "SepaCreditTransfer",
- "in_class": "source"
+ "class_name": "SepaCreditTransfer"
}
},
"source_type_sepa_debit": {
@@ -42371,8 +46067,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "SepaDebit",
- "in_class": "source"
+ "class_name": "SepaDebit"
}
},
"source_type_sofort": {
@@ -42408,8 +46103,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Sofort",
- "in_class": "source"
+ "class_name": "Sofort"
}
},
"source_type_three_d_secure": {
@@ -42492,8 +46186,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "ThreeDSecure",
- "in_class": "source"
+ "class_name": "ThreeDSecure"
}
},
"source_type_wechat": {
@@ -42511,8 +46204,7 @@
},
"type": "object",
"x-stripeResource": {
- "class_name": "Wechat",
- "in_class": "source"
+ "class_name": "Wechat"
}
},
"subscription": {
@@ -42545,7 +46237,7 @@
}
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -43104,19 +46796,7 @@
"class_name": "Subscription",
"has_collection_class": true,
"has_search_result_class": true,
- "in_package": "",
- "inner_classes": [
- "cancellation_details",
- "subscription_automatic_tax",
- "subscription_billing_thresholds",
- "subscription_pending_invoice_item_interval",
- "subscription_transfer_data",
- "subscriptions_resource_pause_collection",
- "subscriptions_resource_payment_method_options",
- "subscriptions_resource_payment_settings",
- "subscriptions_resource_pending_update",
- "subscriptions_trials_resource_trial_settings"
- ]
+ "in_package": ""
}
},
"subscription_automatic_tax": {
@@ -43135,7 +46815,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscription_billing_thresholds": {
@@ -43161,7 +46841,31 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BillingThresholds",
- "in_class": "subscription"
+ "in_package": ""
+ }
+ },
+ "subscription_details_data": {
+ "description": "",
+ "properties": {
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will reflect the metadata of the subscription at the time of invoice creation. *Note: This attribute is populated only for invoices created on or after June 29, 2023.*",
+ "nullable": true,
+ "type": "object"
+ }
+ },
+ "required": [
+ "metadata"
+ ],
+ "title": "SubscriptionDetailsData",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "SubscriptionDetailsData",
+ "in_package": ""
}
},
"subscription_item": {
@@ -43291,10 +46995,7 @@
"x-stripeResource": {
"class_name": "SubscriptionItem",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "subscription_item_billing_thresholds"
- ]
+ "in_package": ""
}
},
"subscription_item_billing_thresholds": {
@@ -43314,7 +47015,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BillingThresholds",
- "in_class": "subscription_item"
+ "in_package": ""
}
},
"subscription_payment_method_options_card": {
@@ -43362,10 +47063,7 @@
],
"x-stripeResource": {
"class_name": "Card",
- "in_class": "subscriptions_resource_payment_method_options",
- "inner_classes": [
- "invoice_mandate_options_card"
- ]
+ "in_package": ""
}
},
"subscription_pending_invoice_item_interval": {
@@ -43395,7 +47093,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PendingInvoiceItemInterval",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscription_schedule": {
@@ -43666,15 +47364,119 @@
"x-stripeResource": {
"class_name": "SubscriptionSchedule",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "invoice_setting_subscription_schedule_setting",
- "subscription_schedule_add_invoice_item",
- "subscription_schedule_configuration_item",
- "subscription_schedule_current_phase",
- "subscription_schedule_phase_configuration",
- "subscription_schedules_resource_default_settings"
- ]
+ "in_package": ""
+ }
+ },
+ "subscription_schedule.aborted": {
+ "description": "Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.aborted"
+ }
+ },
+ "subscription_schedule.canceled": {
+ "description": "Occurs whenever a subscription schedule is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.canceled"
+ }
+ },
+ "subscription_schedule.completed": {
+ "description": "Occurs whenever a new subscription schedule is completed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.completed"
+ }
+ },
+ "subscription_schedule.created": {
+ "description": "Occurs whenever a new subscription schedule is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.created"
+ }
+ },
+ "subscription_schedule.expiring": {
+ "description": "Occurs 7 days before a subscription schedule will expire.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.expiring"
+ }
+ },
+ "subscription_schedule.released": {
+ "description": "Occurs whenever a new subscription schedule is released.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.released"
+ }
+ },
+ "subscription_schedule.updated": {
+ "description": "Occurs whenever a subscription schedule is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/subscription_schedule"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "subscription_schedule.updated"
}
},
"subscription_schedule_add_invoice_item": {
@@ -43731,7 +47533,7 @@
],
"x-stripeResource": {
"class_name": "AddInvoiceItem",
- "in_class": "subscription_schedule"
+ "in_package": ""
}
},
"subscription_schedule_configuration_item": {
@@ -43834,7 +47636,7 @@
],
"x-stripeResource": {
"class_name": "PhaseItem",
- "in_class": "subscription_schedule"
+ "in_package": ""
}
},
"subscription_schedule_current_phase": {
@@ -43860,7 +47662,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrentPhase",
- "in_class": "subscription_schedule"
+ "in_package": ""
}
},
"subscription_schedule_phase_configuration": {
@@ -43874,7 +47676,7 @@
"type": "array"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -43980,7 +47782,7 @@
"invoice_settings": {
"anyOf": [
{
- "$ref": "#/components/schemas/invoice_setting_phase_setting"
+ "$ref": "#/components/schemas/invoice_setting_subscription_schedule_phase_setting"
}
],
"description": "The invoice settings applicable during this phase.",
@@ -44088,18 +47890,14 @@
],
"x-stripeResource": {
"class_name": "Phase",
- "in_class": "subscription_schedule",
- "inner_classes": [
- "invoice_setting_phase_setting",
- "schedules_phase_automatic_tax"
- ]
+ "in_package": ""
}
},
"subscription_schedules_resource_default_settings": {
"description": "",
"properties": {
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account during this phase of the schedule.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -44220,10 +48018,7 @@
],
"x-stripeResource": {
"class_name": "DefaultSettings",
- "in_class": "subscription_schedule",
- "inner_classes": [
- "subscription_schedules_resource_default_settings_automatic_tax"
- ]
+ "in_package": ""
}
},
"subscription_schedules_resource_default_settings_automatic_tax": {
@@ -44242,14 +48037,14 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "AutomaticTax",
- "in_class": "subscription_schedules_resource_default_settings"
+ "in_package": ""
}
},
"subscription_transfer_data": {
"description": "",
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -44284,7 +48079,7 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscriptions_resource_pause_collection": {
@@ -44315,7 +48110,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PauseCollection",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscriptions_resource_payment_method_options": {
@@ -44396,10 +48191,7 @@
],
"x-stripeResource": {
"class_name": "PaymentMethodOptions",
- "in_class": "subscription",
- "inner_classes": [
- "subscription_payment_method_options_card"
- ]
+ "in_package": ""
}
},
"subscriptions_resource_payment_settings": {
@@ -44471,7 +48263,7 @@
],
"x-stripeResource": {
"class_name": "PaymentSettings",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscriptions_resource_pending_update": {
@@ -44522,7 +48314,7 @@
],
"x-stripeResource": {
"class_name": "PendingUpdate",
- "in_class": "subscription"
+ "in_package": ""
}
},
"subscriptions_trials_resource_end_behavior": {
@@ -44546,7 +48338,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EndBehavior",
- "in_class": "subscriptions_trials_resource_trial_settings"
+ "in_package": ""
}
},
"subscriptions_trials_resource_trial_settings": {
@@ -44566,10 +48358,7 @@
],
"x-stripeResource": {
"class_name": "TrialSettings",
- "in_class": "subscription",
- "inner_classes": [
- "subscriptions_trials_resource_end_behavior"
- ]
+ "in_package": ""
}
},
"tax.calculation": {
@@ -44730,11 +48519,7 @@
],
"x-stripeResource": {
"class_name": "Calculation",
- "in_package": "Tax",
- "inner_classes": [
- "tax_product_resource_customer_details",
- "tax_product_resource_tax_breakdown"
- ]
+ "in_package": "Tax"
}
},
"tax.calculation_line_item": {
@@ -44824,10 +48609,7 @@
"x-stripeResource": {
"class_name": "CalculationLineItem",
"has_collection_class": true,
- "in_package": "Tax",
- "inner_classes": [
- "tax_product_resource_line_item_tax_breakdown"
- ]
+ "in_package": "Tax"
}
},
"tax.settings": {
@@ -44902,12 +48684,23 @@
],
"x-stripeResource": {
"class_name": "Settings",
- "in_package": "Tax",
- "inner_classes": [
- "tax_product_resource_tax_settings_defaults",
- "tax_product_resource_tax_settings_head_office",
- "tax_product_resource_tax_settings_status_details"
- ]
+ "in_package": "Tax"
+ }
+ },
+ "tax.settings.updated": {
+ "description": "Occurs whenever tax settings is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax.settings"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "tax.settings.updated"
}
},
"tax.transaction": {
@@ -45092,10 +48885,7 @@
],
"x-stripeResource": {
"class_name": "Transaction",
- "in_package": "Tax",
- "inner_classes": [
- "tax_product_resource_tax_transaction_resource_reversal"
- ]
+ "in_package": "Tax"
}
},
"tax.transaction_line_item": {
@@ -45204,10 +48994,7 @@
"x-stripeResource": {
"class_name": "TransactionLineItem",
"has_collection_class": true,
- "in_package": "Tax",
- "inner_classes": [
- "tax_product_resource_tax_transaction_line_item_resource_reversal"
- ]
+ "in_package": "Tax"
}
},
"tax_code": {
@@ -45318,7 +49105,7 @@
}
},
"tax_id": {
- "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers).\nA customer's tax IDs are displayed on invoices and credit notes issued for the customer.\n\nRelated guide: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids)",
+ "description": "You can add one or multiple tax IDs to a [customer](https://stripe.com/docs/api/customers) or account.\nCustomer and account tax IDs get displayed on related invoices and credit notes.\n\nRelated guides: [Customer tax identification numbers](https://stripe.com/docs/billing/taxes/tax-ids), [Account tax IDs](https://stripe.com/docs/invoicing/connect#account-tax-ids)",
"properties": {
"country": {
"description": "Two-letter ISO code representing the country of the tax ID.",
@@ -45527,10 +49314,7 @@
"x-stripeResource": {
"class_name": "TaxId",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "tax_id_verification"
- ]
+ "in_package": ""
}
},
"tax_id_verification": {
@@ -45569,7 +49353,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Verification",
- "in_class": "tax_id"
+ "in_package": ""
}
},
"tax_product_resource_customer_details": {
@@ -45631,11 +49415,7 @@
],
"x-stripeResource": {
"class_name": "CustomerDetails",
- "in_class": "tax.calculation",
- "inner_classes": [
- "tax_product_resource_customer_details_resource_tax_id",
- "tax_product_resource_postal_address"
- ]
+ "in_package": ""
}
},
"tax_product_resource_customer_details_resource_tax_id": {
@@ -45729,7 +49509,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TaxID",
- "in_class": "tax_product_resource_customer_details"
+ "in_package": ""
}
},
"tax_product_resource_jurisdiction": {
@@ -45774,7 +49554,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Jurisdiction",
- "in_class": "tax_product_resource_line_item_tax_breakdown"
+ "in_package": ""
}
},
"tax_product_resource_line_item_tax_breakdown": {
@@ -45846,11 +49626,7 @@
],
"x-stripeResource": {
"class_name": "LineItemTaxBreakdown",
- "in_class": "tax.calculation_line_item",
- "inner_classes": [
- "tax_product_resource_jurisdiction",
- "tax_product_resource_line_item_tax_rate_details"
- ]
+ "in_package": ""
}
},
"tax_product_resource_line_item_tax_rate_details": {
@@ -45895,7 +49671,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LineItemTaxRateDetails",
- "in_class": "tax_product_resource_line_item_tax_breakdown"
+ "in_package": ""
}
},
"tax_product_resource_postal_address": {
@@ -45950,7 +49726,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PostalAddress",
- "in_class": "tax_product_resource_customer_details"
+ "in_package": ""
}
},
"tax_product_resource_tax_breakdown": {
@@ -46007,10 +49783,7 @@
],
"x-stripeResource": {
"class_name": "TaxBreakdown",
- "in_class": "tax.calculation",
- "inner_classes": [
- "tax_product_resource_tax_rate_details"
- ]
+ "in_package": ""
}
},
"tax_product_resource_tax_calculation_shipping_cost": {
@@ -46117,7 +49890,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TaxRateDetails",
- "in_class": "tax_product_resource_tax_breakdown"
+ "in_package": ""
}
},
"tax_product_resource_tax_settings_defaults": {
@@ -46149,7 +49922,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Defaults",
- "in_class": "tax.settings"
+ "in_package": ""
}
},
"tax_product_resource_tax_settings_head_office": {
@@ -46169,7 +49942,7 @@
],
"x-stripeResource": {
"class_name": "HeadOffice",
- "in_class": "tax.settings"
+ "in_package": ""
}
},
"tax_product_resource_tax_settings_status_details": {
@@ -46190,11 +49963,7 @@
],
"x-stripeResource": {
"class_name": "StatusDetails",
- "in_class": "tax.settings",
- "inner_classes": [
- "tax_product_resource_tax_settings_status_details_resource_active",
- "tax_product_resource_tax_settings_status_details_resource_pending"
- ]
+ "in_package": ""
}
},
"tax_product_resource_tax_settings_status_details_resource_active": {
@@ -46205,7 +49974,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Active",
- "in_class": "tax_product_resource_tax_settings_status_details"
+ "in_package": ""
}
},
"tax_product_resource_tax_settings_status_details_resource_pending": {
@@ -46229,7 +49998,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Pending",
- "in_class": "tax_product_resource_tax_settings_status_details"
+ "in_package": ""
}
},
"tax_product_resource_tax_transaction_line_item_resource_reversal": {
@@ -46249,7 +50018,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Reversal",
- "in_class": "tax.transaction_line_item"
+ "in_package": ""
}
},
"tax_product_resource_tax_transaction_resource_reversal": {
@@ -46270,7 +50039,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Reversal",
- "in_class": "tax.transaction"
+ "in_package": ""
}
},
"tax_product_resource_tax_transaction_shipping_cost": {
@@ -46356,7 +50125,7 @@
"type": "string"
},
"effective_percentage": {
- "description": "Actual/effective tax rate percentage out of 100. For tax calculations with automatic_tax[enabled]=true, this percentage does not include the statutory tax rate of non-taxable jurisdictions.",
+ "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.",
"nullable": true,
"type": "number"
},
@@ -46483,6 +50252,38 @@
"in_package": ""
}
},
+ "tax_rate.created": {
+ "description": "Occurs whenever a new tax rate is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax_rate"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "tax_rate.created"
+ }
+ },
+ "tax_rate.updated": {
+ "description": "Occurs whenever a tax rate is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/tax_rate"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "tax_rate.updated"
+ }
+ },
"terminal.configuration": {
"description": "A Configurations object represents how features should be configured for terminal readers.",
"properties": {
@@ -46510,6 +50311,9 @@
],
"type": "string"
},
+ "offline": {
+ "$ref": "#/components/schemas/terminal_configuration_configuration_resource_offline_config"
+ },
"tipping": {
"$ref": "#/components/schemas/terminal_configuration_configuration_resource_tipping"
},
@@ -46527,6 +50331,7 @@
"type": "object",
"x-expandableFields": [
"bbpos_wisepos_e",
+ "offline",
"tipping",
"verifone_p400"
],
@@ -46571,12 +50376,7 @@
"x-stripeResource": {
"class_name": "Configuration",
"has_collection_class": true,
- "in_package": "Terminal",
- "inner_classes": [
- "terminal_configuration_configuration_resource_currency_specific_config",
- "terminal_configuration_configuration_resource_device_type_specific_config",
- "terminal_configuration_configuration_resource_tipping"
- ]
+ "in_package": "Terminal"
}
},
"terminal.connection_token": {
@@ -46920,10 +50720,39 @@
"x-stripeResource": {
"class_name": "Reader",
"has_collection_class": true,
- "in_package": "Terminal",
- "inner_classes": [
- "terminal_reader_reader_resource_reader_action"
- ]
+ "in_package": "Terminal"
+ }
+ },
+ "terminal.reader.action_failed": {
+ "description": "Occurs whenever an action sent to a Terminal reader failed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/terminal.reader"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "terminal.reader.action_failed"
+ }
+ },
+ "terminal.reader.action_succeeded": {
+ "description": "Occurs whenever an action sent to a Terminal reader was successful.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/terminal.reader"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "terminal.reader.action_succeeded"
}
},
"terminal_configuration_configuration_resource_currency_specific_config": {
@@ -46955,7 +50784,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "CurrencySpecificConfig",
- "in_class": "terminal.configuration"
+ "in_package": ""
}
},
"terminal_configuration_configuration_resource_device_type_specific_config": {
@@ -46988,7 +50817,27 @@
],
"x-stripeResource": {
"class_name": "DeviceTypeSpecificConfig",
- "in_class": "terminal.configuration"
+ "in_package": ""
+ }
+ },
+ "terminal_configuration_configuration_resource_offline_config": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.",
+ "nullable": true,
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "TerminalConfigurationConfigurationResourceOfflineConfig",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "OfflineConfig",
+ "in_package": ""
}
},
"terminal_configuration_configuration_resource_tipping": {
@@ -47057,7 +50906,7 @@
],
"x-stripeResource": {
"class_name": "Tipping",
- "in_class": "terminal.configuration"
+ "in_package": ""
}
},
"terminal_reader_reader_resource_cart": {
@@ -47097,10 +50946,7 @@
],
"x-stripeResource": {
"class_name": "Cart",
- "in_class": "terminal_reader_reader_resource_set_reader_display_action",
- "inner_classes": [
- "terminal_reader_reader_resource_line_item"
- ]
+ "in_package": ""
}
},
"terminal_reader_reader_resource_line_item": {
@@ -47130,7 +50976,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LineItem",
- "in_class": "terminal_reader_reader_resource_cart"
+ "in_package": ""
}
},
"terminal_reader_reader_resource_process_config": {
@@ -47151,7 +50997,7 @@
],
"x-stripeResource": {
"class_name": "ProcessConfig",
- "in_class": "terminal_reader_reader_resource_process_payment_intent_action"
+ "in_package": ""
}
},
"terminal_reader_reader_resource_process_payment_intent_action": {
@@ -47191,11 +51037,18 @@
],
"x-stripeResource": {
"class_name": "ProcessPaymentIntentAction",
- "in_class": "terminal_reader_reader_resource_reader_action",
- "inner_classes": [
- "terminal_reader_reader_resource_process_config",
- "terminal_reader_reader_resource_tipping_config"
- ]
+ "in_package": ""
+ }
+ },
+ "terminal_reader_reader_resource_process_setup_config": {
+ "description": "Represents a per-setup override of a reader configuration",
+ "properties": {},
+ "title": "TerminalReaderReaderResourceProcessSetupConfig",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "ProcessSetupConfig",
+ "in_package": ""
}
},
"terminal_reader_reader_resource_process_setup_intent_action": {
@@ -47206,6 +51059,9 @@
"maxLength": 5000,
"type": "string"
},
+ "process_config": {
+ "$ref": "#/components/schemas/terminal_reader_reader_resource_process_setup_config"
+ },
"setup_intent": {
"anyOf": [
{
@@ -47232,11 +51088,12 @@
"title": "TerminalReaderReaderResourceProcessSetupIntentAction",
"type": "object",
"x-expandableFields": [
+ "process_config",
"setup_intent"
],
"x-stripeResource": {
"class_name": "ProcessSetupIntentAction",
- "in_class": "terminal_reader_reader_resource_reader_action"
+ "in_package": ""
}
},
"terminal_reader_reader_resource_reader_action": {
@@ -47303,13 +51160,7 @@
],
"x-stripeResource": {
"class_name": "ReaderAction",
- "in_class": "terminal.reader",
- "inner_classes": [
- "terminal_reader_reader_resource_process_payment_intent_action",
- "terminal_reader_reader_resource_process_setup_intent_action",
- "terminal_reader_reader_resource_refund_payment_action",
- "terminal_reader_reader_resource_set_reader_display_action"
- ]
+ "in_package": ""
}
},
"terminal_reader_reader_resource_refund_payment_action": {
@@ -47411,7 +51262,7 @@
],
"x-stripeResource": {
"class_name": "RefundPaymentAction",
- "in_class": "terminal_reader_reader_resource_reader_action"
+ "in_package": ""
}
},
"terminal_reader_reader_resource_set_reader_display_action": {
@@ -47445,10 +51296,7 @@
],
"x-stripeResource": {
"class_name": "SetReaderDisplayAction",
- "in_class": "terminal_reader_reader_resource_reader_action",
- "inner_classes": [
- "terminal_reader_reader_resource_cart"
- ]
+ "in_package": ""
}
},
"terminal_reader_reader_resource_tipping_config": {
@@ -47464,7 +51312,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TippingConfig",
- "in_class": "terminal_reader_reader_resource_process_payment_intent_action"
+ "in_package": ""
}
},
"test_helpers.test_clock": {
@@ -47574,6 +51422,86 @@
"in_package": "TestHelpers"
}
},
+ "test_helpers.test_clock.advancing": {
+ "description": "Occurs whenever a test clock starts advancing.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/test_helpers.test_clock"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "test_helpers.test_clock.advancing"
+ }
+ },
+ "test_helpers.test_clock.created": {
+ "description": "Occurs whenever a test clock is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/test_helpers.test_clock"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "test_helpers.test_clock.created"
+ }
+ },
+ "test_helpers.test_clock.deleted": {
+ "description": "Occurs whenever a test clock is deleted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/test_helpers.test_clock"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "test_helpers.test_clock.deleted"
+ }
+ },
+ "test_helpers.test_clock.internal_failure": {
+ "description": "Occurs whenever a test clock fails to advance its frozen time.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/test_helpers.test_clock"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "test_helpers.test_clock.internal_failure"
+ }
+ },
+ "test_helpers.test_clock.ready": {
+ "description": "Occurs whenever a test clock transitions to a ready status.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/test_helpers.test_clock"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "test_helpers.test_clock.ready"
+ }
+ },
"three_d_secure_details": {
"description": "",
"properties": {
@@ -47636,7 +51564,72 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ThreeDSecure",
- "in_class": "payment_method_details_card"
+ "in_package": ""
+ }
+ },
+ "three_d_secure_details_charge": {
+ "description": "",
+ "properties": {
+ "authentication_flow": {
+ "description": "For authenticated transactions: how the customer was authenticated by\nthe issuing bank.",
+ "enum": [
+ "challenge",
+ "frictionless"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "result": {
+ "description": "Indicates the outcome of 3D Secure authentication.",
+ "enum": [
+ "attempt_acknowledged",
+ "authenticated",
+ "exempted",
+ "failed",
+ "not_supported",
+ "processing_error"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "result_reason": {
+ "description": "Additional information about why 3D Secure succeeded or failed based\non the `result`.",
+ "enum": [
+ "abandoned",
+ "bypassed",
+ "canceled",
+ "card_not_enrolled",
+ "network_not_supported",
+ "protocol_error",
+ "rejected"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was used.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "authentication_flow",
+ "result",
+ "result_reason",
+ "version"
+ ],
+ "title": "three_d_secure_details_charge",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "ThreeDSecure",
+ "in_package": ""
}
},
"three_d_secure_usage": {
@@ -47655,11 +51648,11 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ThreeDSecureUsage",
- "in_class": "payment_method_card"
+ "in_package": ""
}
},
"token": {
- "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. You should use our\n[recommended payments integrations](https://stripe.com/docs/payments) to perform this process\nclient-side. This ensures that no sensitive card data touches your server,\nand allows your integration to operate in a PCI-compliant way.\n\nIf you cannot use client-side tokenization, you can also create tokens using\nthe API with either your publishable or secret API key. Keep in mind that if\nyour integration uses this method, you are responsible for any PCI compliance\nthat may be required, and you must keep your secret API key safe. Unlike with\nclient-side tokenization, your customer's information is not sent directly to\nStripe, so we cannot determine how it is handled or stored.\n\nTokens cannot be stored or used more than once. To store card or bank account\ninformation for later use, you can create [Customer](https://stripe.com/docs/api#customers)\nobjects or [Custom accounts](https://stripe.com/docs/api#external_accounts). Note that\n[Radar](https://stripe.com/docs/radar), our integrated solution for automatic fraud protection,\nperforms best with integrations that use client-side tokenization.",
+ "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 [Custom accounts](https://stripe.com/docs/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.",
"properties": {
"bank_account": {
"$ref": "#/components/schemas/bank_account"
@@ -47668,7 +51661,7 @@
"$ref": "#/components/schemas/card"
},
"client_ip": {
- "description": "IP address of the client that generated the token.",
+ "description": "IP address of the client that generates the token.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -47700,7 +51693,7 @@
"type": "string"
},
"used": {
- "description": "Whether this token has already been used (tokens can be used only once).",
+ "description": "Determines if you have already used this token (you can only use tokens once).",
"type": "boolean"
}
},
@@ -47929,15 +51922,95 @@
]
}
},
+ "topup.canceled": {
+ "description": "Occurs whenever a top-up is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/topup"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "topup.canceled"
+ }
+ },
+ "topup.created": {
+ "description": "Occurs whenever a top-up is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/topup"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "topup.created"
+ }
+ },
+ "topup.failed": {
+ "description": "Occurs whenever a top-up fails.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/topup"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "topup.failed"
+ }
+ },
+ "topup.reversed": {
+ "description": "Occurs whenever a top-up is reversed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/topup"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "topup.reversed"
+ }
+ },
+ "topup.succeeded": {
+ "description": "Occurs whenever a top-up succeeds.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/topup"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "topup.succeeded"
+ }
+ },
"transfer": {
"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)",
"properties": {
"amount": {
- "description": "Amount in %s to be transferred.",
+ "description": "Amount in cents (or local equivalent) to be transferred.",
"type": "integer"
},
"amount_reversed": {
- "description": "Amount in %s reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).",
+ "description": "Amount in cents (or local equivalent) reversed (can be less than the amount attribute on the transfer if a partial reversal was issued).",
"type": "integer"
},
"balance_transaction": {
@@ -48179,6 +52252,54 @@
]
}
},
+ "transfer.created": {
+ "description": "Occurs whenever a transfer is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "transfer.created"
+ }
+ },
+ "transfer.reversed": {
+ "description": "Occurs whenever a transfer is reversed, including partial reversals.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "transfer.reversed"
+ }
+ },
+ "transfer.updated": {
+ "description": "Occurs whenever a transfer's description or metadata is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "transfer.updated"
+ }
+ },
"transfer_data": {
"description": "",
"properties": {
@@ -48196,7 +52317,7 @@
"$ref": "#/components/schemas/account"
}
],
- "description": "The account (if any) the payment will be attributed to for tax\nreporting, and where funds from the payment will be transferred to upon\npayment success.",
+ "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.",
"x-expansionResources": {
"oneOf": [
{
@@ -48216,14 +52337,14 @@
],
"x-stripeResource": {
"class_name": "TransferData",
- "in_class": "payment_intent"
+ "in_package": ""
}
},
"transfer_reversal": {
"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: [Reversing transfers](https://stripe.com/docs/connect/separate-charges-and-transfers#reversing-transfers)",
"properties": {
"amount": {
- "description": "Amount, in %s.",
+ "description": "Amount, in cents (or local equivalent).",
"type": "integer"
},
"balance_transaction": {
@@ -48448,7 +52569,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PayoutSchedule",
- "in_class": "account"
+ "in_package": ""
}
},
"transform_quantity": {
@@ -48476,7 +52597,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TransformQuantity",
- "in_class": "price"
+ "in_package": ""
}
},
"transform_usage": {
@@ -48504,7 +52625,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "TransformUsage",
- "in_class": "plan"
+ "in_package": ""
}
},
"treasury.credit_reversal": {
@@ -48656,6 +52777,38 @@
"in_package": "Treasury"
}
},
+ "treasury.credit_reversal.created": {
+ "description": "Occurs whenever an CreditReversal is submitted and created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.credit_reversal"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.credit_reversal.created"
+ }
+ },
+ "treasury.credit_reversal.posted": {
+ "description": "Occurs whenever an CreditReversal post is posted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.credit_reversal"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.credit_reversal.posted"
+ }
+ },
"treasury.debit_reversal": {
"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.",
"properties": {
@@ -48814,10 +52967,55 @@
"x-stripeResource": {
"class_name": "DebitReversal",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_received_debits_resource_debit_reversal_linked_flows"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.debit_reversal.completed": {
+ "description": "Occurs whenever a DebitReversal is completed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.debit_reversal"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.debit_reversal.completed"
+ }
+ },
+ "treasury.debit_reversal.created": {
+ "description": "Occurs whenever a DebitReversal is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.debit_reversal"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.debit_reversal.created"
+ }
+ },
+ "treasury.debit_reversal.initial_credit_granted": {
+ "description": "Occurs whenever an initial credit is granted on a DebitReversal.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.debit_reversal"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.debit_reversal.initial_credit_granted"
}
},
"treasury.financial_account": {
@@ -49030,15 +53228,55 @@
"x-stripeResource": {
"class_name": "FinancialAccount",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_financial_accounts_resource_aba_toggle_settings",
- "treasury_financial_accounts_resource_ach_toggle_settings",
- "treasury_financial_accounts_resource_balance",
- "treasury_financial_accounts_resource_financial_address",
- "treasury_financial_accounts_resource_status_details",
- "treasury_financial_accounts_resource_toggle_settings"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.financial_account.closed": {
+ "description": "Occurs whenever the status of the FinancialAccount becomes closed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.financial_account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.financial_account.closed"
+ }
+ },
+ "treasury.financial_account.created": {
+ "description": "Occurs whenever a new FinancialAccount is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.financial_account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.financial_account.created"
+ }
+ },
+ "treasury.financial_account.features_status_updated": {
+ "description": "Occurs whenever the statuses of any features within an existing FinancialAccount are updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.financial_account"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.financial_account.features_status_updated"
}
},
"treasury.financial_account_features": {
@@ -49090,14 +53328,7 @@
"x-resourceId": "treasury.financial_account_features",
"x-stripeResource": {
"class_name": "FinancialAccountFeatures",
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_financial_accounts_resource_financial_addresses_features",
- "treasury_financial_accounts_resource_inbound_transfers",
- "treasury_financial_accounts_resource_outbound_payments",
- "treasury_financial_accounts_resource_outbound_transfers",
- "treasury_financial_accounts_resource_platform_restrictions"
- ]
+ "in_package": "Treasury"
}
},
"treasury.inbound_transfer": {
@@ -49317,13 +53548,71 @@
"x-stripeResource": {
"class_name": "InboundTransfer",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "inbound_transfers",
- "treasury_inbound_transfers_resource_failure_details",
- "treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows",
- "treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.inbound_transfer.canceled": {
+ "description": "Occurs whenever an InboundTransfer is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.inbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.inbound_transfer.canceled"
+ }
+ },
+ "treasury.inbound_transfer.created": {
+ "description": "Occurs whenever an InboundTransfer is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.inbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.inbound_transfer.created"
+ }
+ },
+ "treasury.inbound_transfer.failed": {
+ "description": "Occurs whenever an InboundTransfer has failed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.inbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.inbound_transfer.failed"
+ }
+ },
+ "treasury.inbound_transfer.succeeded": {
+ "description": "Occurs whenever an InboundTransfer has succeeded.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.inbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.inbound_transfer.succeeded"
}
},
"treasury.outbound_payment": {
@@ -49557,13 +53846,103 @@
"x-stripeResource": {
"class_name": "OutboundPayment",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "outbound_payments_payment_method_details",
- "treasury_outbound_payments_resource_outbound_payment_resource_end_user_details",
- "treasury_outbound_payments_resource_outbound_payment_resource_status_transitions",
- "treasury_outbound_payments_resource_returned_status"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.outbound_payment.canceled": {
+ "description": "Occurs whenever an OutboundPayment is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.canceled"
+ }
+ },
+ "treasury.outbound_payment.created": {
+ "description": "Occurs whenever a new OutboundPayment is successfully created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.created"
+ }
+ },
+ "treasury.outbound_payment.expected_arrival_date_updated": {
+ "description": "Occurs whenever the arrival date on an OutboundPayment updates.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.expected_arrival_date_updated"
+ }
+ },
+ "treasury.outbound_payment.failed": {
+ "description": "Occurs whenever an OutboundPayment fails.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.failed"
+ }
+ },
+ "treasury.outbound_payment.posted": {
+ "description": "Occurs whenever an OutboundPayment posts.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.posted"
+ }
+ },
+ "treasury.outbound_payment.returned": {
+ "description": "Occurs whenever an OutboundPayment was returned.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_payment"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_payment.returned"
}
},
"treasury.outbound_transfer": {
@@ -49773,12 +54152,103 @@
"x-stripeResource": {
"class_name": "OutboundTransfer",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "outbound_transfers_payment_method_details",
- "treasury_outbound_transfers_resource_returned_details",
- "treasury_outbound_transfers_resource_status_transitions"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.outbound_transfer.canceled": {
+ "description": "Occurs whenever an OutboundTransfer is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.canceled"
+ }
+ },
+ "treasury.outbound_transfer.created": {
+ "description": "Occurs whenever an OutboundTransfer is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.created"
+ }
+ },
+ "treasury.outbound_transfer.expected_arrival_date_updated": {
+ "description": "Occurs whenever the arrival date on an OutboundTransfer updates.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.expected_arrival_date_updated"
+ }
+ },
+ "treasury.outbound_transfer.failed": {
+ "description": "Occurs whenever an OutboundTransfer has failed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.failed"
+ }
+ },
+ "treasury.outbound_transfer.posted": {
+ "description": "Occurs whenever an OutboundTransfer is posted.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.posted"
+ }
+ },
+ "treasury.outbound_transfer.returned": {
+ "description": "Occurs whenever an OutboundTransfer is returned.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.outbound_transfer"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.outbound_transfer.returned"
}
},
"treasury.received_credit": {
@@ -49950,13 +54420,55 @@
"x-stripeResource": {
"class_name": "ReceivedCredit",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_received_credits_resource_linked_flows",
- "treasury_received_credits_resource_reversal_details",
- "treasury_received_credits_resource_status_transitions",
- "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.received_credit.created": {
+ "description": "Occurs whenever a received_credit is created as a result of funds being pushed by another account.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.received_credit"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.received_credit.created"
+ }
+ },
+ "treasury.received_credit.failed": {
+ "description": "Occurs whenever a received_credit transitions to failed state. Only applicable for check deposits.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.received_credit"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.received_credit.failed"
+ }
+ },
+ "treasury.received_credit.succeeded": {
+ "description": "Occurs whenever a received_credit transitions to succeeded state. Only applicable for check deposits.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.received_credit"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.received_credit.succeeded"
}
},
"treasury.received_debit": {
@@ -50126,12 +54638,23 @@
"x-stripeResource": {
"class_name": "ReceivedDebit",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_received_debits_resource_linked_flows",
- "treasury_received_debits_resource_reversal_details",
- "treasury_received_debits_resource_status_transitions"
- ]
+ "in_package": "Treasury"
+ }
+ },
+ "treasury.received_debit.created": {
+ "description": "Occurs whenever a received_debit is created as a result of funds being pulled by another account.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/treasury.received_debit"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "treasury.received_debit.created"
}
},
"treasury.transaction": {
@@ -50308,11 +54831,7 @@
"x-stripeResource": {
"class_name": "Transaction",
"has_collection_class": true,
- "in_package": "Treasury",
- "inner_classes": [
- "treasury_transactions_resource_abstract_transaction_resource_status_transitions",
- "treasury_transactions_resource_balance_impact"
- ]
+ "in_package": "Treasury"
}
},
"treasury.transaction_entry": {
@@ -50519,7 +55038,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Aba",
- "in_class": "treasury_financial_accounts_resource_financial_address"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_aba_toggle_settings": {
@@ -50558,7 +55077,7 @@
],
"x-stripeResource": {
"class_name": "AbaToggleSettings",
- "in_class": "treasury.financial_account"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_ach_toggle_settings": {
@@ -50597,7 +55116,7 @@
],
"x-stripeResource": {
"class_name": "AchToggleSettings",
- "in_class": "treasury.financial_account"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_balance": {
@@ -50635,7 +55154,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Balance",
- "in_class": "treasury.financial_account"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_closed_status_details": {
@@ -50662,7 +55181,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Closed",
- "in_class": "treasury_financial_accounts_resource_status_details"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_financial_address": {
@@ -50702,10 +55221,7 @@
],
"x-stripeResource": {
"class_name": "FinancialAddress",
- "in_class": "treasury.financial_account",
- "inner_classes": [
- "treasury_financial_accounts_resource_aba_record"
- ]
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_financial_addresses_features": {
@@ -50722,7 +55238,7 @@
],
"x-stripeResource": {
"class_name": "FinancialAddresses",
- "in_class": "treasury.financial_account_features"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_inbound_transfers": {
@@ -50739,7 +55255,7 @@
],
"x-stripeResource": {
"class_name": "InboundTransfers",
- "in_class": "treasury.financial_account_features"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_outbound_payments": {
@@ -50760,7 +55276,7 @@
],
"x-stripeResource": {
"class_name": "OutboundPayments",
- "in_class": "treasury.financial_account_features"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_outbound_transfers": {
@@ -50781,7 +55297,7 @@
],
"x-stripeResource": {
"class_name": "OutboundTransfers",
- "in_class": "treasury.financial_account_features"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_platform_restrictions": {
@@ -50815,7 +55331,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "PlatformRestriction",
- "in_class": "treasury.financial_account_features"
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_status_details": {
@@ -50841,10 +55357,7 @@
],
"x-stripeResource": {
"class_name": "StatusDetails",
- "in_class": "treasury.financial_account",
- "inner_classes": [
- "treasury_financial_accounts_resource_closed_status_details"
- ]
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_toggle_settings": {
@@ -50883,10 +55396,7 @@
],
"x-stripeResource": {
"class_name": "ToggleSettings",
- "in_class": "treasury.financial_account",
- "inner_classes": [
- "treasury_financial_accounts_resource_toggles_setting_status_details"
- ]
+ "in_package": ""
}
},
"treasury_financial_accounts_resource_toggles_setting_status_details": {
@@ -50937,7 +55447,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusDetails",
- "in_class": "treasury_financial_accounts_resource_toggle_settings"
+ "in_package": ""
}
},
"treasury_inbound_transfers_resource_failure_details": {
@@ -50971,7 +55481,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "FailureDetails",
- "in_class": "treasury.inbound_transfer"
+ "in_package": ""
}
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": {
@@ -50992,7 +55502,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LinkedFlows",
- "in_class": "treasury.inbound_transfer"
+ "in_package": ""
}
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": {
@@ -51026,7 +55536,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.inbound_transfer"
+ "in_package": ""
}
},
"treasury_outbound_payments_resource_outbound_payment_resource_end_user_details": {
@@ -51039,7 +55549,7 @@
"type": "string"
},
"present": {
- "description": "`true`` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.",
+ "description": "`true` if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, `false`.",
"type": "boolean"
}
},
@@ -51052,7 +55562,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "EndUserDetails",
- "in_class": "treasury.outbound_payment"
+ "in_package": ""
}
},
"treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": {
@@ -51094,7 +55604,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.outbound_payment"
+ "in_package": ""
}
},
"treasury_outbound_payments_resource_returned_status": {
@@ -51147,7 +55657,7 @@
],
"x-stripeResource": {
"class_name": "ReturnedDetails",
- "in_class": "treasury.outbound_payment"
+ "in_package": ""
}
},
"treasury_outbound_transfers_resource_returned_details": {
@@ -51200,7 +55710,7 @@
],
"x-stripeResource": {
"class_name": "ReturnedDetails",
- "in_class": "treasury.outbound_transfer"
+ "in_package": ""
}
},
"treasury_outbound_transfers_resource_status_transitions": {
@@ -51242,7 +55752,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.outbound_transfer"
+ "in_package": ""
}
},
"treasury_received_credits_resource_linked_flows": {
@@ -51303,10 +55813,7 @@
],
"x-stripeResource": {
"class_name": "LinkedFlows",
- "in_class": "treasury.received_credit",
- "inner_classes": [
- "treasury_received_credits_resource_source_flows_details"
- ]
+ "in_package": ""
}
},
"treasury_received_credits_resource_reversal_details": {
@@ -51340,7 +55847,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ReversalDetails",
- "in_class": "treasury.received_credit"
+ "in_package": ""
}
},
"treasury_received_credits_resource_source_flows_details": {
@@ -51379,7 +55886,7 @@
],
"x-stripeResource": {
"class_name": "SourceFlowDetails",
- "in_class": "treasury_received_credits_resource_linked_flows"
+ "in_package": ""
}
},
"treasury_received_credits_resource_status_transitions": {
@@ -51400,7 +55907,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.received_credit"
+ "in_package": ""
}
},
"treasury_received_debits_resource_debit_reversal_linked_flows": {
@@ -51421,7 +55928,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LinkedFlows",
- "in_class": "treasury.debit_reversal"
+ "in_package": ""
}
},
"treasury_received_debits_resource_linked_flows": {
@@ -51463,7 +55970,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "LinkedFlows",
- "in_class": "treasury.received_debit"
+ "in_package": ""
}
},
"treasury_received_debits_resource_reversal_details": {
@@ -51497,7 +56004,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "ReversalDetails",
- "in_class": "treasury.received_debit"
+ "in_package": ""
}
},
"treasury_received_debits_resource_status_transitions": {
@@ -51518,7 +56025,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.received_debit"
+ "in_package": ""
}
},
"treasury_shared_resource_billing_details": {
@@ -51552,7 +56059,7 @@
],
"x-stripeResource": {
"class_name": "BillingDetails",
- "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
+ "in_package": ""
}
},
"treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details": {
@@ -51605,12 +56112,7 @@
],
"x-stripeResource": {
"class_name": "InitiatingPaymentMethodDetails",
- "in_class": "treasury.received_credit",
- "inner_classes": [
- "received_payment_method_details_financial_account",
- "treasury_shared_resource_billing_details",
- "treasury_shared_resource_initiating_payment_method_details_us_bank_account"
- ]
+ "in_package": ""
}
},
"treasury_shared_resource_initiating_payment_method_details_us_bank_account": {
@@ -51645,7 +56147,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "UsBankAccount",
- "in_class": "treasury_shared_resource_initiating_payment_method_details_initiating_payment_method_details"
+ "in_package": ""
}
},
"treasury_transactions_resource_abstract_transaction_resource_status_transitions": {
@@ -51673,7 +56175,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "StatusTransitions",
- "in_class": "treasury.transaction"
+ "in_package": ""
}
},
"treasury_transactions_resource_balance_impact": {
@@ -51702,7 +56204,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "BalanceImpact",
- "in_class": "treasury.transaction"
+ "in_package": ""
}
},
"treasury_transactions_resource_flow_details": {
@@ -51798,7 +56300,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Networks",
- "in_class": "payment_method_us_bank_account"
+ "in_package": ""
}
},
"usage_record": {
@@ -51926,10 +56428,7 @@
"x-stripeResource": {
"class_name": "UsageRecordSummary",
"has_collection_class": true,
- "in_package": "",
- "inner_classes": [
- "period"
- ]
+ "in_package": ""
}
},
"verification_session_redaction": {
@@ -51952,7 +56451,7 @@
"x-expandableFields": [],
"x-stripeResource": {
"class_name": "Redaction",
- "in_class": "identity.verification_session"
+ "in_package": ""
}
},
"webhook_endpoint": {
@@ -52113,7 +56612,7 @@
"description": "The Stripe REST API. Please see https://stripe.com/docs/api for more details.",
"termsOfService": "https://stripe.com/us/terms/",
"title": "Stripe API",
- "version": "2022-11-15",
+ "version": "2023-10-16",
"x-stripeSpecFilename": "spec3.sdk"
},
"openapi": "3.0.0",
@@ -52225,9 +56724,7 @@
"description": "The type of account link the user is requesting. Possible values are `account_onboarding` or `account_update`.",
"enum": [
"account_onboarding",
- "account_update",
- "custom_account_update",
- "custom_account_verification"
+ "account_update"
],
"type": "string",
"x-stripeBypassValidation": true
@@ -52267,6 +56764,94 @@
}
}
},
+ "/v1/account_sessions": {
+ "post": {
+ "description": "Creates a AccountSession object that includes a single-use token that the platform can use on their front-end to grant client-side API access.
",
+ "operationId": "PostAccountSessions",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "components": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "account": {
+ "description": "The identifier of the account to create an Account Session for.",
+ "type": "string"
+ },
+ "components": {
+ "description": "Each key of the dictionary represents an embedded component, and each embedded component maps to its configuration (e.g. whether it has been enabled or not).",
+ "properties": {
+ "account_onboarding": {
+ "description": "Configuration for the account onboarding embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "base_config_param",
+ "type": "object"
+ }
+ },
+ "title": "account_session_create_components_param",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "account",
+ "components"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/account_session"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/accounts": {
"get": {
"description": "Returns a list of accounts connected to your platform via Connect. If you’re not a platform, the list is empty.
",
@@ -52486,6 +57071,25 @@
"maxLength": 4,
"type": "string"
},
+ "monthly_estimated_revenue": {
+ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.",
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "monthly_estimated_revenue_specs",
+ "type": "object"
+ },
"name": {
"description": "The customer-facing business name.",
"maxLength": 5000,
@@ -52558,7 +57162,6 @@
},
"url": {
"description": "The business's publicly available website.",
- "maxLength": 5000,
"type": "string"
}
},
@@ -53180,6 +57783,7 @@
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
+ "incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
@@ -53194,7 +57798,8 @@
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
- "unincorporated_non_profit"
+ "unincorporated_non_profit",
+ "unincorporated_partnership"
],
"type": "string",
"x-stripeBypassValidation": true
@@ -53581,12 +58186,12 @@
"type": "string"
},
"id_number": {
- "description": "The government-issued ID number of the individual, as appropriate for the representative’s country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -53789,9 +58394,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the account representative accepted the service agreement.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
}
},
"title": "settings_terms_of_service_specs",
@@ -53964,9 +58579,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the account representative accepted the service agreement.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
}
},
"title": "settings_terms_of_service_specs",
@@ -54048,7 +58673,7 @@
},
"/v1/accounts/{account}": {
"delete": {
- "description": "With Connect, you can delete accounts you manage.
\n\nAccounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
\n\nIf you want to delete your own account, use the account information tab in your account settings instead.
",
+ "description": "With Connect, you can delete accounts you manage.
\n\nAccounts created using test-mode keys can be deleted at any time. Standard accounts created using live-mode keys cannot be deleted. Custom or Express accounts created using live-mode keys can only be deleted once all balances are zero.
\n\nIf you want to delete your own account, use the account information tab in your account settings instead.
",
"operationId": "DeleteAccountsAccount",
"parameters": [
{
@@ -54165,7 +58790,7 @@
}
},
"post": {
- "description": "Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.
\n\nFor Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an Account Link\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express\nbelow.
\n\nTo update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.
",
+ "description": "Updates a connected account by setting the values of the parameters passed. Any parameters not provided are\nleft unchanged.
\n\nFor Custom accounts, you can update any information on the account. For other accounts, you can update all information until that\naccount has started to go through Connect Onboarding. Once you create an Account Link\nfor a Standard or Express account, some parameters can no longer be changed. These are marked as Custom Only or Custom and Express\nbelow.
\n\nTo update your own account, use the Dashboard. Refer to our\nConnect documentation to learn more about updating accounts.
",
"operationId": "PostAccountsAccount",
"parameters": [
{
@@ -54236,6 +58861,25 @@
"maxLength": 4,
"type": "string"
},
+ "monthly_estimated_revenue": {
+ "description": "An estimate of the monthly revenue of the business. Only accepted for accounts in Brazil and India.",
+ "properties": {
+ "amount": {
+ "description": "A non-negative integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "monthly_estimated_revenue_specs",
+ "type": "object"
+ },
"name": {
"description": "The customer-facing business name.",
"maxLength": 5000,
@@ -54308,7 +58952,6 @@
},
"url": {
"description": "The business's publicly available website.",
- "maxLength": 5000,
"type": "string"
}
},
@@ -54930,6 +59573,7 @@
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
+ "incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
@@ -54944,7 +59588,8 @@
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
- "unincorporated_non_profit"
+ "unincorporated_non_profit",
+ "unincorporated_partnership"
],
"type": "string",
"x-stripeBypassValidation": true
@@ -55326,12 +59971,12 @@
"type": "string"
},
"id_number": {
- "description": "The government-issued ID number of the individual, as appropriate for the representative’s country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -55534,9 +60179,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the account representative accepted the service agreement.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
}
},
"title": "settings_terms_of_service_specs",
@@ -55709,9 +60364,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the account representative accepted the service agreement.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
}
},
"title": "settings_terms_of_service_specs",
@@ -55962,7 +60627,7 @@
}
},
"post": {
- "description": "Updates an existing Account Capability.
",
+ "description": "Updates an existing Account Capability. Request or remove a capability by updating its requested parameter.
",
"operationId": "PostAccountsAccountCapabilitiesCapability",
"parameters": [
{
@@ -56006,7 +60671,7 @@
"type": "array"
},
"requested": {
- "description": "Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.",
+ "description": "To request a new capability for an account, pass true. There can be a delay before the requested capability becomes active. If the capability has any activation requirements, the response includes them in the `requirements` arrays.\n\nIf a capability isn't permanent, you can remove it from the account by passing false. Most capabilities are permanent after they've been requested. Attempting to remove a permanent capability returns an error.",
"type": "boolean"
}
},
@@ -56090,6 +60755,25 @@
},
"style": "form"
},
+ {
+ "description": "Filter external accounts according to a particular object type.",
+ "in": "query",
+ "name": "object",
+ "required": false,
+ "schema": {
+ "enum": [
+ "bank_account",
+ "card"
+ ],
+ "maxLength": 5000,
+ "type": "string",
+ "x-stripeBypassValidation": true,
+ "x-stripeParam": {
+ "class_name": "object_type"
+ }
+ },
+ "style": "form"
+ },
{
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
"in": "query",
@@ -56730,6 +61414,10 @@
"description": "A filter on the list of people returned based on whether these people are executives of the account's company.",
"type": "boolean"
},
+ "legal_guardian": {
+ "description": "A filter on the list of people returned based on whether these people are legal guardians of the account's representative.",
+ "type": "boolean"
+ },
"owner": {
"description": "A filter on the list of people returned based on whether these people are owners of the account's company.",
"type": "boolean"
@@ -56846,6 +61534,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "additional_tos_acceptances": {
+ "explode": true,
+ "style": "deepObject"
+ },
"address": {
"explode": true,
"style": "deepObject"
@@ -56894,6 +61586,44 @@
"schema": {
"additionalProperties": false,
"properties": {
+ "additional_tos_acceptances": {
+ "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "properties": {
+ "account": {
+ "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
+ "properties": {
+ "date": {
+ "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "ip": {
+ "description": "The IP address from which the account representative accepted the service agreement.",
+ "type": "string"
+ },
+ "user_agent": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ }
+ },
+ "title": "settings_terms_of_service_specs",
+ "type": "object"
+ }
+ },
+ "title": "person_additional_tos_acceptances_specs",
+ "type": "object"
+ },
"address": {
"description": "The person's address.",
"properties": {
@@ -57058,8 +61788,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57073,8 +61813,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57088,8 +61838,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57151,12 +61911,12 @@
"type": "string"
},
"id_number": {
- "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -57264,6 +62024,10 @@
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
"type": "boolean"
},
+ "legal_guardian": {
+ "description": "Whether the person is the legal guardian of the account's representative.",
+ "type": "boolean"
+ },
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
"type": "boolean"
@@ -57538,6 +62302,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "additional_tos_acceptances": {
+ "explode": true,
+ "style": "deepObject"
+ },
"address": {
"explode": true,
"style": "deepObject"
@@ -57586,6 +62354,44 @@
"schema": {
"additionalProperties": false,
"properties": {
+ "additional_tos_acceptances": {
+ "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "properties": {
+ "account": {
+ "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
+ "properties": {
+ "date": {
+ "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "ip": {
+ "description": "The IP address from which the account representative accepted the service agreement.",
+ "type": "string"
+ },
+ "user_agent": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ }
+ },
+ "title": "settings_terms_of_service_specs",
+ "type": "object"
+ }
+ },
+ "title": "person_additional_tos_acceptances_specs",
+ "type": "object"
+ },
"address": {
"description": "The person's address.",
"properties": {
@@ -57750,8 +62556,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57765,8 +62581,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57780,8 +62606,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -57843,12 +62679,12 @@
"type": "string"
},
"id_number": {
- "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -57956,6 +62792,10 @@
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
"type": "boolean"
},
+ "legal_guardian": {
+ "description": "Whether the person is the legal guardian of the account's representative.",
+ "type": "boolean"
+ },
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
"type": "boolean"
@@ -59592,43 +64432,6 @@
"description": "Returns a list of transactions that have contributed to the Stripe account balance (e.g., charges, transfers, and so forth). The transactions are returned in sorted order, with the most recent transactions appearing first.
\n\nNote that this endpoint was previously called “Balance history” and used the path /v1/balance/history.
",
"operationId": "GetBalanceTransactions",
"parameters": [
- {
- "description": "This parameter is deprecated and we recommend listing by created and filtering in memory instead.",
- "explode": true,
- "in": "query",
- "name": "available_on",
- "required": false,
- "schema": {
- "anyOf": [
- {
- "properties": {
- "gt": {
- "description": "Minimum value to filter by (exclusive)",
- "type": "integer"
- },
- "gte": {
- "description": "Minimum value to filter by (inclusive)",
- "type": "integer"
- },
- "lt": {
- "description": "Maximum value to filter by (exclusive)",
- "type": "integer"
- },
- "lte": {
- "description": "Maximum value to filter by (inclusive)",
- "type": "integer"
- }
- },
- "title": "range_query_specs",
- "type": "object"
- },
- {
- "type": "integer"
- }
- ]
- },
- "style": "deepObject"
- },
{
"explode": true,
"in": "query",
@@ -59745,7 +64548,7 @@
"style": "form"
},
{
- "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `payment`, `payment_failure_refund`, `payment_refund`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
+ "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_refund`, `payment_reversal`, `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`.",
"in": "query",
"name": "type",
"required": false,
@@ -60081,9 +64884,19 @@
"description": "The business information shown to customers in the portal.",
"properties": {
"headline": {
- "description": "The messaging shown to customers in the portal.",
- "maxLength": 60,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 60,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The messaging shown to customers in the portal."
},
"privacy_policy_url": {
"description": "A link to the business’s publicly available privacy policy.",
@@ -60539,9 +65352,19 @@
"description": "The business information shown to customers in the portal.",
"properties": {
"headline": {
- "description": "The messaging shown to customers in the portal.",
- "maxLength": 60,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 60,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The messaging shown to customers in the portal."
},
"privacy_policy_url": {
"anyOf": [
@@ -60978,6 +65801,39 @@
"subscription_cancel": {
"description": "Configuration when `flow_data.type=subscription_cancel`.",
"properties": {
+ "retention": {
+ "description": "Specify a retention strategy to be used in the cancellation flow.",
+ "properties": {
+ "coupon_offer": {
+ "description": "Configuration when `retention.type=coupon_offer`.",
+ "properties": {
+ "coupon": {
+ "description": "The ID of the coupon to be offered.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "coupon"
+ ],
+ "title": "coupon_offer_param",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of retention strategy to use with the customer.",
+ "enum": [
+ "coupon_offer"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "coupon_offer",
+ "type"
+ ],
+ "title": "retention_param",
+ "type": "object"
+ },
"subscription": {
"description": "The ID of the subscription to be canceled.",
"maxLength": 5000,
@@ -61086,7 +65942,7 @@
"type": "object"
},
"locale": {
- "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.",
+ "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.",
"enum": [
"auto",
"bg",
@@ -62629,10 +67485,6 @@
"explode": true,
"style": "deepObject"
},
- "shipping_rates": {
- "explode": true,
- "style": "deepObject"
- },
"subscription_data": {
"explode": true,
"style": "deepObject"
@@ -62861,8 +67713,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -62886,8 +67738,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -62905,13 +67757,38 @@
}
],
"description": "Custom text that should be displayed alongside the payment confirmation button."
+ },
+ "terms_of_service_acceptance": {
+ "anyOf": [
+ {
+ "properties": {
+ "message": {
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
+ "type": "string"
+ }
+ },
+ "required": [
+ "message"
+ ],
+ "title": "custom_text_position_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text."
}
},
"title": "custom_text_param",
"type": "object"
},
"customer": {
- "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `payment` or `subscription` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
+ "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recent card\npayment method will be used to prefill the email, name, card details, and billing address\non the Checkout page. In `subscription` mode, the customer’s [default payment method](https://stripe.com/docs/api/customers/update#update_customer-invoice_settings-default_payment_method)\nwill be used if it’s a card, and otherwise the most recent card will be used. A valid billing address, billing name and billing email are required on the payment method for Checkout to prefill the customer's card details.\n\nIf the Customer already has a valid [email](https://stripe.com/docs/api/customers/object#customer_object-email) set, the email will be prefilled and not editable in Checkout.\nIf the Customer does not have a valid `email`, Checkout will set the email entered during the session on the Customer.\n\nIf blank for Checkout Sessions in `subscription` mode or with `customer_creation` set as `always` in `payment` mode, Checkout will create a new Customer object based on information provided during the payment flow.\n\nYou can set [`payment_intent_data.setup_future_usage`](https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-payment_intent_data-setup_future_usage) to have Checkout automatically attach the payment method to the Customer you pass in for future reuse.",
"maxLength": 5000,
"type": "string"
},
@@ -63475,7 +68352,7 @@
"type": "object"
},
"transfer_group": {
- "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/payments/connected-accounts) for details.",
+ "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.",
"type": "string"
}
},
@@ -63490,6 +68367,11 @@
],
"type": "string"
},
+ "payment_method_configuration": {
+ "description": "The ID of the payment method configuration to use with this Checkout session.",
+ "maxLength": 100,
+ "type": "string"
+ },
"payment_method_options": {
"description": "Payment-method-specific configuration.",
"properties": {
@@ -63778,7 +68660,7 @@
"type": "array"
},
"type": {
- "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding. Permitted values include: `us_bank_account`, `eu_bank_account`, `id_bank_account`, `gb_bank_account`, `jp_bank_account`, `mx_bank_account`, `eu_bank_transfer`, `gb_bank_transfer`, `id_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.",
+ "description": "The list of bank transfer types that this PaymentIntent is allowed to use for funding.",
"enum": [
"eu_bank_transfer",
"gb_bank_transfer",
@@ -64104,6 +68986,17 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"title": "linked_account_options_param",
@@ -64222,6 +69115,19 @@
"title": "phone_number_collection_params",
"type": "object"
},
+ "redirect_on_completion": {
+ "description": "This parameter applies to `ui_mode: embedded`. By default, Stripe will always redirect to your return_url after a successful confirmation. If you set `redirect_on_completion: 'if_required'`, then we will only redirect if your user chooses a redirect-based payment method.",
+ "enum": [
+ "always",
+ "if_required",
+ "never"
+ ],
+ "type": "string"
+ },
+ "return_url": {
+ "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the\npayment method's app or site. This parameter is required if ui_mode is `embedded`\nand redirect-based payment methods are enabled on the session.",
+ "type": "string"
+ },
"setup_intent_data": {
"description": "A subset of parameters to be passed to SetupIntent creation for Checkout Sessions in `setup` mode.",
"properties": {
@@ -64502,7 +69408,7 @@
"type": "object"
},
"shipping_options": {
- "description": "The shipping rate options to apply to this Session.",
+ "description": "The shipping rate options to apply to this Session. Up to a maximum of 5.",
"items": {
"properties": {
"shipping_rate": {
@@ -64662,13 +69568,6 @@
},
"type": "array"
},
- "shipping_rates": {
- "description": "[Deprecated] The shipping rate to apply to this Session. Only up to one may be specified.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"submit_type": {
"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, but not Checkout Sessions\nin `subscription` or `setup` mode.",
"enum": [
@@ -64683,7 +69582,7 @@
"description": "A subset of parameters to be passed to subscription creation for Checkout Sessions in `subscription` mode.",
"properties": {
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. To use an application fee percent, the request must be made on behalf of another account, using the `Stripe-Account` header or an OAuth key. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"billing_cycle_anchor": {
@@ -64691,11 +69590,6 @@
"format": "unix-time",
"type": "integer"
},
- "coupon": {
- "description": "The ID of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.",
- "maxLength": 5000,
- "type": "string"
- },
"default_tax_rates": {
"description": "The tax rates that will apply to any subscription item that does not have\n`tax_rates` set. Invoices created will have their `default_tax_rates` populated\nfrom the subscription.",
"items": {
@@ -64705,7 +69599,7 @@
"type": "array"
},
"description": {
- "description": "The subscription's description, meant to be displayable to the customer.\nUse this field to optionally store an explanation of the subscription\nfor rendering in Stripe hosted surfaces.",
+ "description": "The subscription's description, meant to be displayable to the customer.\nUse this field to optionally store an explanation of the subscription\nfor rendering in the [customer portal](https://stripe.com/docs/customer-management).",
"maxLength": 500,
"type": "string"
},
@@ -64732,7 +69626,7 @@
"description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.",
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -64751,10 +69645,6 @@
"format": "unix-time",
"type": "integer"
},
- "trial_from_plan": {
- "description": "Indicates if a plan’s `trial_period_days` should be applied to the subscription. Setting `trial_end` on `subscription_data` is preferred. Defaults to `false`.",
- "type": "boolean"
- },
"trial_period_days": {
"description": "Integer representing the number of trial period days before the\ncustomer is charged for the first time. Has to be at least 1.",
"type": "integer"
@@ -64810,16 +69700,22 @@
],
"title": "tax_id_collection_params",
"type": "object"
+ },
+ "ui_mode": {
+ "description": "`ui_mode` can be `hosted` or `embedded`. The default is `hosted`.",
+ "enum": [
+ "embedded",
+ "hosted"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
- "required": [
- "success_url"
- ],
"type": "object"
}
}
},
- "required": true
+ "required": false
},
"responses": {
"200": {
@@ -69574,7 +74470,6 @@
"blik",
"boleto",
"card",
- "card_present",
"cashapp",
"customer_balance",
"eps",
@@ -70595,7 +75490,7 @@
}
},
"post": {
- "description": "Creates a new TaxID object for a customer.
",
+ "description": "Creates a new tax_id object for a customer.
",
"operationId": "PostCustomersCustomerTaxIds",
"parameters": [
{
@@ -70744,7 +75639,7 @@
},
"/v1/customers/{customer}/tax_ids/{id}": {
"delete": {
- "description": "Deletes an existing TaxID object.
",
+ "description": "Deletes an existing tax_id object.
",
"operationId": "DeleteCustomersCustomerTaxIdsId",
"parameters": [
{
@@ -70804,7 +75699,7 @@
}
},
"get": {
- "description": "Retrieves the TaxID object with the given identifier.
",
+ "description": "Retrieves the tax_id object with the given identifier.
",
"operationId": "GetCustomersCustomerTaxIdsId",
"parameters": [
{
@@ -71459,6 +76354,11 @@
"maxLength": 5000,
"type": "string"
},
+ "nonce": {
+ "description": "A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.",
+ "maxLength": 5000,
+ "type": "string"
+ },
"verification_session": {
"description": "The ID of the Identity VerificationSession you'd like to access using the resulting ephemeral key",
"maxLength": 5000,
@@ -72089,7 +76989,7 @@
"style": "deepObject"
},
{
- "description": "Filter links by their expiration status. By default, all links are returned.",
+ "description": "Filter links by their expiration status. By default, Stripe returns all links.",
"in": "query",
"name": "expired",
"required": false,
@@ -72231,7 +77131,7 @@
"type": "array"
},
"expires_at": {
- "description": "A future timestamp after which the link will no longer be usable.",
+ "description": "The link isn't usable after this future timestamp.",
"format": "unix-time",
"type": "integer"
},
@@ -72471,7 +77371,7 @@
},
"/v1/files": {
"get": {
- "description": "Returns a list of the files that your account has access to. The files are returned sorted by creation date, with the most recently created files appearing first.
",
+ "description": "Returns a list of the files that your account has access to. Stripe sorts and returns the files by their creation dates, placing the most recently created files at the top.
",
"operationId": "GetFiles",
"parameters": [
{
@@ -72547,7 +77447,7 @@
"style": "form"
},
{
- "description": "The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.",
+ "description": "Filter queries by the file purpose. If you don't provide a purpose, the queries return unfiltered files.",
"in": "query",
"name": "purpose",
"required": false,
@@ -72660,7 +77560,7 @@
}
},
"post": {
- "description": "To upload a file to Stripe, you’ll need to send a request of type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.
\n\nAll of Stripe’s officially supported Client libraries should have support for sending multipart/form-data.
",
+ "description": "To upload a file to Stripe, you need to send a request of type multipart/form-data. Include the file you want to upload in the request, and the parameters for creating a file.
\n\nAll of Stripe’s officially supported Client libraries support sending multipart/form-data.
",
"operationId": "PostFiles",
"requestBody": {
"content": {
@@ -72687,19 +77587,19 @@
"type": "array"
},
"file": {
- "description": "A file to upload. The file should follow the specifications of RFC 2388 (which defines file transfers for the `multipart/form-data` protocol).",
+ "description": "A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the `multipart/form-data` protocol.",
"format": "binary",
"type": "string"
},
"file_link_data": {
- "description": "Optional parameters to automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
+ "description": "Optional parameters that automatically create a [file link](https://stripe.com/docs/api#file_links) for the newly created file.",
"properties": {
"create": {
"description": "Set this to `true` to create a file link for the newly created file. Creating a link is only possible when the file's `purpose` is one of the following: `business_icon`, `business_logo`, `customer_signature`, `dispute_evidence`, `pci_document`, `tax_document_user_upload`, or `terminal_reader_splashscreen`.",
"type": "boolean"
},
"expires_at": {
- "description": "A future timestamp after which the link will no longer be usable.",
+ "description": "The link isn't available after this future timestamp.",
"format": "unix-time",
"type": "integer"
},
@@ -72786,7 +77686,7 @@
},
"/v1/files/{file}": {
"get": {
- "description": "Retrieves the details of an existing file object. Supply the unique file ID from a file, and Stripe will return the corresponding file object. To access file contents, see the File Upload Guide.
",
+ "description": "Retrieves the details of an existing file object. After you supply a unique file ID, Stripe returns the corresponding file object. Learn how to access file contents.
",
"operationId": "GetFilesFile",
"parameters": [
{
@@ -73405,6 +78305,10 @@
"permissions": {
"explode": true,
"style": "deepObject"
+ },
+ "prefetch": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
@@ -73479,6 +78383,18 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances",
+ "ownership"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -75633,6 +80549,10 @@
"explode": true,
"style": "deepObject"
},
+ "rendering": {
+ "explode": true,
+ "style": "deepObject"
+ },
"rendering_options": {
"explode": true,
"style": "deepObject"
@@ -75873,9 +80793,19 @@
"description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.",
"properties": {
"default_mandate": {
- "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.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set."
},
"payment_method_options": {
"description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
@@ -76109,6 +81039,17 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"title": "invoice_linked_account_options_param",
@@ -76198,6 +81139,38 @@
],
"type": "string"
},
+ "rendering": {
+ "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
+ "properties": {
+ "amount_tax_display": {
+ "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.",
+ "enum": [
+ "",
+ "exclude_tax",
+ "include_inclusive_tax"
+ ],
+ "type": "string"
+ },
+ "pdf": {
+ "description": "Invoice pdf rendering options",
+ "properties": {
+ "page_size": {
+ "description": "Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.\n If set to `auto`, invoice PDF page size defaults to `a4` for customers with\n Japanese locale and `letter` for customers with other locales.",
+ "enum": [
+ "a4",
+ "auto",
+ "letter"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "rendering_pdf_param",
+ "type": "object"
+ }
+ },
+ "title": "rendering_param",
+ "type": "object"
+ },
"rendering_options": {
"anyOf": [
{
@@ -76222,7 +81195,7 @@
"type": "string"
}
],
- "description": "Options for invoice PDF rendering."
+ "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering."
},
"shipping_cost": {
"description": "Settings for the cost of shipping for this invoice.",
@@ -76428,9 +81401,19 @@
"type": "string"
},
"phone": {
- "description": "Recipient phone (including extension)",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Recipient phone (including extension)"
}
},
"required": [
@@ -76680,7 +81663,7 @@
"style": "form"
},
{
- "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve.",
+ "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
"in": "query",
"name": "customer",
"required": false,
@@ -76691,7 +81674,7 @@
"style": "form"
},
{
- "description": "Details about the customer you want to invoice or overrides for an existing customer.",
+ "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
"explode": true,
"in": "query",
"name": "customer_details",
@@ -77199,7 +82182,7 @@
"style": "deepObject"
},
{
- "description": "The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
+ "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
"in": "query",
"name": "schedule",
"required": false,
@@ -77647,7 +82630,7 @@
"style": "form"
},
{
- "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve.",
+ "description": "The identifier of the customer whose upcoming invoice you'd like to retrieve. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
"in": "query",
"name": "customer",
"required": false,
@@ -77658,7 +82641,7 @@
"style": "form"
},
{
- "description": "Details about the customer you want to invoice or overrides for an existing customer.",
+ "description": "Details about the customer you want to invoice or overrides for an existing customer. If `automatic_tax` is enabled then one of `customer`, `customer_details`, `subscription`, or `schedule` must be set.",
"explode": true,
"in": "query",
"name": "customer_details",
@@ -78187,7 +83170,7 @@
"style": "form"
},
{
- "description": "The identifier of the unstarted schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
+ "description": "The identifier of the schedule whose upcoming invoice you'd like to retrieve. Cannot be used with subscription or subscription fields.",
"in": "query",
"name": "schedule",
"required": false,
@@ -78783,6 +83766,10 @@
"explode": true,
"style": "deepObject"
},
+ "default_source": {
+ "explode": true,
+ "style": "deepObject"
+ },
"default_tax_rates": {
"explode": true,
"style": "deepObject"
@@ -78811,6 +83798,10 @@
"explode": true,
"style": "deepObject"
},
+ "rendering": {
+ "explode": true,
+ "style": "deepObject"
+ },
"rendering_options": {
"explode": true,
"style": "deepObject"
@@ -78923,9 +83914,19 @@
"type": "string"
},
"default_source": {
- "description": "ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "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."
},
"default_tax_rates": {
"anyOf": [
@@ -79048,9 +84049,19 @@
"description": "Configuration settings for the PaymentIntent that is generated when the invoice is finalized.",
"properties": {
"default_mandate": {
- "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.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set."
},
"payment_method_options": {
"description": "Payment-method-specific configuration to provide to the invoice’s PaymentIntent.",
@@ -79284,6 +84295,17 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"title": "invoice_linked_account_options_param",
@@ -79364,6 +84386,38 @@
"title": "payment_settings",
"type": "object"
},
+ "rendering": {
+ "description": "The rendering-related settings that control how the invoice is displayed on customer-facing surfaces such as PDF and Hosted Invoice Page.",
+ "properties": {
+ "amount_tax_display": {
+ "description": "How line-item prices and amounts will be displayed with respect to tax on invoice PDFs. One of `exclude_tax` or `include_inclusive_tax`. `include_inclusive_tax` will include inclusive tax (and exclude exclusive tax) in invoice PDF amounts. `exclude_tax` will exclude all tax (inclusive and exclusive alike) from invoice PDF amounts.",
+ "enum": [
+ "",
+ "exclude_tax",
+ "include_inclusive_tax"
+ ],
+ "type": "string"
+ },
+ "pdf": {
+ "description": "Invoice pdf rendering options",
+ "properties": {
+ "page_size": {
+ "description": "Page size for invoice PDF. Can be set to `a4`, `letter`, or `auto`.\n If set to `auto`, invoice PDF page size defaults to `a4` for customers with\n Japanese locale and `letter` for customers with other locales.",
+ "enum": [
+ "a4",
+ "auto",
+ "letter"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "rendering_pdf_param",
+ "type": "object"
+ }
+ },
+ "title": "rendering_param",
+ "type": "object"
+ },
"rendering_options": {
"anyOf": [
{
@@ -79388,7 +84442,7 @@
"type": "string"
}
],
- "description": "Options for invoice PDF rendering."
+ "description": "This is a legacy field that will be removed soon. For details about `rendering_options`, refer to `rendering` instead. Options for invoice PDF rendering."
},
"shipping_cost": {
"anyOf": [
@@ -79605,9 +84659,19 @@
"type": "string"
},
"phone": {
- "description": "Recipient phone (including extension)",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Recipient phone (including extension)"
}
},
"required": [
@@ -79987,6 +85051,10 @@
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "mandate": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
@@ -80005,9 +85073,19 @@
"type": "boolean"
},
"mandate": {
- "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 payment_method param or the invoice's default_payment_method or default_source, if set.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the payment_method param or the invoice's default_payment_method or default_source, if set."
},
"off_session": {
"description": "Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to `true` (off-session).",
@@ -80548,7 +85626,7 @@
},
"/v1/issuing/authorizations/{authorization}/approve": {
"post": {
- "description": "Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nYou can also respond directly to the webhook request to approve an authorization (preferred). More details can be found here.
",
+ "description": "[Deprecated] Approves a pending Issuing Authorization object. This request should be made within the timeout window of the real-time authorization flow. \nThis method is deprecated. Instead, respond directly to the webhook request to approve an authorization.
",
"operationId": "PostIssuingAuthorizationsAuthorizationApprove",
"parameters": [
{
@@ -80640,7 +85718,7 @@
},
"/v1/issuing/authorizations/{authorization}/decline": {
"post": {
- "description": "Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nYou can also respond directly to the webhook request to decline an authorization (preferred). More details can be found here.
",
+ "description": "[Deprecated] Declines a pending Issuing Authorization object. This request should be made within the timeout window of the real time authorization flow.\nThis method is deprecated. Instead, respond directly to the webhook request to decline an authorization.
",
"operationId": "PostIssuingAuthorizationsAuthorizationDecline",
"parameters": [
{
@@ -81073,9 +86151,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
}
},
"title": "terms_acceptance_param",
@@ -81086,7 +86174,7 @@
"type": "object"
},
"dob": {
- "description": "The date of birth of this cardholder.",
+ "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
"properties": {
"day": {
"description": "The day of birth, between 1 and 31.",
@@ -82396,9 +87484,19 @@
"type": "string"
},
"user_agent": {
- "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the cardholder accepted the Authorized User Terms."
}
},
"title": "terms_acceptance_param",
@@ -82409,7 +87507,7 @@
"type": "object"
},
"dob": {
- "description": "The date of birth of this cardholder.",
+ "description": "The date of birth of this cardholder. Cardholders must be older than 13 years old.",
"properties": {
"day": {
"description": "The day of birth, between 1 and 31.",
@@ -86309,9 +91407,19 @@
"description": "Whether the cardholder was provided with a cancellation policy."
},
"cancellation_reason": {
- "description": "Reason for canceling the order.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Reason for canceling the order."
},
"expected_at": {
"anyOf": [
@@ -86329,14 +91437,34 @@
"description": "Date when the cardholder expected to receive the product."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -86445,9 +91573,19 @@
"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."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"original_transaction": {
"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.",
@@ -86486,9 +91624,19 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
}
},
"title": "fraudulent",
@@ -86522,9 +91670,19 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"received_at": {
"anyOf": [
@@ -86542,9 +91700,19 @@
"description": "Date when the product was received."
},
"return_description": {
- "description": "Description of the cardholder's attempt to return the product.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the cardholder's attempt to return the product."
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -86617,14 +91785,34 @@
"description": "Date when the cardholder expected to receive the product."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -86667,14 +91855,34 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -86746,14 +91954,34 @@
"description": "Date when order was canceled."
},
"cancellation_reason": {
- "description": "Reason for canceling the order.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Reason for canceling the order."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"received_at": {
"anyOf": [
@@ -87010,9 +92238,19 @@
"description": "Whether the cardholder was provided with a cancellation policy."
},
"cancellation_reason": {
- "description": "Reason for canceling the order.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Reason for canceling the order."
},
"expected_at": {
"anyOf": [
@@ -87030,14 +92268,34 @@
"description": "Date when the cardholder expected to receive the product."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -87146,9 +92404,19 @@
"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."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"original_transaction": {
"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.",
@@ -87187,9 +92455,19 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
}
},
"title": "fraudulent",
@@ -87223,9 +92501,19 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"received_at": {
"anyOf": [
@@ -87243,9 +92531,19 @@
"description": "Date when the product was received."
},
"return_description": {
- "description": "Description of the cardholder's attempt to return the product.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the cardholder's attempt to return the product."
},
"return_status": {
"description": "Result of cardholder's attempt to return the product.",
@@ -87318,14 +92616,34 @@
"description": "Date when the cardholder expected to receive the product."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -87368,14 +92686,34 @@
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Additional documentation supporting the dispute."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"product_description": {
- "description": "Description of the merchandise or service that was purchased.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Description of the merchandise or service that was purchased."
},
"product_type": {
"description": "Whether the product was a merchandise or service.",
@@ -87447,14 +92785,34 @@
"description": "Date when order was canceled."
},
"cancellation_reason": {
- "description": "Reason for canceling the order.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Reason for canceling the order."
},
"explanation": {
- "description": "Explanation of why the cardholder is disputing this transaction.",
- "maxLength": 1500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Explanation of why the cardholder is disputing this transaction."
},
"received_at": {
"anyOf": [
@@ -87632,27 +92990,16 @@
}
}
},
- "/v1/issuing/transactions": {
+ "/v1/issuing/tokens": {
"get": {
- "description": "Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
",
- "operationId": "GetIssuingTransactions",
+ "description": "Lists all Issuing Token objects for a given card.
",
+ "operationId": "GetIssuingTokens",
"parameters": [
{
- "description": "Only return transactions that belong to the given card.",
+ "description": "The Issuing card identifier to list tokens for.",
"in": "query",
"name": "card",
- "required": false,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "form"
- },
- {
- "description": "Only return transactions that belong to the given cardholder.",
- "in": "query",
- "name": "cardholder",
- "required": false,
+ "required": true,
"schema": {
"maxLength": 5000,
"type": "string"
@@ -87660,7 +93007,7 @@
"style": "form"
},
{
- "description": "Only return transactions that were created during the given date interval.",
+ "description": "Select Issuing tokens that were created during the given date interval.",
"explode": true,
"in": "query",
"name": "created",
@@ -87744,14 +93091,16 @@
"style": "form"
},
{
- "description": "Only return transactions that have the given type. One of `capture` or `refund`.",
+ "description": "Select Issuing tokens with the given status.",
"in": "query",
- "name": "type",
+ "name": "status",
"required": false,
"schema": {
"enum": [
- "capture",
- "refund"
+ "active",
+ "deleted",
+ "requested",
+ "suspended"
],
"type": "string"
},
@@ -87780,7 +93129,7 @@
"properties": {
"data": {
"items": {
- "$ref": "#/components/schemas/issuing.transaction"
+ "$ref": "#/components/schemas/issuing.token"
},
"type": "array"
},
@@ -87798,7 +93147,6 @@
"url": {
"description": "The URL where this list can be accessed.",
"maxLength": 5000,
- "pattern": "^/v1/issuing/transactions",
"type": "string"
}
},
@@ -87808,7 +93156,7 @@
"object",
"url"
],
- "title": "IssuingTransactionList",
+ "title": "IssuingNetworkTokenList",
"type": "object",
"x-expandableFields": [
"data"
@@ -87831,10 +93179,10 @@
}
}
},
- "/v1/issuing/transactions/{transaction}": {
+ "/v1/issuing/tokens/{token}": {
"get": {
- "description": "Retrieves an Issuing Transaction object.
",
- "operationId": "GetIssuingTransactionsTransaction",
+ "description": "Retrieves an Issuing Token object.
",
+ "operationId": "GetIssuingTokensToken",
"parameters": [
{
"description": "Specifies which fields in the response should be expanded.",
@@ -87853,7 +93201,7 @@
},
{
"in": "path",
- "name": "transaction",
+ "name": "token",
"required": true,
"schema": {
"maxLength": 5000,
@@ -87880,7 +93228,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/issuing.transaction"
+ "$ref": "#/components/schemas/issuing.token"
}
}
},
@@ -87899,12 +93247,12 @@
}
},
"post": {
- "description": "Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
",
- "operationId": "PostIssuingTransactionsTransaction",
+ "description": "Attempts to update the specified Issuing Token object to the status specified.
",
+ "operationId": "PostIssuingTokensToken",
"parameters": [
{
"in": "path",
- "name": "transaction",
+ "name": "token",
"required": true,
"schema": {
"maxLength": 5000,
@@ -87920,10 +93268,6 @@
"expand": {
"explode": true,
"style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
}
},
"schema": {
@@ -87937,24 +93281,182 @@
},
"type": "array"
},
- "metadata": {
- "anyOf": [
- {
- "additionalProperties": {
- "type": "string"
- },
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
+ "status": {
+ "description": "Specifies which status the token should be updated to.",
+ "enum": [
+ "active",
+ "deleted",
+ "suspended"
],
- "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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
+ "type": "string"
}
},
+ "required": [
+ "status"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.token"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/issuing/transactions": {
+ "get": {
+ "description": "Returns a list of Issuing Transaction objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
",
+ "operationId": "GetIssuingTransactions",
+ "parameters": [
+ {
+ "description": "Only return transactions that belong to the given card.",
+ "in": "query",
+ "name": "card",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Only return transactions that belong to the given cardholder.",
+ "in": "query",
+ "name": "cardholder",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Only return transactions that were created during the given date interval.",
+ "explode": true,
+ "in": "query",
+ "name": "created",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "properties": {
+ "gt": {
+ "description": "Minimum value to filter by (exclusive)",
+ "type": "integer"
+ },
+ "gte": {
+ "description": "Minimum value to filter by (inclusive)",
+ "type": "integer"
+ },
+ "lt": {
+ "description": "Maximum value to filter by (exclusive)",
+ "type": "integer"
+ },
+ "lte": {
+ "description": "Maximum value to filter by (inclusive)",
+ "type": "integer"
+ }
+ },
+ "title": "range_query_specs",
+ "type": "object"
+ },
+ {
+ "type": "integer"
+ }
+ ]
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Only return transactions that have the given type. One of `capture` or `refund`.",
+ "in": "query",
+ "name": "type",
+ "required": false,
+ "schema": {
+ "enum": [
+ "capture",
+ "refund"
+ ],
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
"type": "object"
}
}
@@ -87966,7 +93468,43 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/issuing.transaction"
+ "description": "",
+ "properties": {
+ "data": {
+ "items": {
+ "$ref": "#/components/schemas/issuing.transaction"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "pattern": "^/v1/issuing/transactions",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "IssuingTransactionList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
}
}
},
@@ -87985,10 +93523,10 @@
}
}
},
- "/v1/mandates/{mandate}": {
+ "/v1/issuing/transactions/{transaction}": {
"get": {
- "description": "Retrieves a Mandate object.
",
- "operationId": "GetMandatesMandate",
+ "description": "Retrieves an Issuing Transaction object.
",
+ "operationId": "GetIssuingTransactionsTransaction",
"parameters": [
{
"description": "Specifies which fields in the response should be expanded.",
@@ -88007,7 +93545,161 @@
},
{
"in": "path",
- "name": "mandate",
+ "name": "transaction",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.transaction"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Updates the specified Issuing Transaction object by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
",
+ "operationId": "PostIssuingTransactionsTransaction",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "transaction",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.transaction"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/mandates/{mandate}": {
+ "get": {
+ "description": "Retrieves a Mandate object.
",
+ "operationId": "GetMandatesMandate",
+ "parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "in": "path",
+ "name": "mandate",
"required": true,
"schema": {
"type": "string"
@@ -88058,7 +93750,7 @@
"operationId": "GetPaymentIntents",
"parameters": [
{
- "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.",
+ "description": "A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp or a dictionary with a number of different query options.",
"explode": true,
"in": "query",
"name": "created",
@@ -88095,7 +93787,7 @@
"style": "deepObject"
},
{
- "description": "Only return PaymentIntents for the customer specified by this customer ID.",
+ "description": "Only return PaymentIntents for the customer that this customer ID specifies.",
"in": "query",
"name": "customer",
"required": false,
@@ -88226,7 +93918,7 @@
}
},
"post": {
- "description": "Creates a PaymentIntent object.
\n\nAfter the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. You can read more about the different payment flows\navailable via the Payment Intents API here.
\n\nWhen confirm=true is used during creation, it is equivalent to creating\nand confirming the PaymentIntent in the same call. You may use any parameters\navailable in the confirm API when confirm=true\nis supplied.
",
+ "description": "Creates a PaymentIntent object.
\n\nAfter the PaymentIntent is created, attach a payment method and confirm\nto continue the payment. Learn more about the available payment flows\nwith the Payment Intents API.
\n\nWhen you use confirm=true during creation, it’s equivalent to creating\nand confirming the PaymentIntent in the same call. You can use any parameters\navailable in the confirm API when you supply\nconfirm=true.
",
"operationId": "PostPaymentIntents",
"requestBody": {
"content": {
@@ -88289,7 +93981,7 @@
"type": "integer"
},
"automatic_payment_methods": {
- "description": "When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters.",
+ "description": "When you enable this parameter, this PaymentIntent accepts payment methods that you enable in the Dashboard and that are compatible with this PaymentIntent's other parameters.",
"properties": {
"allow_redirects": {
"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.",
@@ -88320,7 +94012,7 @@
"type": "string"
},
"confirm": {
- "description": "Set to `true` to attempt to [confirm](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://stripe.com/docs/api/payment_intents/confirm) API may also be provided.",
+ "description": "Set to `true` to attempt to [confirm this PaymentIntent](https://stripe.com/docs/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, you can also provide the parameters available in the [Confirm API](https://stripe.com/docs/api/payment_intents/confirm).",
"type": "boolean"
},
"confirmation_method": {
@@ -88345,7 +94037,7 @@
"type": "string"
},
"error_on_requires_action": {
- "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
+ "description": "Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. Use this parameter for simpler integrations that don't handle customer actions, such as [saving cards without authentication](https://stripe.com/docs/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
"type": "boolean"
},
"expand": {
@@ -88357,69 +94049,79 @@
"type": "array"
},
"mandate": {
- "description": "ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
+ "description": "ID of the mandate that's used for this payment. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
"maxLength": 5000,
"type": "string"
},
"mandate_data": {
- "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm).",
- "properties": {
- "customer_acceptance": {
- "description": "This hash contains details about the customer acceptance of the Mandate.",
+ "anyOf": [
+ {
"properties": {
- "accepted_at": {
- "description": "The time at which the customer accepted the Mandate.",
- "format": "unix-time",
- "type": "integer"
- },
- "offline": {
- "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
- "properties": {},
- "title": "offline_param",
- "type": "object"
- },
- "online": {
- "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
+ "customer_acceptance": {
+ "description": "This hash contains details about the customer acceptance of the Mandate.",
"properties": {
- "ip_address": {
- "description": "The IP address from which the Mandate was accepted by the customer.",
- "type": "string"
+ "accepted_at": {
+ "description": "The time at which the customer accepted the Mandate.",
+ "format": "unix-time",
+ "type": "integer"
},
- "user_agent": {
- "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
+ "offline": {
+ "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
+ "properties": {},
+ "title": "offline_param",
+ "type": "object"
+ },
+ "online": {
+ "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
+ "properties": {
+ "ip_address": {
+ "description": "The IP address from which the Mandate was accepted by the customer.",
+ "type": "string"
+ },
+ "user_agent": {
+ "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "ip_address",
+ "user_agent"
+ ],
+ "title": "online_param",
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
+ "enum": [
+ "offline",
+ "online"
+ ],
"maxLength": 5000,
"type": "string"
}
},
"required": [
- "ip_address",
- "user_agent"
+ "type"
],
- "title": "online_param",
+ "title": "customer_acceptance_param",
"type": "object"
- },
- "type": {
- "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
- "enum": [
- "offline",
- "online"
- ],
- "maxLength": 5000,
- "type": "string"
}
},
"required": [
- "type"
+ "customer_acceptance"
],
- "title": "customer_acceptance_param",
+ "title": "secret_key_param",
"type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
}
- },
- "required": [
- "customer_acceptance"
],
- "title": "secret_key_param",
- "type": "object"
+ "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)."
},
"metadata": {
"additionalProperties": {
@@ -88442,17 +94144,22 @@
"type": "string"
}
],
- "description": "Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)."
+ "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-confirm)."
},
"on_behalf_of": {
- "description": "The Stripe account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "description": "The Stripe account ID that these funds are intended for. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"type": "string"
},
"payment_method": {
- "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.\n\nIf neither the `payment_method` parameter nor the `source` parameter are provided with `confirm=true`, `source` will be automatically populated with `customer.default_source` to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward.",
+ "description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.\n\nIf you don't provide the `payment_method` parameter or the `source` parameter with `confirm=true`, `source` automatically populates with `customer.default_source` to improve migration for users of the Charges API. We recommend that you explicitly provide the `payment_method` moving forward.",
"maxLength": 5000,
"type": "string"
},
+ "payment_method_configuration": {
+ "description": "The ID of the payment method configuration to use with this PaymentIntent.",
+ "maxLength": 100,
+ "type": "string"
+ },
"payment_method_data": {
"description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
"properties": {
@@ -88610,14 +94317,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -88772,6 +94499,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -89056,7 +94784,7 @@
"type": "object"
},
"payment_method_options": {
- "description": "Payment-method-specific configuration for this PaymentIntent.",
+ "description": "Payment method-specific configuration for this PaymentIntent.",
"properties": {
"acss_debit": {
"anyOf": [
@@ -89188,7 +94916,7 @@
"type": "string"
},
"reference": {
- "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
+ "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.",
"maxLength": 128,
"type": "string"
},
@@ -89544,6 +95272,38 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_extended_authorization": {
+ "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_multicapture": {
+ "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_overcapture": {
+ "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_three_d_secure": {
"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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
@@ -89615,6 +95375,14 @@
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
"type": "boolean"
},
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_incremental_authorization_support": {
"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.",
"type": "boolean"
@@ -89978,9 +95746,19 @@
{
"properties": {
"confirmation_number": {
- "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
- "maxLength": 11,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 11,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number."
},
"expires_after_days": {
"anyOf": [
@@ -90012,9 +95790,19 @@
"description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
},
"product_description": {
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
- "maxLength": 22,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 22,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
},
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
@@ -90049,7 +95837,7 @@
"type": "string"
},
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
},
@@ -90379,6 +96167,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -90406,6 +96205,15 @@
"title": "networks_options_param",
"type": "object"
},
+ "preferred_settlement_speed": {
+ "description": "Preferred transaction settlement speed",
+ "enum": [
+ "",
+ "fastest",
+ "standard"
+ ],
+ "type": "string"
+ },
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
"enum": [
@@ -90510,7 +96318,7 @@
"type": "object"
},
"payment_method_types": {
- "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to [\"card\"]. Use automatic_payment_methods to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
+ "description": "The list of payment method types (for example, a card) that this PaymentIntent can use. If you don't provide this, it defaults to [\"card\"]. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
"items": {
"maxLength": 5000,
"type": "string"
@@ -90518,7 +96326,7 @@
"type": "array"
},
"radar_options": {
- "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
+ "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).",
"properties": {
"session": {
"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.",
@@ -90526,11 +96334,11 @@
"type": "string"
}
},
- "title": "radar_options",
+ "title": "radar_options_with_hidden_options",
"type": "object"
},
"receipt_email": {
- "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).",
+ "description": "Email address to send the receipt to. If you specify `receipt_email` for a payment in live mode, you send a receipt regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
"type": "string"
},
"return_url": {
@@ -90614,17 +96422,17 @@
"type": "object"
},
"statement_descriptor": {
- "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. Must contain at least one letter, maximum 22 characters.",
+ "description": "For non-card charges, you can use this value as the complete description that appears on your customers’ statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 22,
"type": "string"
},
"statement_descriptor_suffix": {
- "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.",
+ "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. The concatenated descriptor must contain 1-22 characters.",
"maxLength": 22,
"type": "string"
},
"transfer_data": {
- "description": "The parameters used to automatically create a Transfer when the payment succeeds.\nFor more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "description": "The parameters that you can use to automatically create a Transfer after the payment succeeds.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.\nThe amount is capped at the total transaction amount and if no amount is set,\nthe full amount is transferred.\n\nIf you intend to collect a fee and you need a more robust reporting experience, using\n[application_fee_amount](https://stripe.com/docs/api/payment_intents/create#create_payment_intent-application_fee_amount)\nmight be a better fit for your integration.",
@@ -90642,7 +96450,7 @@
"type": "object"
},
"transfer_group": {
- "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/payments/connected-accounts) for details.",
+ "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).",
"type": "string"
},
"use_stripe_sdk": {
@@ -90819,11 +96627,11 @@
},
"/v1/payment_intents/{intent}": {
"get": {
- "description": "Retrieves the details of a PaymentIntent that has previously been created.
\n\nClient-side retrieval using a publishable key is allowed when the client_secret is provided in the query string.
\n\nWhen retrieved with a publishable key, only a subset of properties will be returned. Please refer to the payment intent object reference for more details.
",
+ "description": "Retrieves the details of a PaymentIntent that has previously been created.
\n\nYou can retrieve a PaymentIntent client-side using a publishable key when the client_secret is in the query string.
\n\nIf you retrieve a PaymentIntent with a publishable key, it only returns a subset of properties. Refer to the payment intent object reference for more details.
",
"operationId": "GetPaymentIntentsIntent",
"parameters": [
{
- "description": "The client secret of the PaymentIntent. Required if a publishable key is used to retrieve the source.",
+ "description": "The client secret of the PaymentIntent. We require it if you use a publishable key to retrieve the source.",
"in": "query",
"name": "client_secret",
"required": false,
@@ -90896,7 +96704,7 @@
}
},
"post": {
- "description": "Updates properties on a PaymentIntent object without confirming.
\n\nDepending on which properties you update, you may need to confirm the\nPaymentIntent again. For example, updating the payment_method will\nalways require you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties via\nthe confirm API instead.
",
+ "description": "Updates properties on a PaymentIntent object without confirming.
\n\nDepending on which properties you update, you might need to confirm the\nPaymentIntent again. For example, updating the payment_method\nalways requires you to confirm the PaymentIntent again. If you prefer to\nupdate and confirm at the same time, we recommend updating properties through\nthe confirm API instead.
",
"operationId": "PostPaymentIntentsIntent",
"parameters": [
{
@@ -91025,6 +96833,11 @@
"maxLength": 5000,
"type": "string"
},
+ "payment_method_configuration": {
+ "description": "The ID of the payment method configuration to use with this PaymentIntent.",
+ "maxLength": 100,
+ "type": "string"
+ },
"payment_method_data": {
"description": "If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear\nin the [payment_method](https://stripe.com/docs/api/payment_intents/object#payment_intent_object-payment_method)\nproperty on the PaymentIntent.",
"properties": {
@@ -91182,14 +96995,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -91344,6 +97177,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -91760,7 +97594,7 @@
"type": "string"
},
"reference": {
- "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
+ "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.",
"maxLength": 128,
"type": "string"
},
@@ -92116,6 +97950,38 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_extended_authorization": {
+ "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_multicapture": {
+ "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_overcapture": {
+ "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_three_d_secure": {
"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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
@@ -92187,6 +98053,14 @@
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
"type": "boolean"
},
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_incremental_authorization_support": {
"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.",
"type": "boolean"
@@ -92550,9 +98424,19 @@
{
"properties": {
"confirmation_number": {
- "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
- "maxLength": 11,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 11,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number."
},
"expires_after_days": {
"anyOf": [
@@ -92584,9 +98468,19 @@
"description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
},
"product_description": {
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
- "maxLength": 22,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 22,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
},
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
@@ -92621,7 +98515,7 @@
"type": "string"
},
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
},
@@ -92951,6 +98845,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -92978,6 +98883,15 @@
"title": "networks_options_param",
"type": "object"
},
+ "preferred_settlement_speed": {
+ "description": "Preferred transaction settlement speed",
+ "enum": [
+ "",
+ "fastest",
+ "standard"
+ ],
+ "type": "string"
+ },
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
"enum": [
@@ -93082,7 +98996,7 @@
"type": "object"
},
"payment_method_types": {
- "description": "The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. Use automatic_payment_methods to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
+ "description": "The list of payment method types (for example, card) that this PaymentIntent can use. Use `automatic_payment_methods` to manage payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).",
"items": {
"maxLength": 5000,
"type": "string"
@@ -93201,7 +99115,7 @@
"type": "string"
},
"transfer_data": {
- "description": "The parameters used to automatically create a Transfer when the payment succeeds. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "description": "Use this parameter to automatically create a Transfer when the payment succeeds. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
@@ -93212,7 +99126,7 @@
"type": "object"
},
"transfer_group": {
- "description": "A string that identifies the resulting payment as part of a group. `transfer_group` may only be provided if it has not been set. See the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts) for details.",
+ "description": "A string that identifies the resulting payment as part of a group. You can only provide `transfer_group` if it hasn't been set. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"type": "string"
}
},
@@ -93248,7 +99162,7 @@
},
"/v1/payment_intents/{intent}/apply_customer_balance": {
"post": {
- "description": "Manually reconcile the remaining amount for a customer_balance PaymentIntent.
",
+ "description": "Manually reconcile the remaining amount for a customer_balance PaymentIntent.
",
"operationId": "PostPaymentIntentsIntentApplyCustomerBalance",
"parameters": [
{
@@ -93275,7 +99189,7 @@
"additionalProperties": false,
"properties": {
"amount": {
- "description": "Amount intended to be applied to this PaymentIntent from the customer’s cash balance.\n\nA 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).\n\nThe maximum amount is the amount of the PaymentIntent.\n\nWhen omitted, the amount defaults to the remaining amount requested on the PaymentIntent.",
+ "description": "Amount that you intend to apply to this PaymentIntent from the customer’s cash balance.\n\nA positive integer representing how much to charge in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal) (for example, 100 cents to charge 1 USD or 100 to charge 100 JPY, a zero-decimal currency).\n\nThe maximum amount is the amount of the PaymentIntent.\n\nWhen you omit the amount, it defaults to the remaining amount requested on the PaymentIntent.",
"type": "integer"
},
"currency": {
@@ -93323,7 +99237,7 @@
},
"/v1/payment_intents/{intent}/cancel": {
"post": {
- "description": "A PaymentIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
\n\nOnce canceled, no additional charges will be made by the PaymentIntent and any operations on the PaymentIntent will fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable will automatically be refunded.
\n\nYou cannot cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.
",
+ "description": "You can cancel a PaymentIntent object when it’s in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_action or, in rare cases, processing.
\n\nAfter it’s canceled, no additional charges are made by the PaymentIntent and any operations on the PaymentIntent fail with an error. For PaymentIntents with a status of requires_capture, the remaining amount_capturable is automatically refunded.
\n\nYou can’t cancel the PaymentIntent for a Checkout Session. Expire the Checkout Session instead.
",
"operationId": "PostPaymentIntentsIntentCancel",
"parameters": [
{
@@ -93350,7 +99264,7 @@
"additionalProperties": false,
"properties": {
"cancellation_reason": {
- "description": "Reason for canceling this PaymentIntent. Possible values are `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`",
+ "description": "Reason for canceling this PaymentIntent. Possible values are: `duplicate`, `fraudulent`, `requested_by_customer`, or `abandoned`",
"enum": [
"abandoned",
"duplicate",
@@ -93402,7 +99316,7 @@
},
"/v1/payment_intents/{intent}/capture": {
"post": {
- "description": "Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
\n\nUncaptured PaymentIntents will be canceled a set number of days after they are created (7 by default).
\n\nLearn more about separate authorization and capture.
",
+ "description": "Capture the funds of an existing uncaptured PaymentIntent when its status is requires_capture.
\n\nUncaptured PaymentIntents are cancelled a set number of days (7 by default) after their creation.
\n\nLearn more about separate authorization and capture.
",
"operationId": "PostPaymentIntentsIntentCapture",
"parameters": [
{
@@ -93437,7 +99351,7 @@
"additionalProperties": false,
"properties": {
"amount_to_capture": {
- "description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount will be automatically refunded. Defaults to the full `amount_capturable` if not provided.",
+ "description": "The amount to capture from the PaymentIntent, which must be less than or equal to the original amount. Any additional amount is automatically refunded. Defaults to the full `amount_capturable` if it's not provided.",
"type": "integer"
},
"application_fee_amount": {
@@ -93452,6 +99366,10 @@
},
"type": "array"
},
+ "final_capture": {
+ "description": "Defaults to `true`. When capturing a PaymentIntent, setting `final_capture` to `false` notifies Stripe to not release the remaining uncaptured funds to make sure that they're captured in future requests. You can only use this setting when [multicapture](https://stripe.com/docs/payments/multicapture) is available for PaymentIntents.",
+ "type": "boolean"
+ },
"metadata": {
"anyOf": [
{
@@ -93475,12 +99393,12 @@
"type": "string"
},
"statement_descriptor_suffix": {
- "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.",
+ "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. The concatenated descriptor must be 1-22 characters long.",
"maxLength": 22,
"type": "string"
},
"transfer_data": {
- "description": "The parameters used to automatically create a Transfer when the payment\nis captured. For more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "description": "The parameters that you can use to automatically create a transfer after the payment\nis captured. Learn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
@@ -93599,7 +99517,7 @@
"type": "array"
},
"mandate": {
- "description": "ID of the mandate to be used for this payment.",
+ "description": "ID of the mandate that's used for this payment.",
"maxLength": 5000,
"type": "string"
},
@@ -93665,6 +99583,13 @@
"type": "object"
},
{
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ },
+ {
+ "description": "This hash contains details about the Mandate to create",
"properties": {
"customer_acceptance": {
"description": "This hash contains details about the customer acceptance of the Mandate.",
@@ -93711,8 +99636,7 @@
"class_name": "MandateDataPublishableKey"
}
}
- ],
- "description": "This hash contains details about the Mandate to create"
+ ]
},
"off_session": {
"anyOf": [
@@ -93728,7 +99652,7 @@
"type": "string"
}
],
- "description": "Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards)."
+ "description": "Set to `true` to indicate that the customer isn't in your checkout flow during this payment attempt and can't authenticate. Use this parameter in scenarios where you collect card details and [charge them later](https://stripe.com/docs/payments/cards/charging-saved-cards)."
},
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://stripe.com/docs/payments/payment-methods/transitioning#compatibility) object) to attach to this PaymentIntent.",
@@ -93892,14 +99816,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -94054,6 +99998,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -94338,7 +100283,7 @@
"type": "object"
},
"payment_method_options": {
- "description": "Payment-method-specific configuration for this PaymentIntent.",
+ "description": "Payment method-specific configuration for this PaymentIntent.",
"properties": {
"acss_debit": {
"anyOf": [
@@ -94470,7 +100415,7 @@
"type": "string"
},
"reference": {
- "description": "Order identifier shown to the customer in Afterpay’s online portal. We recommend using a value that helps you answer any questions a customer might have about\nthe payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.",
+ "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.",
"maxLength": 128,
"type": "string"
},
@@ -94826,6 +100771,38 @@
"type": "string",
"x-stripeBypassValidation": true
},
+ "request_extended_authorization": {
+ "description": "Request ability to [capture beyond the standard authorization validity window](https://stripe.com/docs/payments/extended-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_multicapture": {
+ "description": "Request ability to make [multiple captures](https://stripe.com/docs/payments/multicapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
+ "request_overcapture": {
+ "description": "Request ability to [overcapture](https://stripe.com/docs/payments/overcapture) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_three_d_secure": {
"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. Permitted values include: `automatic` or `any`. If not provided, defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
@@ -94897,6 +100874,14 @@
"description": "Request ability to capture this payment beyond the standard [authorization validity window](https://stripe.com/docs/terminal/features/extended-authorizations#authorization-validity)",
"type": "boolean"
},
+ "request_incremental_authorization": {
+ "description": "Request ability to [increment](https://stripe.com/docs/payments/incremental-authorization) for this PaymentIntent.",
+ "enum": [
+ "if_available",
+ "never"
+ ],
+ "type": "string"
+ },
"request_incremental_authorization_support": {
"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.",
"type": "boolean"
@@ -95260,9 +101245,19 @@
{
"properties": {
"confirmation_number": {
- "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number.",
- "maxLength": 11,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 11,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An optional 10 to 11 digit numeric-only string determining the confirmation code at applicable convenience stores. Must not consist of only zeroes and could be rejected in case of insufficient uniqueness. We recommend to use the customer's phone number."
},
"expires_after_days": {
"anyOf": [
@@ -95294,9 +101289,19 @@
"description": "The timestamp at which the Konbini payment instructions will expire. Only one of `expires_after_days` or `expires_at` may be set."
},
"product_description": {
- "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store.",
- "maxLength": 22,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 22,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A product descriptor of up to 22 characters, which will appear to customers at the convenience store."
},
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
@@ -95331,7 +101336,7 @@
"type": "string"
},
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
},
@@ -95661,6 +101666,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -95688,6 +101704,15 @@
"title": "networks_options_param",
"type": "object"
},
+ "preferred_settlement_speed": {
+ "description": "Preferred transaction settlement speed",
+ "enum": [
+ "",
+ "fastest",
+ "standard"
+ ],
+ "type": "string"
+ },
"setup_future_usage": {
"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).\n\nIf `setup_future_usage` is already set and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.",
"enum": [
@@ -95792,7 +101817,7 @@
"type": "object"
},
"radar_options": {
- "description": "Options to configure Radar. See [Radar Session](https://stripe.com/docs/radar/radar-session) for more information.",
+ "description": "Options to configure Radar. Learn more about [Radar Sessions](https://stripe.com/docs/radar/radar-session).",
"properties": {
"session": {
"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.",
@@ -95800,7 +101825,7 @@
"type": "string"
}
},
- "title": "radar_options",
+ "title": "radar_options_with_hidden_options",
"type": "object"
},
"receipt_email": {
@@ -95945,7 +101970,7 @@
},
"/v1/payment_intents/{intent}/increment_authorization": {
"post": {
- "description": "Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.
\n\nIncremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. As with the\ninitial authorization, incremental authorizations may be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.
\n\nIf the incremental authorization succeeds, the PaymentIntent object is\nreturned with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error is returned, and no\nfields on the PaymentIntent or Charge are updated. The PaymentIntent\nobject remains capturable for the previously authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nOnce captured, a PaymentIntent can no longer be incremented.
\n\nLearn more about incremental authorizations.
",
+ "description": "Perform an incremental authorization on an eligible\nPaymentIntent. To be eligible, the\nPaymentIntent’s status must be requires_capture and\nincremental_authorization_supported\nmust be true.
\n\nIncremental authorizations attempt to increase the authorized amount on\nyour customer’s card to the new, higher amount provided. Similar to the\ninitial authorization, incremental authorizations can be declined. A\nsingle PaymentIntent can call this endpoint multiple times to further\nincrease the authorized amount.
\n\nIf the incremental authorization succeeds, the PaymentIntent object\nreturns with the updated\namount.\nIf the incremental authorization fails, a\ncard_declined error returns, and no other\nfields on the PaymentIntent or Charge update. The PaymentIntent\nobject remains capturable for the previously authorized amount.
\n\nEach PaymentIntent can have a maximum of 10 incremental authorization attempts, including declines.\nAfter it’s captured, a PaymentIntent can no longer be incremented.
\n\nLearn more about incremental authorizations.
",
"operationId": "PostPaymentIntentsIntentIncrementAuthorization",
"parameters": [
{
@@ -95980,7 +102005,7 @@
"additionalProperties": false,
"properties": {
"amount": {
- "description": "The updated total amount you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.",
+ "description": "The updated total amount that you intend to collect from the cardholder. This amount must be greater than the currently authorized amount.",
"type": "integer"
},
"application_fee_amount": {
@@ -96013,7 +102038,7 @@
"type": "string"
},
"transfer_data": {
- "description": "The parameters used to automatically create a Transfer when the payment is captured.\nFor more information, see the PaymentIntents [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
+ "description": "The parameters used to automatically create a transfer after the payment is captured.\nLearn more about the [use case for connected accounts](https://stripe.com/docs/payments/connected-accounts).",
"properties": {
"amount": {
"description": "The amount that will be transferred automatically when a charge succeeds.",
@@ -96408,7 +102433,7 @@
"type": "integer"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field.",
+ "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. There must be at least 1 line item with a recurring price to use this field.",
"type": "number"
},
"automatic_tax": {
@@ -96588,8 +102613,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -96613,8 +102638,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -96632,6 +102657,31 @@
}
],
"description": "Custom text that should be displayed alongside the payment confirmation button."
+ },
+ "terms_of_service_acceptance": {
+ "anyOf": [
+ {
+ "properties": {
+ "message": {
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
+ "type": "string"
+ }
+ },
+ "required": [
+ "message"
+ ],
+ "title": "custom_text_position_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text."
}
},
"title": "custom_text_param",
@@ -96847,6 +102897,13 @@
],
"type": "string"
},
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "type": "object"
+ },
"setup_future_usage": {
"description": "Indicates that you intend to [make future payments](https://stripe.com/docs/payments/payment-intents#future-usage) with the payment method collected by this Checkout Session.\n\nWhen setting this to `on_session`, Checkout will show a notice to the customer that their payment details will be saved.\n\nWhen setting this to `off_session`, Checkout will show a notice to the customer that their payment details will be saved and used for future payments.\n\nIf a Customer has been provided or Checkout creates a new Customer,Checkout will attach the payment method to the Customer.\n\nIf Checkout does not create a Customer, the payment method is not attached to a Customer. To reuse the payment method, you can retrieve it from the Checkout Session's PaymentIntent.\n\nWhen processing card payments, Checkout also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as SCA.",
"enum": [
@@ -96854,6 +102911,16 @@
"on_session"
],
"type": "string"
+ },
+ "statement_descriptor": {
+ "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge.",
+ "maxLength": 22,
+ "type": "string"
+ },
+ "statement_descriptor_suffix": {
+ "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.",
+ "maxLength": 22,
+ "type": "string"
}
},
"title": "payment_intent_data_params",
@@ -97208,6 +103275,13 @@
"maxLength": 500,
"type": "string"
},
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "type": "object"
+ },
"trial_period_days": {
"description": "Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.",
"type": "integer"
@@ -97400,6 +103474,10 @@
"explode": true,
"style": "deepObject"
},
+ "payment_intent_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
"payment_method_types": {
"explode": true,
"style": "deepObject"
@@ -97407,6 +103485,10 @@
"shipping_address_collection": {
"explode": true,
"style": "deepObject"
+ },
+ "subscription_data": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
@@ -97625,8 +103707,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -97650,8 +103732,8 @@
{
"properties": {
"message": {
- "description": "Text may be up to 1000 characters in length.",
- "maxLength": 1000,
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
"type": "string"
}
},
@@ -97669,6 +103751,31 @@
}
],
"description": "Custom text that should be displayed alongside the payment confirmation button."
+ },
+ "terms_of_service_acceptance": {
+ "anyOf": [
+ {
+ "properties": {
+ "message": {
+ "description": "Text may be up to 1200 characters in length.",
+ "maxLength": 1200,
+ "type": "string"
+ }
+ },
+ "required": [
+ "message"
+ ],
+ "title": "custom_text_position_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Custom text that should be displayed in place of the default terms of service agreement text."
}
},
"title": "custom_text_param",
@@ -97867,6 +103974,60 @@
"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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`. Metadata associated with this Payment Link will automatically be copied to [checkout sessions](https://stripe.com/docs/api/checkout/sessions) created by this payment link.",
"type": "object"
},
+ "payment_intent_data": {
+ "description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
+ "properties": {
+ "metadata": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Payment Intents](https://stripe.com/docs/api/payment_intents) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."
+ },
+ "statement_descriptor": {
+ "anyOf": [
+ {
+ "maxLength": 22,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Extra information about the payment. This will appear on your customer's statement when this payment succeeds in creating a charge."
+ },
+ "statement_descriptor_suffix": {
+ "anyOf": [
+ {
+ "maxLength": 22,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "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."
+ }
+ },
+ "title": "payment_intent_data_update_params",
+ "type": "object"
+ },
"payment_method_collection": {
"description": "Specify whether Checkout should collect a payment method. When set to `if_required`, Checkout will not collect a payment method when the total due for the session is 0.This may occur if the Checkout Session includes a free trial or a discount.\n\nCan only be set in `subscription` mode.\n\nIf you'd like information on how to collect a payment method outside of Checkout, read the guide on [configuring subscriptions with a free trial](https://stripe.com/docs/payments/checkout/free-trials).",
"enum": [
@@ -97921,7 +104082,7 @@
"type": "string"
}
],
- "description": "The list of payment method types that customers can use. Pass an empty string to enable automatic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."
+ "description": "The list of payment method types that customers can use. Pass an empty string to enable dynamic payment methods that use your [payment method settings](https://dashboard.stripe.com/settings/payment_methods)."
},
"shipping_address_collection": {
"anyOf": [
@@ -98188,6 +104349,30 @@
}
],
"description": "Configuration for collecting the customer's shipping address."
+ },
+ "subscription_data": {
+ "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`.",
+ "properties": {
+ "metadata": {
+ "anyOf": [
+ {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will declaratively set metadata on [Subscriptions](https://stripe.com/docs/api/subscriptions) generated from this payment link. Unlike object-level metadata, this field is declarative. Updates will clear prior values."
+ }
+ },
+ "title": "subscription_data_update_params",
+ "type": "object"
}
},
"type": "object"
@@ -98304,9 +104489,2257 @@
"description": "",
"properties": {
"data": {
- "description": "Details about each object.",
+ "description": "Details about each object.",
+ "items": {
+ "$ref": "#/components/schemas/item"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "PaymentLinksResourceListLineItems",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/payment_method_configurations": {
+ "get": {
+ "description": "List payment method configurations
",
+ "operationId": "GetPaymentMethodConfigurations",
+ "parameters": [
+ {
+ "description": "The Connect application to filter by.",
+ "explode": true,
+ "in": "query",
+ "name": "application",
+ "required": false,
+ "schema": {
+ "anyOf": [
+ {
+ "maxLength": 100,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
+ "items": {
+ "$ref": "#/components/schemas/payment_method_configuration"
+ },
+ "type": "array"
+ },
+ "has_more": {
+ "description": "True if this list has another page of items after this one that can be fetched.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value. Always has the value `list`.",
+ "enum": [
+ "list"
+ ],
+ "type": "string"
+ },
+ "url": {
+ "description": "The URL where this list can be accessed.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "PaymentMethodConfigResourcePaymentMethodConfigurationsList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Creates a payment method configuration
",
+ "operationId": "PostPaymentMethodConfigurations",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "acss_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "affirm": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "afterpay_clearpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "alipay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "apple_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "apple_pay_later": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "au_becs_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "bacs_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "bancontact": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "blik": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "boleto": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "card": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "cartes_bancaires": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "cashapp": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "eps": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "fpx": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "giropay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "google_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "grabpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "ideal": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "jcb": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "klarna": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "konbini": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "link": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "oxxo": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "p24": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "paynow": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "paypal": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "promptpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "sepa_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "sofort": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "us_bank_account": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "wechat_pay": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "acss_debit": {
+ "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "affirm": {
+ "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "afterpay_clearpay": {
+ "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "alipay": {
+ "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "apple_pay": {
+ "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "apple_pay_later": {
+ "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "au_becs_debit": {
+ "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "bacs_debit": {
+ "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "bancontact": {
+ "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "blik": {
+ "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "boleto": {
+ "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "card": {
+ "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "cashapp": {
+ "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "eps": {
+ "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "fpx": {
+ "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "giropay": {
+ "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "google_pay": {
+ "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "grabpay": {
+ "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "ideal": {
+ "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "jcb": {
+ "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "klarna": {
+ "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "konbini": {
+ "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "link": {
+ "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "name": {
+ "description": "Configuration name.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "oxxo": {
+ "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "p24": {
+ "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "parent": {
+ "description": "Configuration's parent configuration. Specify to create a child configuration.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "paynow": {
+ "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "paypal": {
+ "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "promptpay": {
+ "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "sepa_debit": {
+ "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "sofort": {
+ "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "us_bank_account": {
+ "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "wechat_pay": {
+ "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_configuration"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/payment_method_configurations/{configuration}": {
+ "get": {
+ "description": "Retrieve payment method configuration
",
+ "operationId": "GetPaymentMethodConfigurationsConfiguration",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "configuration",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_configuration"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Update payment method configuration
",
+ "operationId": "PostPaymentMethodConfigurationsConfiguration",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "configuration",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "acss_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "affirm": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "afterpay_clearpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "alipay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "apple_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "apple_pay_later": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "au_becs_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "bacs_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "bancontact": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "blik": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "boleto": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "card": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "cartes_bancaires": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "cashapp": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "eps": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "fpx": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "giropay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "google_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "grabpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "ideal": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "jcb": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "klarna": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "konbini": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "link": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "oxxo": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "p24": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "paynow": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "paypal": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "promptpay": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "sepa_debit": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "sofort": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "us_bank_account": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "wechat_pay": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "acss_debit": {
+ "description": "Canadian pre-authorized debit payments, check this [page](https://stripe.com/docs/payments/acss-debit) for more details like country availability.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "active": {
+ "description": "Whether the configuration can be used for new payments.",
+ "type": "boolean"
+ },
+ "affirm": {
+ "description": "[Affirm](https://www.affirm.com/) gives your customers a way to split purchases over a series of payments. Depending on the purchase, they can pay with four interest-free payments (Split Pay) or pay over a longer term (Installments), which might include interest. Check this [page](https://stripe.com/docs/payments/affirm) for more details like country availability.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "afterpay_clearpay": {
+ "description": "Afterpay gives your customers a way to pay for purchases in installments, check this [page](https://stripe.com/docs/payments/afterpay-clearpay) for more details like country availability. Afterpay is particularly popular among businesses selling fashion, beauty, and sports products.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "alipay": {
+ "description": "Alipay is a digital wallet in China that has more than a billion active users worldwide. Alipay users can pay on the web or on a mobile device using login credentials or their Alipay app. Alipay has a low dispute rate and reduces fraud by authenticating payments using the customer's login credentials. Check this [page](https://stripe.com/docs/payments/alipay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "apple_pay": {
+ "description": "Stripe users can accept [Apple Pay](/payments/apple-pay) in iOS applications in iOS 9 and later, and on the web in Safari starting with iOS 10 or macOS Sierra. There are no additional fees to process Apple Pay payments, and the [pricing](/pricing) is the same as other card transactions. Check this [page](https://stripe.com/docs/apple-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "apple_pay_later": {
+ "description": "Apple Pay Later, a payment method for customers to buy now and pay later, gives your customers a way to split purchases into four installments across six weeks.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "au_becs_debit": {
+ "description": "Stripe users in Australia can accept Bulk Electronic Clearing System (BECS) direct debit payments from customers with an Australian bank account. Check this [page](https://stripe.com/docs/payments/au-becs-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "bacs_debit": {
+ "description": "Stripe users in the UK can accept Bacs Direct Debit payments from customers with a UK bank account, check this [page](https://stripe.com/docs/payments/payment-methods/bacs-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "bancontact": {
+ "description": "Bancontact is the most popular online payment method in Belgium, with over 15 million cards in circulation. [Customers](https://stripe.com/docs/api/customers) use a Bancontact card or mobile app linked to a Belgian bank account to make online payments that are secure, guaranteed, and confirmed immediately. Check this [page](https://stripe.com/docs/payments/bancontact) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "blik": {
+ "description": "BLIK is a [single use](https://stripe.com/docs/payments/payment-methods#usage) payment method that requires customers to authenticate their payments. When customers want to pay online using BLIK, they request a six-digit code from their banking application and enter it into the payment collection form. Check this [page](https://stripe.com/docs/payments/blik) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "boleto": {
+ "description": "Boleto is an official (regulated by the Central Bank of Brazil) payment method in Brazil. Check this [page](https://stripe.com/docs/payments/boleto) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "card": {
+ "description": "Cards are a popular way for consumers and businesses to pay online or in person. Stripe supports global and local card networks.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires is France's local card network. More than 95% of these cards are co-branded with either Visa or Mastercard, meaning you can process these cards over either Cartes Bancaires or the Visa or Mastercard networks. Check this [page](https://stripe.com/docs/payments/cartes-bancaires) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "cashapp": {
+ "description": "Cash App is a popular consumer app in the US that allows customers to bank, invest, send, and receive money using their digital wallet. Check this [page](https://stripe.com/docs/payments/cash-app-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "eps": {
+ "description": "EPS is an Austria-based payment method that allows customers to complete transactions online using their bank credentials. EPS is supported by all Austrian banks and is accepted by over 80% of Austrian online retailers. Check this [page](https://stripe.com/docs/payments/eps) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "fpx": {
+ "description": "Financial Process Exchange (FPX) is a Malaysia-based payment method that allows customers to complete transactions online using their bank credentials. Bank Negara Malaysia (BNM), the Central Bank of Malaysia, and eleven other major Malaysian financial institutions are members of the PayNet Group, which owns and operates FPX. It is one of the most popular online payment methods in Malaysia, with nearly 90 million transactions in 2018 according to BNM. Check this [page](https://stripe.com/docs/payments/fpx) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "giropay": {
+ "description": "giropay is a German payment method based on online banking, introduced in 2006. It allows customers to complete transactions online using their online banking environment, with funds debited from their bank account. Depending on their bank, customers confirm payments on giropay using a second factor of authentication or a PIN. giropay accounts for 10% of online checkouts in Germany. Check this [page](https://stripe.com/docs/payments/giropay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "google_pay": {
+ "description": "Google Pay allows customers to make payments in your app or website using any credit or debit card saved to their Google Account, including those from Google Play, YouTube, Chrome, or an Android device. Use the Google Pay API to request any credit or debit card stored in your customer's Google account. Check this [page](https://stripe.com/docs/google-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "grabpay": {
+ "description": "GrabPay is a payment method developed by [Grab](https://www.grab.com/sg/consumer/finance/pay/). GrabPay is a digital wallet - customers maintain a balance in their wallets that they pay out with. Check this [page](https://stripe.com/docs/payments/grabpay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "ideal": {
+ "description": "iDEAL is a Netherlands-based payment method that allows customers to complete transactions online using their bank credentials. All major Dutch banks are members of Currence, the scheme that operates iDEAL, making it the most popular online payment method in the Netherlands with a share of online transactions close to 55%. Check this [page](https://stripe.com/docs/payments/ideal) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "jcb": {
+ "description": "JCB is a credit card company based in Japan. JCB is currently available in Japan to businesses approved by JCB, and available to all businesses in Australia, Canada, Hong Kong, Japan, New Zealand, Singapore, Switzerland, United Kingdom, United States, and all countries in the European Economic Area except Iceland. Check this [page](https://support.stripe.com/questions/accepting-japan-credit-bureau-%28jcb%29-payments) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "klarna": {
+ "description": "Klarna gives customers a range of [payment options](https://stripe.com/docs/payments/klarna#payment-options) during checkout. Available payment options vary depending on the customer's billing address and the transaction amount. These payment options make it convenient for customers to purchase items in all price ranges. Check this [page](https://stripe.com/docs/payments/klarna) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "konbini": {
+ "description": "Konbini allows customers in Japan to pay for bills and online purchases at convenience stores with cash. Check this [page](https://stripe.com/docs/payments/konbini) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "link": {
+ "description": "[Link](https://stripe.com/docs/payments/link) is a payment method network. With Link, users save their payment details once, then reuse that information to pay with one click for any business on the network.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "name": {
+ "description": "Configuration name.",
+ "maxLength": 100,
+ "type": "string"
+ },
+ "oxxo": {
+ "description": "OXXO is a Mexican chain of convenience stores with thousands of locations across Latin America and represents nearly 20% of online transactions in Mexico. OXXO allows customers to pay bills and online purchases in-store with cash. Check this [page](https://stripe.com/docs/payments/oxxo) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "p24": {
+ "description": "Przelewy24 is a Poland-based payment method aggregator that allows customers to complete transactions online using bank transfers and other methods. Bank transfers account for 30% of online payments in Poland and Przelewy24 provides a way for customers to pay with over 165 banks. Check this [page](https://stripe.com/docs/payments/p24) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "paynow": {
+ "description": "PayNow is a Singapore-based payment method that allows customers to make a payment using their preferred app from participating banks and participating non-bank financial institutions. Check this [page](https://stripe.com/docs/payments/paynow) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "paypal": {
+ "description": "PayPal, a digital wallet popular with customers in Europe, allows your customers worldwide to pay using their PayPal account. Check this [page](https://stripe.com/docs/payments/paypal) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "promptpay": {
+ "description": "PromptPay is a Thailand-based payment method that allows customers to make a payment using their preferred app from participating banks. Check this [page](https://stripe.com/docs/payments/promptpay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "sepa_debit": {
+ "description": "The [Single Euro Payments Area (SEPA)](https://en.wikipedia.org/wiki/Single_Euro_Payments_Area) is an initiative of the European Union to simplify payments within and across member countries. SEPA established and enforced banking standards to allow for the direct debiting of every EUR-denominated bank account within the SEPA region, check this [page](https://stripe.com/docs/payments/sepa-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "sofort": {
+ "description": "Stripe users in Europe and the United States can use the [Payment Intents API](https://stripe.com/docs/payments/payment-intents)—a single integration path for creating payments using any supported method—to accept [Sofort](https://www.sofort.com/) payments from customers. Check this [page](https://stripe.com/docs/payments/sofort) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "us_bank_account": {
+ "description": "Stripe users in the United States can accept ACH direct debit payments from customers with a US bank account using the Automated Clearing House (ACH) payments system operated by Nacha. Check this [page](https://stripe.com/docs/payments/ach-debit) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ },
+ "wechat_pay": {
+ "description": "WeChat, owned by Tencent, is China's leading mobile app with over 1 billion monthly active users. Chinese consumers can use WeChat Pay to pay for goods and services inside of businesses' apps and websites. WeChat Pay users buy most frequently in gaming, e-commerce, travel, online education, and food/nutrition. Check this [page](https://stripe.com/docs/payments/wechat-pay) for more details.",
+ "properties": {
+ "display_preference": {
+ "description": "Whether or not the payment method should be displayed.",
+ "properties": {
+ "preference": {
+ "description": "The account's preference for whether or not to display this payment method.",
+ "enum": [
+ "none",
+ "off",
+ "on"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "display_preference_param",
+ "type": "object"
+ }
+ },
+ "title": "payment_method_param",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_configuration"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/payment_method_domains": {
+ "get": {
+ "description": "Lists the details of existing payment method domains.
",
+ "operationId": "GetPaymentMethodDomains",
+ "parameters": [
+ {
+ "description": "The domain name that this payment method domain object represents.",
+ "in": "query",
+ "name": "domain_name",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Whether this payment method domain is enabled. If the domain is not enabled, payment methods will not appear in Elements",
+ "in": "query",
+ "name": "enabled",
+ "required": false,
+ "schema": {
+ "type": "boolean"
+ },
+ "style": "form"
+ },
+ {
+ "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list.",
+ "in": "query",
+ "name": "ending_before",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.",
+ "in": "query",
+ "name": "limit",
+ "required": false,
+ "schema": {
+ "type": "integer"
+ },
+ "style": "form"
+ },
+ {
+ "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
+ "in": "query",
+ "name": "starting_after",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "description": "",
+ "properties": {
+ "data": {
"items": {
- "$ref": "#/components/schemas/item"
+ "$ref": "#/components/schemas/payment_method_domain"
},
"type": "array"
},
@@ -98324,6 +106757,7 @@
"url": {
"description": "The URL where this list can be accessed.",
"maxLength": 5000,
+ "pattern": "^/v1/payment_method_domains",
"type": "string"
}
},
@@ -98333,7 +106767,7 @@
"object",
"url"
],
- "title": "PaymentLinksResourceListLineItems",
+ "title": "PaymentMethodDomainResourcePaymentMethodDomainList",
"type": "object",
"x-expandableFields": [
"data"
@@ -98354,6 +106788,275 @@
"description": "Error response."
}
}
+ },
+ "post": {
+ "description": "Creates a payment method domain.
",
+ "operationId": "PostPaymentMethodDomains",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "domain_name": {
+ "description": "The domain name that this payment method domain object represents.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "enabled": {
+ "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.",
+ "type": "boolean"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "domain_name"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_domain"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/payment_method_domains/{payment_method_domain}": {
+ "get": {
+ "description": "Retrieves the details of an existing payment method domain.
",
+ "operationId": "GetPaymentMethodDomainsPaymentMethodDomain",
+ "parameters": [
+ {
+ "description": "Specifies which fields in the response should be expanded.",
+ "explode": true,
+ "in": "query",
+ "name": "expand",
+ "required": false,
+ "schema": {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "style": "deepObject"
+ },
+ {
+ "in": "path",
+ "name": "payment_method_domain",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {},
+ "schema": {
+ "additionalProperties": false,
+ "properties": {},
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_domain"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Updates an existing payment method domain.
",
+ "operationId": "PostPaymentMethodDomainsPaymentMethodDomain",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "payment_method_domain",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "enabled": {
+ "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.",
+ "type": "boolean"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_domain"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/payment_method_domains/{payment_method_domain}/validate": {
+ "post": {
+ "description": "Some payment methods such as Apple Pay require additional steps to verify a domain. If the requirements weren’t satisfied when the domain was created, the payment method will be inactive on the domain.\nThe payment method doesn’t appear in Elements for this domain until it is active.
\n\nTo activate a payment method on an existing payment method domain, complete the required validation steps specific to the payment method, and then validate the payment method domain with this endpoint.
\n\nRelated guides: Payment method domains.
",
+ "operationId": "PostPaymentMethodDomainsPaymentMethodDomainValidate",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "payment_method_domain",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/payment_method_domain"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
}
},
"/v1/payment_methods": {
@@ -98434,7 +107137,6 @@
"blik",
"boleto",
"card",
- "card_present",
"cashapp",
"customer_balance",
"eps",
@@ -98844,14 +107546,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -98915,6 +107637,7 @@
{
"properties": {
"token": {
+ "description": "For backwards compatibility, you can alternatively provide a Stripe token (e.g., for Apple Pay, Amex Express Checkout, or legacy Checkout) into the card hash with format card: {token: \"tok_visa\"}.",
"maxLength": 5000,
"type": "string"
}
@@ -99073,6 +107796,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -99472,38 +108196,14 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "acss_debit": {
- "explode": true,
- "style": "deepObject"
- },
- "affirm": {
- "explode": true,
- "style": "deepObject"
- },
- "au_becs_debit": {
- "explode": true,
- "style": "deepObject"
- },
- "bacs_debit": {
- "explode": true,
- "style": "deepObject"
- },
"billing_details": {
"explode": true,
"style": "deepObject"
},
- "blik": {
- "explode": true,
- "style": "deepObject"
- },
"card": {
"explode": true,
"style": "deepObject"
},
- "cashapp": {
- "explode": true,
- "style": "deepObject"
- },
"expand": {
"explode": true,
"style": "deepObject"
@@ -99516,46 +108216,14 @@
"explode": true,
"style": "deepObject"
},
- "sepa_debit": {
- "explode": true,
- "style": "deepObject"
- },
"us_bank_account": {
"explode": true,
"style": "deepObject"
- },
- "zip": {
- "explode": true,
- "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
- "acss_debit": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "update_param",
- "type": "object"
- },
- "affirm": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "param",
- "type": "object"
- },
- "au_becs_debit": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "update_param",
- "type": "object"
- },
- "bacs_debit": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "update_param",
- "type": "object"
- },
"billing_details": {
"description": "Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.",
"properties": {
@@ -99621,25 +108289,39 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
"type": "object"
},
- "blik": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "param",
- "type": "object"
- },
"card": {
"description": "If this is a `card` PaymentMethod, this hash contains the user's card details.",
"properties": {
@@ -99655,12 +108337,6 @@
"title": "update_api_param",
"type": "object"
},
- "cashapp": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "param",
- "type": "object"
- },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -99692,12 +108368,6 @@
],
"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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`."
},
- "sepa_debit": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "update_param",
- "type": "object"
- },
"us_bank_account": {
"description": "If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.",
"properties": {
@@ -99712,12 +108382,6 @@
},
"title": "update_param",
"type": "object"
- },
- "zip": {
- "description": "This is a legacy parameter that will be removed in the future. It is a hash that does not accept any keys.",
- "properties": {},
- "title": "param",
- "type": "object"
}
},
"type": "object"
@@ -99894,7 +108558,7 @@
},
"/v1/payouts": {
"get": {
- "description": "Returns a list of existing payouts sent to third-party bank accounts or that Stripe has sent you. The payouts are returned in sorted order, with the most recently created payouts appearing first.
",
+ "description": "Returns a list of existing payouts sent to third-party bank accounts or payouts that Stripe sent to you. The payouts return in sorted order, with the most recently created payouts appearing first.
",
"operationId": "GetPayouts",
"parameters": [
{
@@ -100111,7 +108775,7 @@
}
},
"post": {
- "description": "To send funds to your own bank account, you create a new payout object. Your Stripe balance must be able to cover the payout amount, or you’ll receive an “Insufficient Funds” error.
\n\nIf your API key is in test mode, money won’t actually be sent, though everything else will occur as if in live mode.
\n\nIf you are creating a manual payout on a Stripe account that uses multiple payment source types, you’ll need to specify the source type balance that the payout should draw from. The balance object details available and pending amounts by source type.
",
+ "description": "To send funds to your own bank account, create a new payout object. Your Stripe balance must cover the payout amount. If it doesn’t, you receive an “Insufficient Funds” error.
\n\nIf your API key is in test mode, money won’t actually be sent, though every other action occurs as if you’re in live mode.
\n\nIf you create a manual payout on a Stripe account that uses multiple payment source types, you need to specify the source type balance that the payout draws from. The balance object details available and pending amounts by source type.
",
"operationId": "PostPayouts",
"requestBody": {
"content": {
@@ -100143,7 +108807,7 @@
"type": "string"
},
"destination": {
- "description": "The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.",
+ "description": "The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.",
"type": "string"
},
"expand": {
@@ -100162,7 +108826,7 @@
"type": "object"
},
"method": {
- "description": "The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)",
+ "description": "The method used to send this payout, which is `standard` or `instant`. We support `instant` 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).",
"enum": [
"instant",
"standard"
@@ -100172,7 +108836,7 @@
"x-stripeBypassValidation": true
},
"source_type": {
- "description": "The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. One of `bank_account`, `card`, or `fpx`.",
+ "description": "The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of `bank_account`, `card`, or `fpx`.",
"enum": [
"bank_account",
"card",
@@ -100183,7 +108847,7 @@
"x-stripeBypassValidation": true
},
"statement_descriptor": {
- "description": "A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.",
+ "description": "A string that displays on the recipient's bank or card statement (up to 22 characters). A `statement_descriptor` that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.",
"maxLength": 22,
"type": "string",
"x-stripeBypassValidation": true
@@ -100225,7 +108889,7 @@
},
"/v1/payouts/{payout}": {
"get": {
- "description": "Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list, and Stripe will return the corresponding payout information.
",
+ "description": "Retrieves the details of an existing payout. Supply the unique payout ID from either a payout creation request or the payout list. Stripe returns the corresponding payout information.
",
"operationId": "GetPayoutsPayout",
"parameters": [
{
@@ -100291,7 +108955,7 @@
}
},
"post": {
- "description": "Updates the specified payout by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request accepts only the metadata as arguments.
",
+ "description": "Updates the specified payout by setting the values of the parameters you pass. We don’t change parameters that you don’t provide. This request only accepts the metadata as arguments.
",
"operationId": "PostPayoutsPayout",
"parameters": [
{
@@ -100379,7 +109043,7 @@
},
"/v1/payouts/{payout}/cancel": {
"post": {
- "description": "A previously created payout can be canceled if it has not yet been paid out. Funds will be refunded to your available balance. You may not cancel automatic Stripe payouts.
",
+ "description": "You can cancel a previously created payout if it hasn’t been paid out yet. Stripe refunds the funds to your available balance. You can’t cancel automatic Stripe payouts.
",
"operationId": "PostPayoutsPayoutCancel",
"parameters": [
{
@@ -100446,7 +109110,7 @@
},
"/v1/payouts/{payout}/reverse": {
"post": {
- "description": "Reverses a payout by debiting the destination bank account. Only payouts for connected accounts to US bank accounts may be reversed at this time. If the payout is in the pending status, /v1/payouts/:id/cancel should be used instead.
\n\nBy requesting a reversal via /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account has authorized the debit on the bank account and that no other authorization is required.
",
+ "description": "Reverses a payout by debiting the destination bank account. At this time, you can only reverse payouts for connected accounts to US bank accounts. If the payout is in the pending status, use /v1/payouts/:id/cancel instead.
\n\nBy requesting a reversal through /v1/payouts/:id/reverse, you confirm that the authorized signatory of the selected bank account authorizes the debit on the bank account and that no other authorization is required.
",
"operationId": "PostPayoutsPayoutReverse",
"parameters": [
{
@@ -102148,10 +110812,6 @@
"metadata": {
"explode": true,
"style": "deepObject"
- },
- "recurring": {
- "explode": true,
- "style": "deepObject"
}
},
"schema": {
@@ -102306,27 +110966,6 @@
"maxLength": 5000,
"type": "string"
},
- "recurring": {
- "anyOf": [
- {
- "properties": {
- "trial_period_days": {
- "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).",
- "type": "integer"
- }
- },
- "title": "update_recurring_params",
- "type": "object"
- },
- {
- "enum": [
- ""
- ],
- "type": "string"
- }
- ],
- "description": "The recurring components of a price such as `interval` and `usage_type`."
- },
"tax_behavior": {
"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.",
"enum": [
@@ -102601,19 +111240,15 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "attributes": {
- "explode": true,
- "style": "deepObject"
- },
- "deactivate_on": {
+ "default_price_data": {
"explode": true,
"style": "deepObject"
},
- "default_price_data": {
+ "expand": {
"explode": true,
"style": "deepObject"
},
- "expand": {
+ "features": {
"explode": true,
"style": "deepObject"
},
@@ -102637,27 +111272,6 @@
"description": "Whether the product is currently available for purchase. Defaults to `true`.",
"type": "boolean"
},
- "attributes": {
- "description": "A list of up to 5 alphanumeric attributes. Should only be set if type=`good`.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "caption": {
- "description": "A short one-line description of the product, meant to be displayable to the customer. May only be set if type=`good`.",
- "maxLength": 5000,
- "type": "string"
- },
- "deactivate_on": {
- "description": "An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if type=`good`.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
"default_price_data": {
"description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object. This Price will be set as the default price for this product.",
"properties": {
@@ -102827,6 +111441,24 @@
},
"type": "array"
},
+ "features": {
+ "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table).",
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The feature's name. Up to 80 characters long.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "title": "features",
+ "type": "object"
+ },
+ "type": "array"
+ },
"id": {
"description": "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account.",
"maxLength": 5000,
@@ -103215,15 +111847,15 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
- "attributes": {
+ "description": {
"explode": true,
"style": "deepObject"
},
- "deactivate_on": {
+ "expand": {
"explode": true,
"style": "deepObject"
},
- "expand": {
+ "features": {
"explode": true,
"style": "deepObject"
},
@@ -103243,6 +111875,10 @@
"explode": true,
"style": "deepObject"
},
+ "unit_label": {
+ "explode": true,
+ "style": "deepObject"
+ },
"url": {
"explode": true,
"style": "deepObject"
@@ -103255,14 +111891,16 @@
"description": "Whether the product is available for purchase.",
"type": "boolean"
},
- "attributes": {
+ "default_price": {
+ "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "description": {
"anyOf": [
{
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
+ "maxLength": 40000,
+ "type": "string"
},
{
"enum": [
@@ -103271,30 +111909,7 @@
"type": "string"
}
],
- "description": "A list of up to 5 alphanumeric attributes that each SKU can provide values for (e.g., `[\"color\", \"size\"]`). If a value for `attributes` is specified, the list specified will replace the existing attributes list on this product. Any attributes not present after the update will be deleted from the SKUs for this product."
- },
- "caption": {
- "description": "A short one-line description of the product, meant to be displayable to the customer. May only be set if `type=good`.",
- "maxLength": 5000,
- "type": "string"
- },
- "deactivate_on": {
- "description": "An array of Connect application names or identifiers that should not be able to order the SKUs for this product. May only be set if `type=good`.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "default_price": {
- "description": "The ID of the [Price](https://stripe.com/docs/api/prices) object that is the default price for this product.",
- "maxLength": 5000,
- "type": "string"
- },
- "description": {
- "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.",
- "maxLength": 40000,
- "type": "string"
+ "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."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -103304,6 +111919,34 @@
},
"type": "array"
},
+ "features": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "name": {
+ "description": "The feature's name. Up to 80 characters long.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "title": "features",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A list of up to 15 features for this product. These are displayed in [pricing tables](https://stripe.com/docs/payments/checkout/pricing-table)."
+ },
"images": {
"anyOf": [
{
@@ -103406,9 +112049,19 @@
"description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID."
},
"unit_label": {
- "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`.",
- "maxLength": 12,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 12,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal. May only be set if `type=service`."
},
"url": {
"anyOf": [
@@ -104163,6 +112816,10 @@
"explode": true,
"style": "deepObject"
},
+ "description": {
+ "explode": true,
+ "style": "deepObject"
+ },
"discounts": {
"explode": true,
"style": "deepObject"
@@ -104171,10 +112828,18 @@
"explode": true,
"style": "deepObject"
},
+ "footer": {
+ "explode": true,
+ "style": "deepObject"
+ },
"from_quote": {
"explode": true,
"style": "deepObject"
},
+ "header": {
+ "explode": true,
+ "style": "deepObject"
+ },
"invoice_settings": {
"explode": true,
"style": "deepObject"
@@ -104229,7 +112894,7 @@
"type": "string"
}
],
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field."
+ "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. There must be at least 1 line item with a recurring price to use this field."
},
"automatic_tax": {
"description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.",
@@ -104277,9 +112942,19 @@
"description": "The tax rates that will apply to any line item that does not have `tax_rates` set."
},
"description": {
- "description": "A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A description that will be displayed on the quote PDF. If no value is passed, the default description configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
},
"discounts": {
"anyOf": [
@@ -104325,9 +113000,19 @@
"type": "integer"
},
"footer": {
- "description": "A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A footer that will be displayed on the quote PDF. If no value is passed, the default footer configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
},
"from_quote": {
"description": "Clone an existing quote. The new quote will be created in `status=draft`. When using this parameter, you cannot specify any other parameters except for `expires_at`.",
@@ -104349,9 +113034,19 @@
"type": "object"
},
"header": {
- "description": "A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used.",
- "maxLength": 50,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 50,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A header that will be displayed on the quote PDF. If no value is passed, the default header configured in your [quote template settings](https://dashboard.stripe.com/settings/billing/quote) will be used."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -104546,7 +113241,7 @@
"type": "integer"
},
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.",
+ "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. There must be at least 1 line item with a recurring price to use this field.",
"type": "number"
},
"destination": {
@@ -104702,6 +113397,10 @@
"explode": true,
"style": "deepObject"
},
+ "description": {
+ "explode": true,
+ "style": "deepObject"
+ },
"discounts": {
"explode": true,
"style": "deepObject"
@@ -104710,6 +113409,14 @@
"explode": true,
"style": "deepObject"
},
+ "footer": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "header": {
+ "explode": true,
+ "style": "deepObject"
+ },
"invoice_settings": {
"explode": true,
"style": "deepObject"
@@ -104764,7 +113471,7 @@
"type": "string"
}
],
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. There must be at least 1 line item with a recurring price to use this field."
+ "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. There must be at least 1 line item with a recurring price to use this field."
},
"automatic_tax": {
"description": "Settings for automatic tax lookup for this quote and resulting invoices and subscriptions.",
@@ -104812,9 +113519,19 @@
"description": "The tax rates that will apply to any line item that does not have `tax_rates` set."
},
"description": {
- "description": "A description that will be displayed on the quote PDF.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A description that will be displayed on the quote PDF."
},
"discounts": {
"anyOf": [
@@ -104860,14 +113577,34 @@
"type": "integer"
},
"footer": {
- "description": "A footer that will be displayed on the quote PDF.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A footer that will be displayed on the quote PDF."
},
"header": {
- "description": "A header that will be displayed on the quote PDF.",
- "maxLength": 50,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 50,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A header that will be displayed on the quote PDF."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -105009,9 +113746,19 @@
"description": "When creating a subscription or subscription schedule, the specified configuration data will be used. There must be at least one line item with a recurring price for a subscription or subscription schedule to be created. A subscription schedule is created if `subscription_data[effective_date]` is present and in the future, otherwise a subscription is created.",
"properties": {
"description": {
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
},
"effective_date": {
"anyOf": [
@@ -105062,7 +113809,7 @@
"type": "integer"
},
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination. There must be at least 1 line item with a recurring price to use this field.",
+ "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. There must be at least 1 line item with a recurring price to use this field.",
"type": "number"
},
"destination": {
@@ -106464,7 +115211,7 @@
"type": "array"
},
"item_type": {
- "description": "Type of the items in the value list. One of `card_fingerprint`, `card_bin`, `email`, `ip_address`, `country`, `string`, `case_sensitive_string`, or `customer_id`. Use `string` if the item type is unknown or mixed.",
+ "description": "Type of the 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`. Use `string` if the item type is unknown or mixed.",
"enum": [
"card_bin",
"card_fingerprint",
@@ -106473,7 +115220,9 @@
"customer_id",
"email",
"ip_address",
- "string"
+ "sepa_debit_fingerprint",
+ "string",
+ "us_bank_account_fingerprint"
],
"maxLength": 5000,
"type": "string"
@@ -106732,7 +115481,7 @@
},
"/v1/refunds": {
"get": {
- "description": "Returns a list of all refunds you’ve previously created. The refunds are returned in sorted order, with the most recent refunds appearing first. For convenience, the 10 most recent refunds are always available by default on the charge object.
",
+ "description": "Returns a list of all refunds you created. We return the refunds in sorted order, with the most recent refunds appearing first The 10 most recent refunds are always available by default on the Charge object.
",
"operationId": "GetRefunds",
"parameters": [
{
@@ -106911,7 +115660,7 @@
}
},
"post": {
- "description": "Create a refund.
",
+ "description": "When you create a new refund, you must specify a Charge or a PaymentIntent object on which to create it.
\n\nCreating a new refund will refund a charge that has previously been created but not yet refunded.\nFunds will be refunded to the credit or debit card that was originally charged.
\n\nYou can optionally refund only part of a charge.\nYou can do so multiple times, until the entire charge has been refunded.
\n\nOnce entirely refunded, a charge can’t be refunded again.\nThis method will raise an error when called on an already-refunded charge,\nor when trying to refund more money than is left on a charge.
",
"operationId": "PostRefunds",
"requestBody": {
"content": {
@@ -106930,10 +115679,10 @@
"additionalProperties": false,
"properties": {
"amount": {
- "description": "A positive integer representing how much to refund.",
"type": "integer"
},
"charge": {
+ "description": "The identifier of the charge to refund.",
"maxLength": 5000,
"type": "string"
},
@@ -106983,10 +115732,12 @@
"type": "string"
},
"payment_intent": {
+ "description": "The identifier of the PaymentIntent to refund.",
"maxLength": 5000,
"type": "string"
},
"reason": {
+ "description": "String indicating the reason for the refund. If set, possible values are `duplicate`, `fraudulent`, and `requested_by_customer`. If you believe the charge to be fraudulent, specifying `fraudulent` as the reason will add the associated card and email to your [block lists](https://stripe.com/docs/radar/lists), and will also help us improve our fraud detection algorithms.",
"enum": [
"duplicate",
"fraudulent",
@@ -106996,9 +115747,11 @@
"type": "string"
},
"refund_application_fee": {
+ "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.",
"type": "boolean"
},
"reverse_transfer": {
+ "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.",
"type": "boolean"
}
},
@@ -107099,7 +115852,7 @@
}
},
"post": {
- "description": "Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
\n\nThis request only accepts metadata as an argument.
",
+ "description": "Updates the refund that you specify by setting the values of the passed parameters. Any parameters that you don’t provide remain unchanged.
\n\nThis request only accepts metadata as an argument.
",
"operationId": "PostRefundsRefund",
"parameters": [
{
@@ -107186,7 +115939,7 @@
},
"/v1/refunds/{refund}/cancel": {
"post": {
- "description": "Cancels a refund with a status of requires_action.
\n\nRefunds in other states cannot be canceled, and only refunds for payment methods that require customer action will enter the requires_action state.
",
+ "description": "Cancels a refund with a status of requires_action.
\n\nYou can’t cancel refunds in other states. Only refunds for payment methods that require customer action can enter the requires_action state.
",
"operationId": "PostRefundsRefundCancel",
"parameters": [
{
@@ -107494,6 +116247,7 @@
"issuing_dispute",
"issuing_transaction",
"network_cost",
+ "obligation",
"other_adjustment",
"partial_capture_reversal",
"payout",
@@ -108686,11 +117440,11 @@
},
"/v1/setup_attempts": {
"get": {
- "description": "Returns a list of SetupAttempts associated with a provided SetupIntent.
",
+ "description": "Returns a list of SetupAttempts that associate with a provided SetupIntent.
",
"operationId": "GetSetupAttempts",
"parameters": [
{
- "description": "A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp, or it can be a\ndictionary with a number of different query options.",
+ "description": "A filter on the list, based on the object `created` field. The value\ncan be a string with an integer Unix timestamp or a\ndictionary with a number of different query options.",
"explode": true,
"in": "query",
"name": "created",
@@ -108958,7 +117712,7 @@
"style": "form"
},
{
- "description": "Only return SetupIntents associated with the specified payment method.",
+ "description": "Only return SetupIntents that associate with the specified payment method.",
"in": "query",
"name": "payment_method",
"required": false,
@@ -109053,7 +117807,7 @@
}
},
"post": {
- "description": "Creates a SetupIntent object.
\n\nAfter the SetupIntent is created, attach a payment method and confirm\nto collect any required permissions to charge the payment method later.
",
+ "description": "Creates a SetupIntent object.
\n\nAfter you create the SetupIntent, attach a payment method and confirm\nit to collect any required permissions to charge the payment method later.
",
"operationId": "PostSetupIntents",
"requestBody": {
"content": {
@@ -109104,7 +117858,7 @@
"type": "boolean"
},
"automatic_payment_methods": {
- "description": "When enabled, this SetupIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this SetupIntent's other parameters.",
+ "description": "When you enable this parameter, this SetupIntent accepts payment methods that you enable in the Dashboard and that are compatible with its other parameters.",
"properties": {
"allow_redirects": {
"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.",
@@ -109126,7 +117880,7 @@
"type": "object"
},
"confirm": {
- "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If the payment method attached is a card, a return_url may be provided in case additional authentication is required.",
+ "description": "Set to `true` to attempt to confirm this SetupIntent immediately. This parameter defaults to `false`. If a card is the attached payment method, you can provide a `return_url` in case further authentication is necessary.",
"type": "boolean"
},
"customer": {
@@ -109159,64 +117913,74 @@
"type": "array"
},
"mandate_data": {
- "description": "This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).",
- "properties": {
- "customer_acceptance": {
- "description": "This hash contains details about the customer acceptance of the Mandate.",
+ "anyOf": [
+ {
"properties": {
- "accepted_at": {
- "description": "The time at which the customer accepted the Mandate.",
- "format": "unix-time",
- "type": "integer"
- },
- "offline": {
- "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
- "properties": {},
- "title": "offline_param",
- "type": "object"
- },
- "online": {
- "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
+ "customer_acceptance": {
+ "description": "This hash contains details about the customer acceptance of the Mandate.",
"properties": {
- "ip_address": {
- "description": "The IP address from which the Mandate was accepted by the customer.",
- "type": "string"
+ "accepted_at": {
+ "description": "The time at which the customer accepted the Mandate.",
+ "format": "unix-time",
+ "type": "integer"
},
- "user_agent": {
- "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
+ "offline": {
+ "description": "If this is a Mandate accepted offline, this hash contains details about the offline acceptance.",
+ "properties": {},
+ "title": "offline_param",
+ "type": "object"
+ },
+ "online": {
+ "description": "If this is a Mandate accepted online, this hash contains details about the online acceptance.",
+ "properties": {
+ "ip_address": {
+ "description": "The IP address from which the Mandate was accepted by the customer.",
+ "type": "string"
+ },
+ "user_agent": {
+ "description": "The user agent of the browser from which the Mandate was accepted by the customer.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "ip_address",
+ "user_agent"
+ ],
+ "title": "online_param",
+ "type": "object"
+ },
+ "type": {
+ "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
+ "enum": [
+ "offline",
+ "online"
+ ],
"maxLength": 5000,
"type": "string"
}
},
"required": [
- "ip_address",
- "user_agent"
+ "type"
],
- "title": "online_param",
+ "title": "customer_acceptance_param",
"type": "object"
- },
- "type": {
- "description": "The type of customer acceptance information included with the Mandate. One of `online` or `offline`.",
- "enum": [
- "offline",
- "online"
- ],
- "maxLength": 5000,
- "type": "string"
}
},
"required": [
- "type"
+ "customer_acceptance"
],
- "title": "customer_acceptance_param",
+ "title": "secret_key_param",
"type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
}
- },
- "required": [
- "customer_acceptance"
],
- "title": "secret_key_param",
- "type": "object"
+ "description": "This hash contains details about the mandate to create. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm)."
},
"metadata": {
"additionalProperties": {
@@ -109226,7 +117990,7 @@
"type": "object"
},
"on_behalf_of": {
- "description": "The Stripe account ID for which this SetupIntent is created.",
+ "description": "The Stripe account ID created for this SetupIntent.",
"type": "string"
},
"payment_method": {
@@ -109234,6 +117998,11 @@
"maxLength": 5000,
"type": "string"
},
+ "payment_method_configuration": {
+ "description": "The ID of the payment method configuration to use with this SetupIntent.",
+ "maxLength": 100,
+ "type": "string"
+ },
"payment_method_data": {
"description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
"properties": {
@@ -109391,14 +118160,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -109553,6 +118342,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -109837,7 +118627,7 @@
"type": "object"
},
"payment_method_options": {
- "description": "Payment-method-specific configuration for this SetupIntent.",
+ "description": "Payment method-specific configuration for this SetupIntent.",
"properties": {
"acss_debit": {
"description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.",
@@ -109918,18 +118708,6 @@
"title": "setup_intent_payment_method_options_param",
"type": "object"
},
- "blik": {
- "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
- "properties": {
- "code": {
- "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "setup_intent_payment_method_options_param",
- "type": "object"
- },
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
"properties": {
@@ -110050,7 +118828,7 @@
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
"properties": {
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
}
@@ -110104,6 +118882,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -110150,7 +118939,7 @@
"type": "object"
},
"payment_method_types": {
- "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to use. If this is not provided, defaults to [\"card\"].",
+ "description": "The list of payment method types (for example, card) that this SetupIntent can use. If you don't provide this, it defaults to [\"card\"].",
"items": {
"maxLength": 5000,
"type": "string"
@@ -110158,11 +118947,11 @@
"type": "array"
},
"return_url": {
- "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).",
+ "description": "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. To redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://stripe.com/docs/api/setup_intents/create#create_setup_intent-confirm).",
"type": "string"
},
"single_use": {
- "description": "If this hash is populated, this SetupIntent will generate a single_use Mandate on success.",
+ "description": "If you populate this hash, this SetupIntent generates a `single_use` mandate after successful completion.",
"properties": {
"amount": {
"description": "Amount the customer is granting permission to collect later. 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).",
@@ -110229,7 +119018,7 @@
"operationId": "GetSetupIntentsIntent",
"parameters": [
{
- "description": "The client secret of the SetupIntent. Required if a publishable key is used to retrieve the SetupIntent.",
+ "description": "The client secret of the SetupIntent. We require this string if you use a publishable key to retrieve the SetupIntent.",
"in": "query",
"name": "client_secret",
"required": false,
@@ -110403,6 +119192,11 @@
"maxLength": 5000,
"type": "string"
},
+ "payment_method_configuration": {
+ "description": "The ID of the payment method configuration to use with this SetupIntent.",
+ "maxLength": 100,
+ "type": "string"
+ },
"payment_method_data": {
"description": "When included, this hash creates a PaymentMethod that is set as the [`payment_method`](https://stripe.com/docs/api/setup_intents/object#setup_intent_object-payment_method)\nvalue in the SetupIntent.",
"properties": {
@@ -110560,14 +119354,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -110722,6 +119536,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -111006,7 +119821,7 @@
"type": "object"
},
"payment_method_options": {
- "description": "Payment-method-specific configuration for this SetupIntent.",
+ "description": "Payment method-specific configuration for this SetupIntent.",
"properties": {
"acss_debit": {
"description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.",
@@ -111087,18 +119902,6 @@
"title": "setup_intent_payment_method_options_param",
"type": "object"
},
- "blik": {
- "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
- "properties": {
- "code": {
- "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "setup_intent_payment_method_options_param",
- "type": "object"
- },
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
"properties": {
@@ -111219,7 +120022,7 @@
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
"properties": {
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
}
@@ -111273,6 +120076,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -111319,7 +120133,7 @@
"type": "object"
},
"payment_method_types": {
- "description": "The list of payment method types (e.g. card) that this SetupIntent is allowed to set up. If this is not provided, defaults to [\"card\"].",
+ "description": "The list of payment method types (for example, card) that this SetupIntent can set up. If you don't provide this array, it defaults to [\"card\"].",
"items": {
"maxLength": 5000,
"type": "string"
@@ -111359,7 +120173,7 @@
},
"/v1/setup_intents/{intent}/cancel": {
"post": {
- "description": "A SetupIntent object can be canceled when it is in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
\n\nOnce canceled, setup is abandoned and any operations on the SetupIntent will fail with an error.
",
+ "description": "You can cancel a SetupIntent object when it’s in one of these statuses: requires_payment_method, requires_confirmation, or requires_action.
\n\nAfter you cancel it, setup is abandoned and any operations on the SetupIntent fail with an error.
",
"operationId": "PostSetupIntentsIntentCancel",
"parameters": [
{
@@ -111386,7 +120200,7 @@
"additionalProperties": false,
"properties": {
"cancellation_reason": {
- "description": "Reason for canceling this SetupIntent. Possible values are `abandoned`, `requested_by_customer`, or `duplicate`",
+ "description": "Reason for canceling this SetupIntent. Possible values are: `abandoned`, `requested_by_customer`, or `duplicate`",
"enum": [
"abandoned",
"duplicate",
@@ -111544,6 +120358,13 @@
"type": "object"
},
{
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ },
+ {
+ "description": "This hash contains details about the Mandate to create",
"properties": {
"customer_acceptance": {
"description": "This hash contains details about the customer acceptance of the Mandate.",
@@ -111590,8 +120411,7 @@
"class_name": "MandateDataPublishableKey"
}
}
- ],
- "description": "This hash contains details about the Mandate to create"
+ ]
},
"payment_method": {
"description": "ID of the payment method (a PaymentMethod, Card, or saved Source object) to attach to this SetupIntent.",
@@ -111755,14 +120575,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -111917,6 +120757,7 @@
"ing",
"knab",
"moneyou",
+ "n26",
"rabobank",
"regiobank",
"revolut",
@@ -112201,7 +121042,7 @@
"type": "object"
},
"payment_method_options": {
- "description": "Payment-method-specific configuration for this SetupIntent.",
+ "description": "Payment method-specific configuration for this SetupIntent.",
"properties": {
"acss_debit": {
"description": "If this is a `acss_debit` SetupIntent, this sub-hash contains details about the ACSS Debit payment method options.",
@@ -112282,18 +121123,6 @@
"title": "setup_intent_payment_method_options_param",
"type": "object"
},
- "blik": {
- "description": "If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.",
- "properties": {
- "code": {
- "description": "The 6-digit BLIK code that a customer has generated using their banking application. Can only be set on confirmation.",
- "maxLength": 5000,
- "type": "string"
- }
- },
- "title": "setup_intent_payment_method_options_param",
- "type": "object"
- },
"card": {
"description": "Configuration for any card setup attempted on this SetupIntent.",
"properties": {
@@ -112414,7 +121243,7 @@
"description": "If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.",
"properties": {
"persistent_token": {
- "description": "Token used for persistent Link logins.",
+ "description": "[Deprecated] This is a legacy parameter that no longer has any function.",
"maxLength": 5000,
"type": "string"
}
@@ -112468,6 +121297,17 @@
},
"type": "array"
},
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
+ },
"return_url": {
"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.",
"maxLength": 5000,
@@ -115896,7 +124736,7 @@
"description": "Object representing the subscription schedule's default settings.",
"properties": {
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -115960,9 +124800,19 @@
"type": "string"
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -115994,7 +124844,7 @@
{
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -116144,7 +124994,7 @@
"type": "array"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -116235,9 +125085,19 @@
"description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase."
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
},
"end_date": {
"description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
@@ -116419,7 +125279,7 @@
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -116607,7 +125467,7 @@
"description": "Object representing the subscription schedule's default settings.",
"properties": {
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -116671,9 +125531,19 @@
"type": "string"
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -116705,7 +125575,7 @@
{
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -116850,7 +125720,7 @@
"type": "array"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -116941,9 +125811,19 @@
"description": "A list of [Tax Rate](https://stripe.com/docs/api/tax_rates) ids. These Tax Rates will set the Subscription's [`default_tax_rates`](https://stripe.com/docs/api/subscriptions/create#create_subscription-default_tax_rates), which means they will be the Invoice's [`default_tax_rates`](https://stripe.com/docs/api/invoices/create#create_invoice-default_tax_rates) for any Invoices issued by the Subscription during this Phase."
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
},
"end_date": {
"anyOf": [
@@ -117150,7 +126030,7 @@
"description": "The data with which to automatically create a Transfer for each of the associated subscription's invoices.",
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -117854,7 +126734,7 @@
"type": "array"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -118391,6 +127271,17 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"title": "invoice_linked_account_options_param",
@@ -118531,7 +127422,7 @@
"description": "If specified, the funds from the subscription's invoices will be transferred to the destination and the ID of the resulting transfers will be found on the resulting charges.",
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -118801,12 +127692,22 @@
"description": "Details about why this subscription was cancelled",
"properties": {
"comment": {
- "description": "Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."
},
"feedback": {
- "description": "The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user.",
+ "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
"enum": [
"",
"customer_service",
@@ -118937,7 +127838,7 @@
}
},
"post": {
- "description": "Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
",
+ "description": "Updates an existing subscription to match the specified parameters.\nWhen changing prices or quantities, we optionally prorate the price we charge next month to make up for any price changes.\nTo preview how the proration is calculated, use the upcoming invoice endpoint.
\n\nBy default, we prorate subscription changes. For example, if a customer signs up on May 1 for a 100 price, they’ll be billed 100 immediately. If on May 15 they switch to a 200 price, then on June 1 they’ll be billed 250 (200 for a renewal of her subscription, plus a 50 prorating adjustment for half of the previous month’s 100 difference). Similarly, a downgrade generates a credit that is applied to the next invoice. We also prorate when you make quantity changes.
\n\nSwitching prices does not normally change the billing date or generate an immediate charge unless:
\n\n\n- The billing interval is changed (for example, from monthly to yearly).
\n- The subscription moves from free to paid, or paid to free.
\n- A trial starts or ends.
\n
\n\nIn these cases, we apply a credit for the unused time on the previous price, immediately charge the customer using the new price, and reset the billing date.
\n\nIf you want to charge for an upgrade immediately, pass proration_behavior as always_invoice to create prorations, automatically invoice the customer for those proration adjustments, and attempt to collect payment. If you pass create_prorations, the prorations are created but not automatically invoiced. If you want to bill the customer for the prorations before the subscription’s renewal date, you need to manually invoice the customer.
\n\nIf you don’t want to prorate, set the proration_behavior option to none. With this option, the customer is billed 100 on May 1 and 200 on June 1. Similarly, if you set proration_behavior to none when switching between different billing intervals (for example, from monthly to yearly), we don’t generate any credits for the old subscription’s unused time. We still reset the billing date and bill immediately for the new subscription.
\n\nUpdating the quantity on a subscription many times in an hour may result in rate limiting. If you need to bill for a frequently changing quantity, consider integrating usage-based billing instead.
",
"operationId": "PostSubscriptionsSubscriptionExposedId",
"parameters": [
{
@@ -118975,10 +127876,18 @@
"explode": true,
"style": "deepObject"
},
+ "default_source": {
+ "explode": true,
+ "style": "deepObject"
+ },
"default_tax_rates": {
"explode": true,
"style": "deepObject"
},
+ "description": {
+ "explode": true,
+ "style": "deepObject"
+ },
"expand": {
"explode": true,
"style": "deepObject"
@@ -119102,7 +128011,7 @@
"type": "array"
},
"application_fee_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
+ "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. The request must be made by a platform account on a connected account in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
"type": "number"
},
"automatic_tax": {
@@ -119177,12 +128086,22 @@
"description": "Details about why this subscription was cancelled",
"properties": {
"comment": {
- "description": "Additional comments about why the user canceled the subscription, if the subscription was cancelled explicitly by the user.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user."
},
"feedback": {
- "description": "The customer submitted reason for why they cancelled, if the subscription was cancelled explicitly by the user.",
+ "description": "The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user.",
"enum": [
"",
"customer_service",
@@ -119223,9 +128142,19 @@
"type": "string"
},
"default_source": {
- "description": "ID of the default payment source for the subscription. It must belong to the customer associated with the subscription and be in a chargeable state. If `default_payment_method` is also set, `default_payment_method` will take precedence. If neither are set, invoices will use the customer's [invoice_settings.default_payment_method](https://stripe.com/docs/api/customers/object#customer_object-invoice_settings-default_payment_method) or [default_source](https://stripe.com/docs/api/customers/object#customer_object-default_source).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "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)."
},
"default_tax_rates": {
"anyOf": [
@@ -119246,9 +128175,19 @@
"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. Pass an empty string to remove previously-defined tax rates."
},
"description": {
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces.",
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "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."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -119723,6 +128662,17 @@
"x-stripeBypassValidation": true
},
"type": "array"
+ },
+ "prefetch": {
+ "description": "List of data features that you would like to retrieve upon account creation.",
+ "items": {
+ "enum": [
+ "balances"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "type": "array"
}
},
"title": "invoice_linked_account_options_param",
@@ -119869,7 +128819,7 @@
{
"properties": {
"amount_percent": {
- "description": "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the destination account. By default, the entire amount is transferred to the destination.",
+ "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.",
"type": "number"
},
"destination": {
@@ -120159,9 +129109,19 @@
"description": "The customer's postal address (for example, home or business location).",
"properties": {
"city": {
- "description": "City, district, suburb, town, or village.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "City, district, suburb, town, or village."
},
"country": {
"description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
@@ -120169,24 +129129,64 @@
"type": "string"
},
"line1": {
- "description": "Address line 1 (e.g., street, PO Box, or company name).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Address line 1 (e.g., street, PO Box, or company name)."
},
"line2": {
- "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building)."
},
"postal_code": {
- "description": "ZIP or postal code.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "ZIP or postal code."
},
"state": {
- "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\".",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "State, county, province, or region. We recommend sending [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2) subdivision code value when possible."
}
},
"required": [
@@ -120869,6 +129869,10 @@
},
"type": "array"
},
+ "flat_amount": {
+ "description": "A flat amount to reverse across the entire transaction, in negative integer cents. This value represents the total amount to refund from the transaction, including taxes.",
+ "type": "integer"
+ },
"line_items": {
"description": "The line item amounts to reverse.",
"items": {
@@ -122050,6 +131054,10 @@
"explode": true,
"style": "deepObject"
},
+ "offline": {
+ "explode": true,
+ "style": "deepObject"
+ },
"tipping": {
"explode": true,
"style": "deepObject"
@@ -122091,6 +131099,30 @@
},
"type": "array"
},
+ "offline": {
+ "anyOf": [
+ {
+ "properties": {
+ "enabled": {
+ "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "offline",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Configurations for collecting transactions offline."
+ },
"tipping": {
"anyOf": [
{
@@ -122662,6 +131694,10 @@
"explode": true,
"style": "deepObject"
},
+ "offline": {
+ "explode": true,
+ "style": "deepObject"
+ },
"tipping": {
"explode": true,
"style": "deepObject"
@@ -122713,6 +131749,30 @@
},
"type": "array"
},
+ "offline": {
+ "anyOf": [
+ {
+ "properties": {
+ "enabled": {
+ "description": "Determines whether to allow transactions to be collected while reader is offline. Defaults to false.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "offline",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Configurations for collecting transactions offline."
+ },
"tipping": {
"anyOf": [
{
@@ -123615,6 +132675,10 @@
"explode": true,
"style": "deepObject"
},
+ "configuration_overrides": {
+ "explode": true,
+ "style": "deepObject"
+ },
"expand": {
"explode": true,
"style": "deepObject"
@@ -123665,9 +132729,19 @@
"type": "object"
},
"configuration_overrides": {
- "description": "The ID of a configuration that will be used to customize all readers in this location.",
- "maxLength": 1000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 1000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The ID of a configuration that will be used to customize all readers in this location."
},
"display_name": {
"description": "A name for the location.",
@@ -123808,6 +132882,17 @@
},
"style": "form"
},
+ {
+ "description": "Filters readers by serial number",
+ "in": "query",
+ "name": "serial_number",
+ "required": false,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "form"
+ },
{
"description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list.",
"in": "query",
@@ -124147,6 +133232,10 @@
"explode": true,
"style": "deepObject"
},
+ "label": {
+ "explode": true,
+ "style": "deepObject"
+ },
"metadata": {
"explode": true,
"style": "deepObject"
@@ -124164,9 +133253,19 @@
"type": "array"
},
"label": {
- "description": "The new label of the reader.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The new label of the reader."
},
"metadata": {
"anyOf": [
@@ -124414,6 +133513,10 @@
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "process_config": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
@@ -124431,6 +133534,12 @@
},
"type": "array"
},
+ "process_config": {
+ "description": "Configuration overrides",
+ "properties": {},
+ "title": "process_setup_config",
+ "type": "object"
+ },
"setup_intent": {
"description": "SetupIntent ID",
"maxLength": 5000,
@@ -124788,6 +133897,981 @@
}
}
},
+ "/v1/test_helpers/issuing/authorizations": {
+ "post": {
+ "description": "Create a test-mode authorization.
",
+ "operationId": "PostTestHelpersIssuingAuthorizations",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "amount_details": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "merchant_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "network_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "verification_data": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "amount_details": {
+ "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).",
+ "properties": {
+ "atm_fee": {
+ "description": "The ATM withdrawal fee.",
+ "type": "integer"
+ },
+ "cashback_amount": {
+ "description": "The amount of cash requested by the cardholder.",
+ "type": "integer"
+ }
+ },
+ "title": "amount_details_specs",
+ "type": "object"
+ },
+ "authorization_method": {
+ "description": "How the card details were provided. Defaults to online.",
+ "enum": [
+ "chip",
+ "contactless",
+ "keyed_in",
+ "online",
+ "swipe"
+ ],
+ "type": "string"
+ },
+ "card": {
+ "description": "Card associated with this authorization.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of the authorization. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "is_amount_controllable": {
+ "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.",
+ "type": "boolean"
+ },
+ "merchant_data": {
+ "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
+ "properties": {
+ "category": {
+ "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.",
+ "enum": [
+ "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_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"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "city": {
+ "description": "City where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country": {
+ "description": "Country where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the seller",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "network_id": {
+ "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "Postal code where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "state": {
+ "description": "State where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "terminal_id": {
+ "description": "An ID assigned by the seller to the location of the sale.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "merchant_data_specs",
+ "type": "object"
+ },
+ "network_data": {
+ "description": "Details about the authorization, such as identifiers, set by the card network.",
+ "properties": {
+ "acquiring_institution_id": {
+ "description": "Identifier assigned to the acquirer by the card network.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "network_data_specs",
+ "type": "object"
+ },
+ "verification_data": {
+ "description": "Verifications that Stripe performed on information that the cardholder provided to the merchant.",
+ "properties": {
+ "address_line1_check": {
+ "description": "Whether the cardholder provided an address first line and if it matched the cardholder’s `billing.address.line1`.",
+ "enum": [
+ "match",
+ "mismatch",
+ "not_provided"
+ ],
+ "type": "string"
+ },
+ "address_postal_code_check": {
+ "description": "Whether the cardholder provided a postal code and if it matched the cardholder’s `billing.address.postal_code`.",
+ "enum": [
+ "match",
+ "mismatch",
+ "not_provided"
+ ],
+ "type": "string"
+ },
+ "cvc_check": {
+ "description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
+ "enum": [
+ "match",
+ "mismatch",
+ "not_provided"
+ ],
+ "type": "string"
+ },
+ "expiry_check": {
+ "description": "Whether the cardholder provided an expiry date and if it matched Stripe’s record.",
+ "enum": [
+ "match",
+ "mismatch",
+ "not_provided"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "verification_data_specs",
+ "type": "object"
+ },
+ "wallet": {
+ "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.",
+ "enum": [
+ "apple_pay",
+ "google_pay",
+ "samsung_pay"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "card"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/authorizations/{authorization}/capture": {
+ "post": {
+ "description": "Capture a test-mode authorization.
",
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationCapture",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "authorization",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "purchase_details": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "capture_amount": {
+ "description": "The amount to capture from the authorization. If not provided, the full amount of the authorization will be captured. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "close_authorization": {
+ "description": "Whether to close the authorization after capture. Defaults to true. Set to false to enable multi-capture flows.",
+ "type": "boolean"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "purchase_details": {
+ "description": "Additional purchase information that is optionally provided by the merchant.",
+ "properties": {
+ "flight": {
+ "description": "Information about the flight that was purchased with this transaction.",
+ "properties": {
+ "departure_at": {
+ "description": "The time that the flight departed.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "passenger_name": {
+ "description": "The name of the passenger.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "refundable": {
+ "description": "Whether the ticket is refundable.",
+ "type": "boolean"
+ },
+ "segments": {
+ "description": "The legs of the trip.",
+ "items": {
+ "properties": {
+ "arrival_airport_code": {
+ "description": "The three-letter IATA airport code of the flight's destination.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "carrier": {
+ "description": "The airline carrier code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "departure_airport_code": {
+ "description": "The three-letter IATA airport code that the flight departed from.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "flight_number": {
+ "description": "The flight number.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "service_class": {
+ "description": "The flight's service class.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "stopover_allowed": {
+ "description": "Whether a stopover is allowed on this flight.",
+ "type": "boolean"
+ }
+ },
+ "title": "flight_segment_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "travel_agency": {
+ "description": "The travel agency that issued the ticket.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "flight_specs",
+ "type": "object"
+ },
+ "fuel": {
+ "description": "Information about fuel that was purchased with this transaction.",
+ "properties": {
+ "type": {
+ "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
+ "enum": [
+ "diesel",
+ "other",
+ "unleaded_plus",
+ "unleaded_regular",
+ "unleaded_super"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit": {
+ "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.",
+ "enum": [
+ "liter",
+ "us_gallon"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit_cost_decimal": {
+ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "volume_decimal": {
+ "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ }
+ },
+ "title": "fuel_specs",
+ "type": "object"
+ },
+ "lodging": {
+ "description": "Information about lodging that was purchased with this transaction.",
+ "properties": {
+ "check_in_at": {
+ "description": "The time of checking into the lodging.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "nights": {
+ "description": "The number of nights stayed at the lodging.",
+ "type": "integer"
+ }
+ },
+ "title": "lodging_specs",
+ "type": "object"
+ },
+ "receipt": {
+ "description": "The line items in the purchase.",
+ "items": {
+ "properties": {
+ "description": {
+ "maxLength": 26,
+ "type": "string"
+ },
+ "quantity": {
+ "format": "decimal",
+ "type": "string"
+ },
+ "total": {
+ "type": "integer"
+ },
+ "unit_cost": {
+ "type": "integer"
+ }
+ },
+ "title": "receipt_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reference": {
+ "description": "A merchant-specific order number.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "purchase_details_specs",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/authorizations/{authorization}/expire": {
+ "post": {
+ "description": "Expire a test-mode Authorization.
",
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationExpire",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "authorization",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/authorizations/{authorization}/increment": {
+ "post": {
+ "description": "Increment a test-mode Authorization.
",
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationIncrement",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "authorization",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "increment_amount": {
+ "description": "The amount to increment the authorization by. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "is_amount_controllable": {
+ "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.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "increment_amount"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/authorizations/{authorization}/reverse": {
+ "post": {
+ "description": "Reverse a test-mode Authorization.
",
+ "operationId": "PostTestHelpersIssuingAuthorizationsAuthorizationReverse",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "authorization",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "reverse_amount": {
+ "description": "The amount to reverse from the authorization. If not provided, the full amount of the authorization will be reversed. This amount is in the authorization currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.authorization"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
"/v1/test_helpers/issuing/cards/{card}/shipping/deliver": {
"post": {
"description": "Updates the shipping status of the specified Issuing Card object to delivered.
",
@@ -124855,22 +134939,211 @@
}
}
},
- "/v1/test_helpers/issuing/cards/{card}/shipping/fail": {
+ "/v1/test_helpers/issuing/cards/{card}/shipping/fail": {
+ "post": {
+ "description": "Updates the shipping status of the specified Issuing Card object to failure.
",
+ "operationId": "PostTestHelpersIssuingCardsCardShippingFail",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "card",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/cards/{card}/shipping/return": {
+ "post": {
+ "description": "Updates the shipping status of the specified Issuing Card object to returned.
",
+ "operationId": "PostTestHelpersIssuingCardsCardShippingReturn",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "card",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/cards/{card}/shipping/ship": {
+ "post": {
+ "description": "Updates the shipping status of the specified Issuing Card object to shipped.
",
+ "operationId": "PostTestHelpersIssuingCardsCardShippingShip",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "card",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/issuing.card"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/test_helpers/issuing/transactions/create_force_capture": {
"post": {
- "description": "Updates the shipping status of the specified Issuing Card object to failure.
",
- "operationId": "PostTestHelpersIssuingCardsCardShippingFail",
- "parameters": [
- {
- "in": "path",
- "name": "card",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
+ "description": "Allows the user to capture an arbitrary amount, also known as a forced capture.
",
+ "operationId": "PostTestHelpersIssuingTransactionsCreateForceCapture",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
@@ -124878,11 +135151,32 @@
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "merchant_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "purchase_details": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
+ "amount": {
+ "description": "The total amount to attempt to capture. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "card": {
+ "description": "Card associated with this transaction.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of the capture. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -124890,20 +135184,522 @@
"type": "string"
},
"type": "array"
+ },
+ "merchant_data": {
+ "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
+ "properties": {
+ "category": {
+ "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.",
+ "enum": [
+ "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_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"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "city": {
+ "description": "City where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country": {
+ "description": "Country where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the seller",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "network_id": {
+ "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "Postal code where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "state": {
+ "description": "State where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "terminal_id": {
+ "description": "An ID assigned by the seller to the location of the sale.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "merchant_data_specs",
+ "type": "object"
+ },
+ "purchase_details": {
+ "description": "Additional purchase information that is optionally provided by the merchant.",
+ "properties": {
+ "flight": {
+ "description": "Information about the flight that was purchased with this transaction.",
+ "properties": {
+ "departure_at": {
+ "description": "The time that the flight departed.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "passenger_name": {
+ "description": "The name of the passenger.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "refundable": {
+ "description": "Whether the ticket is refundable.",
+ "type": "boolean"
+ },
+ "segments": {
+ "description": "The legs of the trip.",
+ "items": {
+ "properties": {
+ "arrival_airport_code": {
+ "description": "The three-letter IATA airport code of the flight's destination.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "carrier": {
+ "description": "The airline carrier code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "departure_airport_code": {
+ "description": "The three-letter IATA airport code that the flight departed from.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "flight_number": {
+ "description": "The flight number.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "service_class": {
+ "description": "The flight's service class.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "stopover_allowed": {
+ "description": "Whether a stopover is allowed on this flight.",
+ "type": "boolean"
+ }
+ },
+ "title": "flight_segment_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "travel_agency": {
+ "description": "The travel agency that issued the ticket.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "flight_specs",
+ "type": "object"
+ },
+ "fuel": {
+ "description": "Information about fuel that was purchased with this transaction.",
+ "properties": {
+ "type": {
+ "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
+ "enum": [
+ "diesel",
+ "other",
+ "unleaded_plus",
+ "unleaded_regular",
+ "unleaded_super"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit": {
+ "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.",
+ "enum": [
+ "liter",
+ "us_gallon"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit_cost_decimal": {
+ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "volume_decimal": {
+ "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ }
+ },
+ "title": "fuel_specs",
+ "type": "object"
+ },
+ "lodging": {
+ "description": "Information about lodging that was purchased with this transaction.",
+ "properties": {
+ "check_in_at": {
+ "description": "The time of checking into the lodging.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "nights": {
+ "description": "The number of nights stayed at the lodging.",
+ "type": "integer"
+ }
+ },
+ "title": "lodging_specs",
+ "type": "object"
+ },
+ "receipt": {
+ "description": "The line items in the purchase.",
+ "items": {
+ "properties": {
+ "description": {
+ "maxLength": 26,
+ "type": "string"
+ },
+ "quantity": {
+ "format": "decimal",
+ "type": "string"
+ },
+ "total": {
+ "type": "integer"
+ },
+ "unit_cost": {
+ "type": "integer"
+ }
+ },
+ "title": "receipt_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reference": {
+ "description": "A merchant-specific order number.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "purchase_details_specs",
+ "type": "object"
}
},
+ "required": [
+ "amount",
+ "card"
+ ],
"type": "object"
}
}
},
- "required": false
+ "required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/issuing.card"
+ "$ref": "#/components/schemas/issuing.transaction"
}
}
},
@@ -124922,22 +135718,10 @@
}
}
},
- "/v1/test_helpers/issuing/cards/{card}/shipping/return": {
+ "/v1/test_helpers/issuing/transactions/create_unlinked_refund": {
"post": {
- "description": "Updates the shipping status of the specified Issuing Card object to returned.
",
- "operationId": "PostTestHelpersIssuingCardsCardShippingReturn",
- "parameters": [
- {
- "in": "path",
- "name": "card",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- }
- ],
+ "description": "Allows the user to refund an arbitrary amount, also known as a unlinked refund.
",
+ "operationId": "PostTestHelpersIssuingTransactionsCreateUnlinkedRefund",
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
@@ -124945,11 +135729,32 @@
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "merchant_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "purchase_details": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
+ "amount": {
+ "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
+ },
+ "card": {
+ "description": "Card associated with this unlinked refund transaction.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "currency": {
+ "description": "The currency of the unlinked refund. If not provided, defaults to the currency of the card. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -124957,20 +135762,522 @@
"type": "string"
},
"type": "array"
+ },
+ "merchant_data": {
+ "description": "Details about the seller (grocery store, e-commerce website, etc.) where the card authorization happened.",
+ "properties": {
+ "category": {
+ "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.",
+ "enum": [
+ "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_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"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "city": {
+ "description": "City where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country": {
+ "description": "Country where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "name": {
+ "description": "Name of the seller",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "network_id": {
+ "description": "Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "Postal code where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "state": {
+ "description": "State where the seller is located",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "terminal_id": {
+ "description": "An ID assigned by the seller to the location of the sale.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "merchant_data_specs",
+ "type": "object"
+ },
+ "purchase_details": {
+ "description": "Additional purchase information that is optionally provided by the merchant.",
+ "properties": {
+ "flight": {
+ "description": "Information about the flight that was purchased with this transaction.",
+ "properties": {
+ "departure_at": {
+ "description": "The time that the flight departed.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "passenger_name": {
+ "description": "The name of the passenger.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "refundable": {
+ "description": "Whether the ticket is refundable.",
+ "type": "boolean"
+ },
+ "segments": {
+ "description": "The legs of the trip.",
+ "items": {
+ "properties": {
+ "arrival_airport_code": {
+ "description": "The three-letter IATA airport code of the flight's destination.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "carrier": {
+ "description": "The airline carrier code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "departure_airport_code": {
+ "description": "The three-letter IATA airport code that the flight departed from.",
+ "maxLength": 3,
+ "type": "string"
+ },
+ "flight_number": {
+ "description": "The flight number.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "service_class": {
+ "description": "The flight's service class.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "stopover_allowed": {
+ "description": "Whether a stopover is allowed on this flight.",
+ "type": "boolean"
+ }
+ },
+ "title": "flight_segment_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "travel_agency": {
+ "description": "The travel agency that issued the ticket.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "flight_specs",
+ "type": "object"
+ },
+ "fuel": {
+ "description": "Information about fuel that was purchased with this transaction.",
+ "properties": {
+ "type": {
+ "description": "The type of fuel that was purchased. One of `diesel`, `unleaded_plus`, `unleaded_regular`, `unleaded_super`, or `other`.",
+ "enum": [
+ "diesel",
+ "other",
+ "unleaded_plus",
+ "unleaded_regular",
+ "unleaded_super"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit": {
+ "description": "The units for `volume_decimal`. One of `us_gallon` or `liter`.",
+ "enum": [
+ "liter",
+ "us_gallon"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "unit_cost_decimal": {
+ "description": "The cost in cents per each unit of fuel, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "volume_decimal": {
+ "description": "The volume of the fuel that was pumped, represented as a decimal string with at most 12 decimal places.",
+ "format": "decimal",
+ "type": "string"
+ }
+ },
+ "title": "fuel_specs",
+ "type": "object"
+ },
+ "lodging": {
+ "description": "Information about lodging that was purchased with this transaction.",
+ "properties": {
+ "check_in_at": {
+ "description": "The time of checking into the lodging.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "nights": {
+ "description": "The number of nights stayed at the lodging.",
+ "type": "integer"
+ }
+ },
+ "title": "lodging_specs",
+ "type": "object"
+ },
+ "receipt": {
+ "description": "The line items in the purchase.",
+ "items": {
+ "properties": {
+ "description": {
+ "maxLength": 26,
+ "type": "string"
+ },
+ "quantity": {
+ "format": "decimal",
+ "type": "string"
+ },
+ "total": {
+ "type": "integer"
+ },
+ "unit_cost": {
+ "type": "integer"
+ }
+ },
+ "title": "receipt_specs",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "reference": {
+ "description": "A merchant-specific order number.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "purchase_details_specs",
+ "type": "object"
}
},
+ "required": [
+ "amount",
+ "card"
+ ],
"type": "object"
}
}
},
- "required": false
+ "required": true
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/issuing.card"
+ "$ref": "#/components/schemas/issuing.transaction"
}
}
},
@@ -124989,14 +136296,14 @@
}
}
},
- "/v1/test_helpers/issuing/cards/{card}/shipping/ship": {
+ "/v1/test_helpers/issuing/transactions/{transaction}/refund": {
"post": {
- "description": "Updates the shipping status of the specified Issuing Card object to shipped.
",
- "operationId": "PostTestHelpersIssuingCardsCardShippingShip",
+ "description": "Refund a test-mode Transaction.
",
+ "operationId": "PostTestHelpersIssuingTransactionsTransactionRefund",
"parameters": [
{
"in": "path",
- "name": "card",
+ "name": "transaction",
"required": true,
"schema": {
"maxLength": 5000,
@@ -125024,6 +136331,10 @@
"type": "string"
},
"type": "array"
+ },
+ "refund_amount": {
+ "description": "The total amount to attempt to refund. This amount is in the provided currency, or defaults to the cards currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "type": "integer"
}
},
"type": "object"
@@ -125037,7 +136348,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/issuing.card"
+ "$ref": "#/components/schemas/issuing.transaction"
}
}
},
@@ -126566,7 +137877,7 @@
},
"/v1/tokens": {
"post": {
- "description": "Creates a single-use token that represents a bank account’s details.\nThis token can be used with any API method in place of a bank account dictionary. This token can be used only once, by attaching it to a Custom account.
",
+ "description": "Creates a single-use token that represents a bank account’s details.\nYou can use this token with any API method in place of a bank account dictionary. You can only use this token once. To do so, attach it to a Custom account.
",
"operationId": "PostTokens",
"requestBody": {
"content": {
@@ -126605,7 +137916,7 @@
"additionalProperties": false,
"properties": {
"account": {
- "description": "Information for the account this token will represent.",
+ "description": "Information for the account this token represents.",
"properties": {
"business_type": {
"description": "The business type.",
@@ -126823,6 +138134,7 @@
"government_instrumentality",
"governmental_unit",
"incorporated_non_profit",
+ "incorporated_partnership",
"limited_liability_partnership",
"llc",
"multi_member_llc",
@@ -126837,7 +138149,8 @@
"sole_proprietorship",
"tax_exempt_government_instrumentality",
"unincorporated_association",
- "unincorporated_non_profit"
+ "unincorporated_non_profit",
+ "unincorporated_partnership"
],
"type": "string",
"x-stripeBypassValidation": true
@@ -127085,12 +138398,12 @@
"type": "string"
},
"id_number": {
- "description": "The government-issued ID number of the individual, as appropriate for the representative’s country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -127299,50 +138612,62 @@
{
"properties": {
"address_city": {
+ "description": "City / District / Suburb / Town / Village.",
"maxLength": 5000,
"type": "string"
},
"address_country": {
+ "description": "Billing address country, if provided.",
"maxLength": 5000,
"type": "string"
},
"address_line1": {
+ "description": "Address line 1 (Street address / PO Box / Company name).",
"maxLength": 5000,
"type": "string"
},
"address_line2": {
+ "description": "Address line 2 (Apartment / Suite / Unit / Building).",
"maxLength": 5000,
"type": "string"
},
"address_state": {
+ "description": "State / County / Province / Region.",
"maxLength": 5000,
"type": "string"
},
"address_zip": {
+ "description": "ZIP or postal code.",
"maxLength": 5000,
"type": "string"
},
"currency": {
+ "description": "Required in order to add the card to an account; in all other cases, this parameter is not used. When added to an account, the card (which must be a debit card) can be used as a transfer destination for funds in this currency.",
"maxLength": 5000,
"type": "string"
},
"cvc": {
+ "description": "Card security code. Highly recommended to always include this value.",
"maxLength": 5000,
"type": "string"
},
"exp_month": {
+ "description": "Two-digit number representing the card's expiration month.",
"maxLength": 5000,
"type": "string"
},
"exp_year": {
+ "description": "Two- or four-digit number representing the card's expiration year.",
"maxLength": 5000,
"type": "string"
},
"name": {
+ "description": "Cardholder's full name.",
"maxLength": 5000,
"type": "string"
},
"number": {
+ "description": "The card number, as a string without any separators.",
"maxLength": 5000,
"type": "string"
}
@@ -127363,15 +138688,16 @@
"type": "string"
}
],
+ "description": "The card this token will represent. If you also pass in a customer, the card must be the ID of a card belonging to the customer. Otherwise, if you do not pass in a customer, this is a dictionary containing a user's credit card details, with the options described below.",
"x-stripeBypassValidation": true
},
"customer": {
- "description": "The customer (owned by the application's account) for which to create a token. This can be used only with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). For more details, see [Cloning Saved Payment Methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).",
+ "description": "Create a token for the customer, which is owned by the application's account. You can only use this with an [OAuth access token](https://stripe.com/docs/connect/standard-accounts) or [Stripe-Account header](https://stripe.com/docs/connect/authentication). Learn more about [cloning saved payment methods](https://stripe.com/docs/connect/cloning-saved-payment-methods).",
"maxLength": 5000,
"type": "string"
},
"cvc_update": {
- "description": "The updated CVC value this token will represent.",
+ "description": "The updated CVC value this token represents.",
"properties": {
"cvc": {
"description": "The CVC value, in string form.",
@@ -127394,8 +138720,46 @@
"type": "array"
},
"person": {
- "description": "Information for the person this token will represent.",
+ "description": "Information for the person this token represents.",
"properties": {
+ "additional_tos_acceptances": {
+ "description": "Details on the legal guardian's acceptance of the required Stripe agreements.",
+ "properties": {
+ "account": {
+ "description": "Details on the legal guardian's acceptance of the main Stripe service agreement.",
+ "properties": {
+ "date": {
+ "description": "The Unix timestamp marking when the account representative accepted the service agreement.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "ip": {
+ "description": "The IP address from which the account representative accepted the service agreement.",
+ "type": "string"
+ },
+ "user_agent": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The user agent of the browser from which the account representative accepted the service agreement."
+ }
+ },
+ "title": "settings_terms_of_service_specs",
+ "type": "object"
+ }
+ },
+ "title": "person_additional_tos_acceptances_specs",
+ "type": "object"
+ },
"address": {
"description": "The person's address.",
"properties": {
@@ -127560,8 +138924,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -127575,8 +138949,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -127590,8 +138974,18 @@
"files": {
"description": "One or more document ids returned by a [file upload](https://stripe.com/docs/api#create_file) with a `purpose` value of `account_requirement`.",
"items": {
- "maxLength": 500,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ]
},
"type": "array"
}
@@ -127645,12 +139039,12 @@
"type": "string"
},
"id_number": {
- "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
"id_number_secondary": {
- "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens_sources/create_token?type=pii).",
+ "description": "The person's secondary ID number, as appropriate for their country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token provided by Stripe.js](https://stripe.com/docs/js/tokens/create_token?type=pii).",
"maxLength": 5000,
"type": "string"
},
@@ -127753,6 +139147,10 @@
"description": "Whether the person has significant responsibility to control, manage, or direct the organization.",
"type": "boolean"
},
+ "legal_guardian": {
+ "description": "Whether the person is the legal guardian of the account's representative.",
+ "type": "boolean"
+ },
"owner": {
"description": "Whether the person is an owner of the account’s legal entity.",
"type": "boolean"
@@ -127834,7 +139232,7 @@
"type": "object"
},
"pii": {
- "description": "The PII this token will represent.",
+ "description": "The PII this token represents.",
"properties": {
"id_number": {
"description": "The `id_number` for the PII, in string form.",
@@ -130272,7 +141670,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundPayments API.",
+ "description": "Enables US domestic wire transfers via the OutboundPayments API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -130307,7 +141705,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundTransfers API.",
+ "description": "Enables US domestic wire transfers via the OutboundTransfers API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -130619,7 +142017,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundPayments API.",
+ "description": "Enables US domestic wire transfers via the OutboundPayments API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -130654,7 +142052,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundTransfers API.",
+ "description": "Enables US domestic wire transfers via the OutboundTransfers API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -130968,7 +142366,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundPayments API.",
+ "description": "Enables US domestic wire transfers via the OutboundPayments API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -131003,7 +142401,7 @@
"type": "object"
},
"us_domestic_wire": {
- "description": "Enables US domestic wire tranfers via the OutboundTransfers API.",
+ "description": "Enables US domestic wire transfers via the OutboundTransfers API.",
"properties": {
"requested": {
"description": "Whether the FinancialAccount should have the Feature.",
@@ -131721,14 +143119,34 @@
"description": "Email address."
},
"name": {
- "description": "Full name.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Full name."
},
"phone": {
- "description": "Billing phone number (including extension).",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Billing phone number (including extension)."
}
},
"title": "billing_details_inner_params",
@@ -133677,6 +145095,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "description": {
+ "explode": true,
+ "style": "deepObject"
+ },
"enabled_events": {
"explode": true,
"style": "deepObject"
@@ -133793,7 +145215,9 @@
"2020-03-02",
"2020-08-27",
"2022-08-01",
- "2022-11-15"
+ "2022-11-15",
+ "2023-08-16",
+ "2023-10-16"
],
"maxLength": 5000,
"type": "string",
@@ -133804,9 +145228,19 @@
"type": "boolean"
},
"description": {
- "description": "An optional description of what the webhook is used for.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An optional description of what the webhook is used for."
},
"enabled_events": {
"description": "The list of events to enable for this endpoint. You may specify `['*']` to enable all events, except those that require explicit selection.",
@@ -133900,7 +145334,6 @@
"invoice.voided",
"invoiceitem.created",
"invoiceitem.deleted",
- "invoiceitem.updated",
"issuing_authorization.created",
"issuing_authorization.request",
"issuing_authorization.updated",
@@ -133913,10 +145346,11 @@
"issuing_dispute.funds_reinstated",
"issuing_dispute.submitted",
"issuing_dispute.updated",
+ "issuing_token.created",
+ "issuing_token.updated",
"issuing_transaction.created",
"issuing_transaction.updated",
"mandate.updated",
- "order.created",
"payment_intent.amount_capturable_updated",
"payment_intent.canceled",
"payment_intent.created",
@@ -133957,9 +145391,6 @@
"quote.finalized",
"radar.early_fraud_warning.created",
"radar.early_fraud_warning.updated",
- "recipient.created",
- "recipient.deleted",
- "recipient.updated",
"refund.created",
"refund.updated",
"reporting.report_run.failed",
@@ -133973,9 +145404,6 @@
"setup_intent.setup_failed",
"setup_intent.succeeded",
"sigma.scheduled_query_run.created",
- "sku.created",
- "sku.deleted",
- "sku.updated",
"source.canceled",
"source.chargeable",
"source.failed",
@@ -134243,6 +145671,10 @@
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "description": {
+ "explode": true,
+ "style": "deepObject"
+ },
"enabled_events": {
"explode": true,
"style": "deepObject"
@@ -134260,9 +145692,19 @@
"additionalProperties": false,
"properties": {
"description": {
- "description": "An optional description of what the webhook is used for.",
- "maxLength": 5000,
- "type": "string"
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An optional description of what the webhook is used for."
},
"disabled": {
"description": "Disable the webhook endpoint if set to true.",
@@ -134360,7 +145802,6 @@
"invoice.voided",
"invoiceitem.created",
"invoiceitem.deleted",
- "invoiceitem.updated",
"issuing_authorization.created",
"issuing_authorization.request",
"issuing_authorization.updated",
@@ -134373,10 +145814,11 @@
"issuing_dispute.funds_reinstated",
"issuing_dispute.submitted",
"issuing_dispute.updated",
+ "issuing_token.created",
+ "issuing_token.updated",
"issuing_transaction.created",
"issuing_transaction.updated",
"mandate.updated",
- "order.created",
"payment_intent.amount_capturable_updated",
"payment_intent.canceled",
"payment_intent.created",
@@ -134417,9 +145859,6 @@
"quote.finalized",
"radar.early_fraud_warning.created",
"radar.early_fraud_warning.updated",
- "recipient.created",
- "recipient.deleted",
- "recipient.updated",
"refund.created",
"refund.updated",
"reporting.report_run.failed",
@@ -134433,9 +145872,6 @@
"setup_intent.setup_failed",
"setup_intent.succeeded",
"sigma.scheduled_query_run.created",
- "sku.created",
- "sku.deleted",
- "sku.updated",
"source.canceled",
"source.chargeable",
"source.failed",
diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go
index 3080ae8f6..61fde6a56 100644
--- a/pkg/cmd/resources_cmds.go
+++ b/pkg/cmd/resources_cmds.go
@@ -28,6 +28,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
// Resource commands
rAccountLinksCmd := resource.NewResourceCmd(rootCmd, "account_links")
+ rAccountSessionsCmd := resource.NewResourceCmd(rootCmd, "account_sessions")
rAccountsCmd := resource.NewResourceCmd(rootCmd, "accounts")
rApplePayDomainsCmd := resource.NewResourceCmd(rootCmd, "apple_pay_domains")
rApplicationFeesCmd := resource.NewResourceCmd(rootCmd, "application_fees")
@@ -61,6 +62,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
rMandatesCmd := resource.NewResourceCmd(rootCmd, "mandates")
rPaymentIntentsCmd := resource.NewResourceCmd(rootCmd, "payment_intents")
rPaymentLinksCmd := resource.NewResourceCmd(rootCmd, "payment_links")
+ rPaymentMethodConfigurationsCmd := resource.NewResourceCmd(rootCmd, "payment_method_configurations")
+ rPaymentMethodDomainsCmd := resource.NewResourceCmd(rootCmd, "payment_method_domains")
rPaymentMethodsCmd := resource.NewResourceCmd(rootCmd, "payment_methods")
rPaymentSourcesCmd := resource.NewResourceCmd(rootCmd, "payment_sources")
rPayoutsCmd := resource.NewResourceCmd(rootCmd, "payouts")
@@ -100,11 +103,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
rIdentityVerificationReportsCmd := resource.NewResourceCmd(nsIdentityCmd.Cmd, "verification_reports")
rIdentityVerificationSessionsCmd := resource.NewResourceCmd(nsIdentityCmd.Cmd, "verification_sessions")
rIssuingAuthorizationsCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "authorizations")
+ rIssuingAuthorizationsTestHelpersCmd := resource.NewResourceCmd(rIssuingAuthorizationsCmd.Cmd, "test_helpers")
rIssuingCardholdersCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "cardholders")
rIssuingCardsCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "cards")
rIssuingCardsTestHelpersCmd := resource.NewResourceCmd(rIssuingCardsCmd.Cmd, "test_helpers")
rIssuingDisputesCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "disputes")
+ rIssuingTokensCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "tokens")
rIssuingTransactionsCmd := resource.NewResourceCmd(nsIssuingCmd.Cmd, "transactions")
+ rIssuingTransactionsTestHelpersCmd := resource.NewResourceCmd(rIssuingTransactionsCmd.Cmd, "test_helpers")
rRadarEarlyFraudWarningsCmd := resource.NewResourceCmd(nsRadarCmd.Cmd, "early_fraud_warnings")
rRadarValueListItemsCmd := resource.NewResourceCmd(nsRadarCmd.Cmd, "value_list_items")
rRadarValueListsCmd := resource.NewResourceCmd(nsRadarCmd.Cmd, "value_lists")
@@ -120,7 +126,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
rTerminalReadersTestHelpersCmd := resource.NewResourceCmd(rTerminalReadersCmd.Cmd, "test_helpers")
rTestHelpersCustomersCmd := resource.NewResourceCmd(nsTestHelpersCmd.Cmd, "customers")
rTestHelpersIssuingCmd := resource.NewResourceCmd(nsTestHelpersCmd.Cmd, "issuing")
+ rTestHelpersIssuingAuthorizationsCmd := resource.NewResourceCmd(rTestHelpersIssuingCmd.Cmd, "authorizations")
rTestHelpersIssuingCardsCmd := resource.NewResourceCmd(rTestHelpersIssuingCmd.Cmd, "cards")
+ rTestHelpersIssuingTransactionsCmd := resource.NewResourceCmd(rTestHelpersIssuingCmd.Cmd, "transactions")
rTestHelpersRefundsCmd := resource.NewResourceCmd(nsTestHelpersCmd.Cmd, "refunds")
rTestHelpersTerminalCmd := resource.NewResourceCmd(nsTestHelpersCmd.Cmd, "terminal")
rTestHelpersTerminalReadersCmd := resource.NewResourceCmd(rTestHelpersTerminalCmd.Cmd, "readers")
@@ -155,10 +163,16 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"return_url": "string",
"type": "string",
}, &Config)
+ resource.NewOperationCmd(rAccountSessionsCmd.Cmd, "create", "/v1/account_sessions", http.MethodPost, map[string]string{
+ "account": "string",
+ "components.account_onboarding.enabled": "boolean",
+ }, &Config)
resource.NewOperationCmd(rAccountsCmd.Cmd, "capabilities", "/v1/accounts/{account}/capabilities", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rAccountsCmd.Cmd, "create", "/v1/accounts", http.MethodPost, map[string]string{
- "account_token": "string",
- "business_profile.mcc": "string",
+ "account_token": "string",
+ "business_profile.mcc": "string",
+ "business_profile.monthly_estimated_revenue.amount": "integer",
+ "business_profile.monthly_estimated_revenue.currency": "string",
"business_profile.name": "string",
"business_profile.product_description": "string",
"business_profile.support_address.city": "string",
@@ -350,8 +364,10 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rAccountsCmd.Cmd, "retrieve", "/v1/account", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rAccountsCmd.Cmd, "update", "/v1/accounts/{account}", http.MethodPost, map[string]string{
- "account_token": "string",
- "business_profile.mcc": "string",
+ "account_token": "string",
+ "business_profile.mcc": "string",
+ "business_profile.monthly_estimated_revenue.amount": "integer",
+ "business_profile.monthly_estimated_revenue.currency": "string",
"business_profile.name": "string",
"business_profile.product_description": "string",
"business_profile.support_address.city": "string",
@@ -545,7 +561,6 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
resource.NewOperationCmd(rApplicationFeesCmd.Cmd, "retrieve", "/v1/application_fees/{id}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rBalanceCmd.Cmd, "retrieve", "/v1/balance", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rBalanceTransactionsCmd.Cmd, "list", "/v1/balance_transactions", http.MethodGet, map[string]string{
- "available_on": "integer",
"created": "integer",
"currency": "string",
"ending_before": "string",
@@ -913,6 +928,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
resource.NewOperationCmd(rEphemeralKeysCmd.Cmd, "create", "/v1/ephemeral_keys", http.MethodPost, map[string]string{
"customer": "string",
"issuing_card": "string",
+ "nonce": "string",
"verification_session": "string",
}, &Config)
resource.NewOperationCmd(rEphemeralKeysCmd.Cmd, "delete", "/v1/ephemeral_keys/{key}", http.MethodDelete, map[string]string{}, &Config)
@@ -940,6 +956,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
resource.NewOperationCmd(rExternalAccountsCmd.Cmd, "list", "/v1/accounts/{account}/external_accounts", http.MethodGet, map[string]string{
"ending_before": "string",
"limit": "integer",
+ "object": "string",
"starting_after": "string",
}, &Config)
resource.NewOperationCmd(rExternalAccountsCmd.Cmd, "retrieve", "/v1/accounts/{account}/external_accounts/{id}", http.MethodGet, map[string]string{}, &Config)
@@ -1069,6 +1086,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_settings.default_mandate": "string",
"payment_settings.payment_method_types": "array",
"pending_invoice_items_behavior": "string",
+ "rendering.amount_tax_display": "string",
+ "rendering.pdf.page_size": "string",
"shipping_cost.shipping_rate": "string",
"shipping_cost.shipping_rate_data.delivery_estimate.maximum.unit": "string",
"shipping_cost.shipping_rate_data.delivery_estimate.maximum.value": "integer",
@@ -1180,6 +1199,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"on_behalf_of": "string",
"payment_settings.default_mandate": "string",
"payment_settings.payment_method_types": "array",
+ "rendering.amount_tax_display": "string",
+ "rendering.pdf.page_size": "string",
"statement_descriptor": "string",
}, &Config)
resource.NewOperationCmd(rInvoicesCmd.Cmd, "void_invoice", "/v1/invoices/{invoice}/void", http.MethodPost, map[string]string{}, &Config)
@@ -1200,6 +1221,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
resource.NewOperationCmd(rPaymentIntentsCmd.Cmd, "capture", "/v1/payment_intents/{intent}/capture", http.MethodPost, map[string]string{
"amount_to_capture": "integer",
"application_fee_amount": "integer",
+ "final_capture": "boolean",
"statement_descriptor": "string",
"statement_descriptor_suffix": "string",
"transfer_data.amount": "integer",
@@ -1257,13 +1279,10 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"description": "string",
"error_on_requires_action": "boolean",
"mandate": "string",
- "mandate_data.customer_acceptance.accepted_at": "integer",
- "mandate_data.customer_acceptance.online.ip_address": "string",
- "mandate_data.customer_acceptance.online.user_agent": "string",
- "mandate_data.customer_acceptance.type": "string",
- "off_session": "boolean",
- "on_behalf_of": "string",
- "payment_method": "string",
+ "off_session": "boolean",
+ "on_behalf_of": "string",
+ "payment_method": "string",
+ "payment_method_configuration": "string",
"payment_method_data.acss_debit.account_number": "string",
"payment_method_data.acss_debit.institution_number": "string",
"payment_method_data.acss_debit.transit_number": "string",
@@ -1337,13 +1356,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"query": "string",
}, &Config)
resource.NewOperationCmd(rPaymentIntentsCmd.Cmd, "update", "/v1/payment_intents/{intent}", http.MethodPost, map[string]string{
- "amount": "integer",
- "application_fee_amount": "integer",
- "capture_method": "string",
- "currency": "string",
- "customer": "string",
- "description": "string",
- "payment_method": "string",
+ "amount": "integer",
+ "application_fee_amount": "integer",
+ "capture_method": "string",
+ "currency": "string",
+ "customer": "string",
+ "description": "string",
+ "payment_method": "string",
+ "payment_method_configuration": "string",
"payment_method_data.acss_debit.account_number": "string",
"payment_method_data.acss_debit.institution_number": "string",
"payment_method_data.acss_debit.transit_number": "string",
@@ -1404,6 +1424,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"on_behalf_of": "string",
"payment_intent_data.capture_method": "string",
"payment_intent_data.setup_future_usage": "string",
+ "payment_intent_data.statement_descriptor": "string",
+ "payment_intent_data.statement_descriptor_suffix": "string",
"payment_method_collection": "string",
"payment_method_types": "array",
"phone_number_collection.enabled": "boolean",
@@ -1440,9 +1462,105 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"invoice_creation.invoice_data.account_tax_ids": "array",
"invoice_creation.invoice_data.description": "string",
"invoice_creation.invoice_data.footer": "string",
+ "payment_intent_data.statement_descriptor": "string",
+ "payment_intent_data.statement_descriptor_suffix": "string",
"payment_method_collection": "string",
"payment_method_types": "array",
}, &Config)
+ resource.NewOperationCmd(rPaymentMethodConfigurationsCmd.Cmd, "create", "/v1/payment_method_configurations", http.MethodPost, map[string]string{
+ "acss_debit.display_preference.preference": "string",
+ "affirm.display_preference.preference": "string",
+ "afterpay_clearpay.display_preference.preference": "string",
+ "alipay.display_preference.preference": "string",
+ "apple_pay.display_preference.preference": "string",
+ "apple_pay_later.display_preference.preference": "string",
+ "au_becs_debit.display_preference.preference": "string",
+ "bacs_debit.display_preference.preference": "string",
+ "bancontact.display_preference.preference": "string",
+ "blik.display_preference.preference": "string",
+ "boleto.display_preference.preference": "string",
+ "card.display_preference.preference": "string",
+ "cartes_bancaires.display_preference.preference": "string",
+ "cashapp.display_preference.preference": "string",
+ "eps.display_preference.preference": "string",
+ "fpx.display_preference.preference": "string",
+ "giropay.display_preference.preference": "string",
+ "google_pay.display_preference.preference": "string",
+ "grabpay.display_preference.preference": "string",
+ "ideal.display_preference.preference": "string",
+ "jcb.display_preference.preference": "string",
+ "klarna.display_preference.preference": "string",
+ "konbini.display_preference.preference": "string",
+ "link.display_preference.preference": "string",
+ "name": "string",
+ "oxxo.display_preference.preference": "string",
+ "p24.display_preference.preference": "string",
+ "parent": "string",
+ "paynow.display_preference.preference": "string",
+ "paypal.display_preference.preference": "string",
+ "promptpay.display_preference.preference": "string",
+ "sepa_debit.display_preference.preference": "string",
+ "sofort.display_preference.preference": "string",
+ "us_bank_account.display_preference.preference": "string",
+ "wechat_pay.display_preference.preference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodConfigurationsCmd.Cmd, "list", "/v1/payment_method_configurations", http.MethodGet, map[string]string{
+ "application": "string",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodConfigurationsCmd.Cmd, "retrieve", "/v1/payment_method_configurations/{configuration}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rPaymentMethodConfigurationsCmd.Cmd, "update", "/v1/payment_method_configurations/{configuration}", http.MethodPost, map[string]string{
+ "acss_debit.display_preference.preference": "string",
+ "active": "boolean",
+ "affirm.display_preference.preference": "string",
+ "afterpay_clearpay.display_preference.preference": "string",
+ "alipay.display_preference.preference": "string",
+ "apple_pay.display_preference.preference": "string",
+ "apple_pay_later.display_preference.preference": "string",
+ "au_becs_debit.display_preference.preference": "string",
+ "bacs_debit.display_preference.preference": "string",
+ "bancontact.display_preference.preference": "string",
+ "blik.display_preference.preference": "string",
+ "boleto.display_preference.preference": "string",
+ "card.display_preference.preference": "string",
+ "cartes_bancaires.display_preference.preference": "string",
+ "cashapp.display_preference.preference": "string",
+ "eps.display_preference.preference": "string",
+ "fpx.display_preference.preference": "string",
+ "giropay.display_preference.preference": "string",
+ "google_pay.display_preference.preference": "string",
+ "grabpay.display_preference.preference": "string",
+ "ideal.display_preference.preference": "string",
+ "jcb.display_preference.preference": "string",
+ "klarna.display_preference.preference": "string",
+ "konbini.display_preference.preference": "string",
+ "link.display_preference.preference": "string",
+ "name": "string",
+ "oxxo.display_preference.preference": "string",
+ "p24.display_preference.preference": "string",
+ "paynow.display_preference.preference": "string",
+ "paypal.display_preference.preference": "string",
+ "promptpay.display_preference.preference": "string",
+ "sepa_debit.display_preference.preference": "string",
+ "sofort.display_preference.preference": "string",
+ "us_bank_account.display_preference.preference": "string",
+ "wechat_pay.display_preference.preference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodDomainsCmd.Cmd, "create", "/v1/payment_method_domains", http.MethodPost, map[string]string{
+ "domain_name": "string",
+ "enabled": "boolean",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodDomainsCmd.Cmd, "list", "/v1/payment_method_domains", http.MethodGet, map[string]string{
+ "domain_name": "string",
+ "enabled": "boolean",
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodDomainsCmd.Cmd, "retrieve", "/v1/payment_method_domains/{payment_method_domain}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rPaymentMethodDomainsCmd.Cmd, "update", "/v1/payment_method_domains/{payment_method_domain}", http.MethodPost, map[string]string{
+ "enabled": "boolean",
+ }, &Config)
+ resource.NewOperationCmd(rPaymentMethodDomainsCmd.Cmd, "validate", "/v1/payment_method_domains/{payment_method_domain}/validate", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rPaymentMethodsCmd.Cmd, "attach", "/v1/payment_methods/{payment_method}/attach", http.MethodPost, map[string]string{
"customer": "string",
}, &Config)
@@ -1529,6 +1647,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
resource.NewOperationCmd(rPayoutsCmd.Cmd, "reverse", "/v1/payouts/{payout}/reverse", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rPayoutsCmd.Cmd, "update", "/v1/payouts/{payout}", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rPersonsCmd.Cmd, "create", "/v1/accounts/{account}/persons", http.MethodPost, map[string]string{
+ "additional_tos_acceptances.account.date": "integer",
+ "additional_tos_acceptances.account.ip": "string",
+ "additional_tos_acceptances.account.user_agent": "string",
"address.city": "string",
"address.country": "string",
"address.line1": "string",
@@ -1576,6 +1697,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"registered_address.state": "string",
"relationship.director": "boolean",
"relationship.executive": "boolean",
+ "relationship.legal_guardian": "boolean",
"relationship.owner": "boolean",
"relationship.percent_ownership": "number",
"relationship.representative": "boolean",
@@ -1594,6 +1716,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rPersonsCmd.Cmd, "retrieve", "/v1/accounts/{account}/persons/{person}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rPersonsCmd.Cmd, "update", "/v1/accounts/{account}/persons/{person}", http.MethodPost, map[string]string{
+ "additional_tos_acceptances.account.date": "integer",
+ "additional_tos_acceptances.account.ip": "string",
+ "additional_tos_acceptances.account.user_agent": "string",
"address.city": "string",
"address.country": "string",
"address.line1": "string",
@@ -1641,6 +1766,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"registered_address.state": "string",
"relationship.director": "boolean",
"relationship.executive": "boolean",
+ "relationship.legal_guardian": "boolean",
"relationship.owner": "boolean",
"relationship.percent_ownership": "number",
"relationship.representative": "boolean",
@@ -1740,12 +1866,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"transfer_lookup_key": "boolean",
}, &Config)
resource.NewOperationCmd(rProductsCmd.Cmd, "create", "/v1/products", http.MethodPost, map[string]string{
- "active": "boolean",
- "attributes": "array",
- "caption": "string",
- "deactivate_on": "array",
- "default_price_data.currency": "string",
- "default_price_data.recurring.interval": "string",
+ "active": "boolean",
+ "default_price_data.currency": "string",
+ "default_price_data.recurring.interval": "string",
"default_price_data.recurring.interval_count": "integer",
"default_price_data.tax_behavior": "string",
"default_price_data.unit_amount": "integer",
@@ -1785,9 +1908,6 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rProductsCmd.Cmd, "update", "/v1/products/{id}", http.MethodPost, map[string]string{
"active": "boolean",
- "attributes": "array",
- "caption": "string",
- "deactivate_on": "array",
"default_price": "string",
"description": "string",
"images": "array",
@@ -1970,7 +2090,6 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.acss_debit.mandate_options.payment_schedule": "string",
"payment_method_options.acss_debit.mandate_options.transaction_type": "string",
"payment_method_options.acss_debit.verification_method": "string",
- "payment_method_options.blik.code": "string",
"payment_method_options.card.mandate_options.amount": "integer",
"payment_method_options.card.mandate_options.amount_type": "string",
"payment_method_options.card.mandate_options.currency": "string",
@@ -1987,6 +2106,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.link.persistent_token": "string",
"payment_method_options.paypal.billing_agreement_id": "string",
"payment_method_options.us_bank_account.financial_connections.permissions": "array",
+ "payment_method_options.us_bank_account.financial_connections.prefetch": "array",
"payment_method_options.us_bank_account.financial_connections.return_url": "string",
"payment_method_options.us_bank_account.networks.requested": "array",
"payment_method_options.us_bank_account.verification_method": "string",
@@ -2001,12 +2121,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"customer": "string",
"description": "string",
"flow_directions": "array",
- "mandate_data.customer_acceptance.accepted_at": "integer",
- "mandate_data.customer_acceptance.online.ip_address": "string",
- "mandate_data.customer_acceptance.online.user_agent": "string",
- "mandate_data.customer_acceptance.type": "string",
- "on_behalf_of": "string",
- "payment_method": "string",
+ "on_behalf_of": "string",
+ "payment_method": "string",
+ "payment_method_configuration": "string",
"payment_method_data.acss_debit.account_number": "string",
"payment_method_data.acss_debit.institution_number": "string",
"payment_method_data.acss_debit.transit_number": "string",
@@ -2042,7 +2159,6 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.acss_debit.mandate_options.payment_schedule": "string",
"payment_method_options.acss_debit.mandate_options.transaction_type": "string",
"payment_method_options.acss_debit.verification_method": "string",
- "payment_method_options.blik.code": "string",
"payment_method_options.card.mandate_options.amount": "integer",
"payment_method_options.card.mandate_options.amount_type": "string",
"payment_method_options.card.mandate_options.currency": "string",
@@ -2059,6 +2175,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.link.persistent_token": "string",
"payment_method_options.paypal.billing_agreement_id": "string",
"payment_method_options.us_bank_account.financial_connections.permissions": "array",
+ "payment_method_options.us_bank_account.financial_connections.prefetch": "array",
"payment_method_options.us_bank_account.financial_connections.return_url": "string",
"payment_method_options.us_bank_account.networks.requested": "array",
"payment_method_options.us_bank_account.verification_method": "string",
@@ -2082,11 +2199,12 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"client_secret": "string",
}, &Config)
resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "update", "/v1/setup_intents/{intent}", http.MethodPost, map[string]string{
- "attach_to_self": "boolean",
- "customer": "string",
- "description": "string",
- "flow_directions": "array",
- "payment_method": "string",
+ "attach_to_self": "boolean",
+ "customer": "string",
+ "description": "string",
+ "flow_directions": "array",
+ "payment_method": "string",
+ "payment_method_configuration": "string",
"payment_method_data.acss_debit.account_number": "string",
"payment_method_data.acss_debit.institution_number": "string",
"payment_method_data.acss_debit.transit_number": "string",
@@ -2122,7 +2240,6 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.acss_debit.mandate_options.payment_schedule": "string",
"payment_method_options.acss_debit.mandate_options.transaction_type": "string",
"payment_method_options.acss_debit.verification_method": "string",
- "payment_method_options.blik.code": "string",
"payment_method_options.card.mandate_options.amount": "integer",
"payment_method_options.card.mandate_options.amount_type": "string",
"payment_method_options.card.mandate_options.currency": "string",
@@ -2139,6 +2256,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.link.persistent_token": "string",
"payment_method_options.paypal.billing_agreement_id": "string",
"payment_method_options.us_bank_account.financial_connections.permissions": "array",
+ "payment_method_options.us_bank_account.financial_connections.prefetch": "array",
"payment_method_options.us_bank_account.financial_connections.return_url": "string",
"payment_method_options.us_bank_account.networks.requested": "array",
"payment_method_options.us_bank_account.verification_method": "string",
@@ -2585,6 +2703,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"card": "string",
"customer": "string",
"cvc_update.cvc": "string",
+ "person.additional_tos_acceptances.account.date": "integer",
+ "person.additional_tos_acceptances.account.ip": "string",
+ "person.additional_tos_acceptances.account.user_agent": "string",
"person.address.city": "string",
"person.address.country": "string",
"person.address.line1": "string",
@@ -2631,6 +2752,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"person.registered_address.state": "string",
"person.relationship.director": "boolean",
"person.relationship.executive": "boolean",
+ "person.relationship.legal_guardian": "boolean",
"person.relationship.owner": "boolean",
"person.relationship.percent_ownership": "number",
"person.relationship.representative": "boolean",
@@ -2802,6 +2924,8 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"flow_data.after_completion.hosted_confirmation.custom_message": "string",
"flow_data.after_completion.redirect.return_url": "string",
"flow_data.after_completion.type": "string",
+ "flow_data.subscription_cancel.retention.coupon_offer.coupon": "string",
+ "flow_data.subscription_cancel.retention.type": "string",
"flow_data.subscription_cancel.subscription": "string",
"flow_data.subscription_update.subscription": "string",
"flow_data.subscription_update_confirm.subscription": "string",
@@ -2856,6 +2980,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_intent_data.transfer_data.destination": "string",
"payment_intent_data.transfer_group": "string",
"payment_method_collection": "string",
+ "payment_method_configuration": "string",
"payment_method_options.acss_debit.currency": "string",
"payment_method_options.acss_debit.mandate_options.custom_mandate_url": "string",
"payment_method_options.acss_debit.mandate_options.default_for": "array",
@@ -2905,6 +3030,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.sepa_debit.setup_future_usage": "string",
"payment_method_options.sofort.setup_future_usage": "string",
"payment_method_options.us_bank_account.financial_connections.permissions": "array",
+ "payment_method_options.us_bank_account.financial_connections.prefetch": "array",
"payment_method_options.us_bank_account.setup_future_usage": "string",
"payment_method_options.us_bank_account.verification_method": "string",
"payment_method_options.wechat_pay.app_id": "string",
@@ -2912,14 +3038,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.wechat_pay.setup_future_usage": "string",
"payment_method_types": "array",
"phone_number_collection.enabled": "boolean",
+ "redirect_on_completion": "string",
+ "return_url": "string",
"setup_intent_data.description": "string",
"setup_intent_data.on_behalf_of": "string",
"shipping_address_collection.allowed_countries": "array",
- "shipping_rates": "array",
- "submit_type": "string",
+ "submit_type": "string",
"subscription_data.application_fee_percent": "number",
"subscription_data.billing_cycle_anchor": "integer",
- "subscription_data.coupon": "string",
"subscription_data.default_tax_rates": "array",
"subscription_data.description": "string",
"subscription_data.on_behalf_of": "string",
@@ -2927,11 +3053,11 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"subscription_data.transfer_data.amount_percent": "number",
"subscription_data.transfer_data.destination": "string",
"subscription_data.trial_end": "integer",
- "subscription_data.trial_from_plan": "boolean",
"subscription_data.trial_period_days": "integer",
"subscription_data.trial_settings.end_behavior.missing_payment_method": "string",
"success_url": "string",
"tax_id_collection.enabled": "boolean",
+ "ui_mode": "string",
}, &Config)
resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "expire", "/v1/checkout/sessions/{session}/expire", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "list", "/v1/checkout/sessions", http.MethodGet, map[string]string{
@@ -2972,6 +3098,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"account_holder.type": "string",
"filters.countries": "array",
"permissions": "array",
+ "prefetch": "array",
"return_url": "string",
}, &Config)
resource.NewOperationCmd(rFinancialConnectionsSessionsCmd.Cmd, "retrieve", "/v1/financial_connections/sessions/{session}", http.MethodGet, map[string]string{}, &Config)
@@ -3016,6 +3143,52 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "retrieve", "/v1/issuing/authorizations/{authorization}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rIssuingAuthorizationsCmd.Cmd, "update", "/v1/issuing/authorizations/{authorization}", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{
+ "capture_amount": "integer",
+ "close_authorization": "boolean",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "amount_details.atm_fee": "integer",
+ "amount_details.cashback_amount": "integer",
+ "authorization_method": "string",
+ "card": "string",
+ "currency": "string",
+ "is_amount_controllable": "boolean",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "network_data.acquiring_institution_id": "string",
+ "verification_data.address_line1_check": "string",
+ "verification_data.address_postal_code_check": "string",
+ "verification_data.cvc_check": "string",
+ "verification_data.expiry_check": "string",
+ "wallet": "string",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{
+ "increment_amount": "integer",
+ "is_amount_controllable": "boolean",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingAuthorizationsTestHelpersCmd.Cmd, "reverse", "/v1/test_helpers/issuing/authorizations/{authorization}/reverse", http.MethodPost, map[string]string{
+ "reverse_amount": "integer",
+ }, &Config)
resource.NewOperationCmd(rIssuingCardholdersCmd.Cmd, "create", "/v1/issuing/cardholders", http.MethodPost, map[string]string{
"billing.address.city": "string",
"billing.address.country": "string",
@@ -3148,6 +3321,18 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"amount": "integer",
"evidence.reason": "string",
}, &Config)
+ resource.NewOperationCmd(rIssuingTokensCmd.Cmd, "list", "/v1/issuing/tokens", http.MethodGet, map[string]string{
+ "card": "string",
+ "created": "integer",
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ "status": "string",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingTokensCmd.Cmd, "retrieve", "/v1/issuing/tokens/{token}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rIssuingTokensCmd.Cmd, "update", "/v1/issuing/tokens/{token}", http.MethodPost, map[string]string{
+ "status": "string",
+ }, &Config)
resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "list", "/v1/issuing/transactions", http.MethodGet, map[string]string{
"card": "string",
"cardholder": "string",
@@ -3159,6 +3344,57 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "retrieve", "/v1/issuing/transactions/{transaction}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rIssuingTransactionsCmd.Cmd, "update", "/v1/issuing/transactions/{transaction}", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "card": "string",
+ "currency": "string",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "card": "string",
+ "currency": "string",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rIssuingTransactionsTestHelpersCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{
+ "refund_amount": "integer",
+ }, &Config)
resource.NewOperationCmd(rRadarEarlyFraudWarningsCmd.Cmd, "list", "/v1/radar/early_fraud_warnings", http.MethodGet, map[string]string{
"charge": "string",
"ending_before": "string",
@@ -3259,6 +3495,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"reference": "string",
}, &Config)
resource.NewOperationCmd(rTaxTransactionsCmd.Cmd, "create_reversal", "/v1/tax/transactions/create_reversal", http.MethodPost, map[string]string{
+ "flat_amount": "integer",
"mode": "string",
"original_transaction": "string",
"reference": "string",
@@ -3326,6 +3563,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"ending_before": "string",
"limit": "integer",
"location": "string",
+ "serial_number": "string",
"starting_after": "string",
"status": "string",
}, &Config)
@@ -3366,10 +3604,107 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"currency": "string",
"reference": "string",
}, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "capture", "/v1/test_helpers/issuing/authorizations/{authorization}/capture", http.MethodPost, map[string]string{
+ "capture_amount": "integer",
+ "close_authorization": "boolean",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "create", "/v1/test_helpers/issuing/authorizations", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "amount_details.atm_fee": "integer",
+ "amount_details.cashback_amount": "integer",
+ "authorization_method": "string",
+ "card": "string",
+ "currency": "string",
+ "is_amount_controllable": "boolean",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "network_data.acquiring_institution_id": "string",
+ "verification_data.address_line1_check": "string",
+ "verification_data.address_postal_code_check": "string",
+ "verification_data.cvc_check": "string",
+ "verification_data.expiry_check": "string",
+ "wallet": "string",
+ }, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "expire", "/v1/test_helpers/issuing/authorizations/{authorization}/expire", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "increment", "/v1/test_helpers/issuing/authorizations/{authorization}/increment", http.MethodPost, map[string]string{
+ "increment_amount": "integer",
+ "is_amount_controllable": "boolean",
+ }, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingAuthorizationsCmd.Cmd, "reverse", "/v1/test_helpers/issuing/authorizations/{authorization}/reverse", http.MethodPost, map[string]string{
+ "reverse_amount": "integer",
+ }, &Config)
resource.NewOperationCmd(rTestHelpersIssuingCardsCmd.Cmd, "deliver_card", "/v1/test_helpers/issuing/cards/{card}/shipping/deliver", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rTestHelpersIssuingCardsCmd.Cmd, "fail_card", "/v1/test_helpers/issuing/cards/{card}/shipping/fail", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rTestHelpersIssuingCardsCmd.Cmd, "return_card", "/v1/test_helpers/issuing/cards/{card}/shipping/return", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rTestHelpersIssuingCardsCmd.Cmd, "ship_card", "/v1/test_helpers/issuing/cards/{card}/shipping/ship", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_force_capture", "/v1/test_helpers/issuing/transactions/create_force_capture", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "card": "string",
+ "currency": "string",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "create_unlinked_refund", "/v1/test_helpers/issuing/transactions/create_unlinked_refund", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "card": "string",
+ "currency": "string",
+ "merchant_data.category": "string",
+ "merchant_data.city": "string",
+ "merchant_data.country": "string",
+ "merchant_data.name": "string",
+ "merchant_data.network_id": "string",
+ "merchant_data.postal_code": "string",
+ "merchant_data.state": "string",
+ "merchant_data.terminal_id": "string",
+ "purchase_details.flight.departure_at": "integer",
+ "purchase_details.flight.passenger_name": "string",
+ "purchase_details.flight.refundable": "boolean",
+ "purchase_details.flight.travel_agency": "string",
+ "purchase_details.fuel.type": "string",
+ "purchase_details.fuel.unit": "string",
+ "purchase_details.fuel.unit_cost_decimal": "string",
+ "purchase_details.fuel.volume_decimal": "string",
+ "purchase_details.lodging.check_in_at": "integer",
+ "purchase_details.lodging.nights": "integer",
+ "purchase_details.reference": "string",
+ }, &Config)
+ resource.NewOperationCmd(rTestHelpersIssuingTransactionsCmd.Cmd, "refund", "/v1/test_helpers/issuing/transactions/{transaction}/refund", http.MethodPost, map[string]string{
+ "refund_amount": "integer",
+ }, &Config)
resource.NewOperationCmd(rTestHelpersRefundsCmd.Cmd, "expire", "/v1/test_helpers/refunds/{refund}/expire", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rTestHelpersTerminalReadersCmd.Cmd, "present_payment_method", "/v1/test_helpers/terminal/readers/{reader}/present_payment_method", http.MethodPost, map[string]string{
"amount_tip": "integer",
diff --git a/pkg/proxy/events_list.go b/pkg/proxy/events_list.go
index ba04ab434..4c16334de 100644
--- a/pkg/proxy/events_list.go
+++ b/pkg/proxy/events_list.go
@@ -91,7 +91,6 @@ var validEvents = map[string]bool{
"invoice.voided": true,
"invoiceitem.created": true,
"invoiceitem.deleted": true,
- "invoiceitem.updated": true,
"issuing_authorization.created": true,
"issuing_authorization.request": true,
"issuing_authorization.updated": true,
@@ -104,10 +103,11 @@ var validEvents = map[string]bool{
"issuing_dispute.funds_reinstated": true,
"issuing_dispute.submitted": true,
"issuing_dispute.updated": true,
+ "issuing_token.created": true,
+ "issuing_token.updated": true,
"issuing_transaction.created": true,
"issuing_transaction.updated": true,
"mandate.updated": true,
- "order.created": true,
"payment_intent.amount_capturable_updated": true,
"payment_intent.canceled": true,
"payment_intent.created": true,
@@ -148,9 +148,6 @@ var validEvents = map[string]bool{
"quote.finalized": true,
"radar.early_fraud_warning.created": true,
"radar.early_fraud_warning.updated": true,
- "recipient.created": true,
- "recipient.deleted": true,
- "recipient.updated": true,
"refund.created": true,
"refund.updated": true,
"reporting.report_run.failed": true,
@@ -164,9 +161,6 @@ var validEvents = map[string]bool{
"setup_intent.setup_failed": true,
"setup_intent.succeeded": true,
"sigma.scheduled_query_run.created": true,
- "sku.created": true,
- "sku.deleted": true,
- "sku.updated": true,
"source.canceled": true,
"source.chargeable": true,
"source.failed": true,