From ae62dc438eb878afe6c694790fce88dcf6ac0041 Mon Sep 17 00:00:00 2001
From: "stripe-openapi[bot]"
<105521251+stripe-openapi[bot]@users.noreply.github.com>
Date: Wed, 20 Dec 2023 10:27:32 -0800
Subject: [PATCH] Update OpenAPI for 7fc56a499731f6ebb393a45547c87b5d557ccaa0
(#1129)
Co-authored-by: Stripe OpenAPI <105521251+stripe-openapi[bot]@users.noreply.github.com>
---
api/openapi-spec/spec3.sdk.json | 11910 ++++++++++++++++++++----------
pkg/cmd/resources_cmds.go | 641 +-
pkg/proxy/events_list.go | 7 +
3 files changed, 8604 insertions(+), 3954 deletions(-)
diff --git a/api/openapi-spec/spec3.sdk.json b/api/openapi-spec/spec3.sdk.json
index 391b23358..6806955bc 100644
--- a/api/openapi-spec/spec3.sdk.json
+++ b/api/openapi-spec/spec3.sdk.json
@@ -381,18 +381,25 @@
"description": "",
"properties": {
"display_name": {
- "description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this will appear on the mandate, and as the statement descriptor.",
+ "description": "The Bacs Direct Debit display name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. The fee appears 5 business days after requesting Bacs. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
"maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "service_user_number": {
+ "description": "The Bacs Direct Debit Service user number for this account. For payments made with Bacs Direct Debit, this number is a unique identifier of the account with our banking partners.",
+ "maxLength": 5000,
+ "nullable": true,
"type": "string"
}
},
+ "required": [
+ "display_name",
+ "service_user_number"
+ ],
"title": "AccountBacsDebitPaymentsSettings",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebitPayments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_branding_settings": {
"description": "",
@@ -461,11 +468,7 @@
"x-expandableFields": [
"icon",
"logo"
- ],
- "x-stripeResource": {
- "class_name": "SettingsBranding",
- "in_package": ""
- }
+ ]
},
"account_business_profile": {
"description": "",
@@ -539,11 +542,7 @@
"x-expandableFields": [
"monthly_estimated_revenue",
"support_address"
- ],
- "x-stripeResource": {
- "class_name": "BusinessProfile",
- "in_package": ""
- }
+ ]
},
"account_capabilities": {
"description": "",
@@ -800,6 +799,15 @@
],
"type": "string"
},
+ "revolut_pay_payments": {
+ "description": "The status of the RevolutPay capability of the account, or whether the account can directly process RevolutPay payments.",
+ "enum": [
+ "active",
+ "inactive",
+ "pending"
+ ],
+ "type": "string"
+ },
"sepa_debit_payments": {
"description": "The status of the SEPA Direct Debits payments capability of the account, or whether the account can directly process SEPA Direct Debits charges.",
"enum": [
@@ -875,11 +883,7 @@
},
"title": "AccountCapabilities",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Capabilities",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_capability_future_requirements": {
"description": "",
@@ -959,11 +963,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "FutureRequirements",
- "in_package": ""
- }
+ ]
},
"account_capability_requirements": {
"description": "",
@@ -1043,11 +1043,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "Requirements",
- "in_package": ""
- }
+ ]
},
"account_card_issuing_settings": {
"description": "",
@@ -1060,11 +1056,7 @@
"type": "object",
"x-expandableFields": [
"tos_acceptance"
- ],
- "x-stripeResource": {
- "class_name": "SettingsCardIssuing",
- "in_package": ""
- }
+ ]
},
"account_card_payments_settings": {
"description": "",
@@ -1100,11 +1092,7 @@
"type": "object",
"x-expandableFields": [
"decline_on"
- ],
- "x-stripeResource": {
- "class_name": "SettingsCardPayments",
- "in_package": ""
- }
+ ]
},
"account_dashboard_settings": {
"description": "",
@@ -1128,11 +1116,7 @@
],
"title": "AccountDashboardSettings",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SettingsDashboard",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_decline_charge_on": {
"description": "",
@@ -1152,11 +1136,7 @@
],
"title": "AccountDeclineChargeOn",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DeclineChargeOn",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_future_requirements": {
"description": "",
@@ -1185,7 +1165,7 @@
"type": "array"
},
"disabled_reason": {
- "description": "This is typed as a string for consistency with `requirements.disabled_reason`, but it safe to assume `future_requirements.disabled_reason` is empty because fields in `future_requirements` will never disable the account.",
+ "description": "This is typed as a string for consistency with `requirements.disabled_reason`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -1241,11 +1221,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "FutureRequirements",
- "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/custom/hosted-onboarding)",
@@ -1315,11 +1291,7 @@
],
"title": "AccountMonthlyEstimatedRevenue",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MonthlyEstimatedRevenue",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_payments_settings": {
"description": "",
@@ -1364,11 +1336,7 @@
],
"title": "AccountPaymentsSettings",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SettingsPayments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_payout_settings": {
"description": "",
@@ -1396,11 +1364,7 @@
"type": "object",
"x-expandableFields": [
"schedule"
- ],
- "x-stripeResource": {
- "class_name": "SettingsPayouts",
- "in_package": ""
- }
+ ]
},
"account_requirements": {
"description": "",
@@ -1429,7 +1393,7 @@
"type": "array"
},
"disabled_reason": {
- "description": "If the account is disabled, this string describes why. Can be `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.listed`, `rejected.terms_of_service`, `rejected.other`, `under_review`, or `other`.",
+ "description": "If the account is disabled, this string describes why. [Learn more about handling verification issues](https://stripe.com/docs/connect/handling-api-verification). Can be `action_required.requested_capabilities`, `requirements.past_due`, `requirements.pending_verification`, `listed`, `platform_paused`, `rejected.fraud`, `rejected.incomplete_verification`, `rejected.listed`, `rejected.other`, `rejected.terms_of_service`, `under_review`, or `other`.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -1485,11 +1449,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "Requirements",
- "in_package": ""
- }
+ ]
},
"account_requirements_alternative": {
"description": "",
@@ -1517,11 +1477,7 @@
],
"title": "AccountRequirementsAlternative",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Alternative",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_requirements_error": {
"description": "",
@@ -1638,11 +1594,7 @@
],
"title": "AccountRequirementsError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Errors",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_sepa_debit_payments_settings": {
"description": "",
@@ -1655,11 +1607,7 @@
},
"title": "AccountSepaDebitPaymentsSettings",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaDebitPayments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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)",
@@ -1771,11 +1719,7 @@
"payouts",
"sepa_debit_payments",
"treasury"
- ],
- "x-stripeResource": {
- "class_name": "Settings",
- "in_package": ""
- }
+ ]
},
"account_terms_of_service": {
"description": "",
@@ -1803,11 +1747,7 @@
],
"title": "AccountTermsOfService",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TosAcceptance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_tos_acceptance": {
"description": "",
@@ -1838,11 +1778,7 @@
},
"title": "AccountTOSAcceptance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TosAcceptance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"account_treasury_settings": {
"description": "",
@@ -1855,11 +1791,7 @@
"type": "object",
"x-expandableFields": [
"tos_acceptance"
- ],
- "x-stripeResource": {
- "class_name": "SettingsTreasury",
- "in_package": ""
- }
+ ]
},
"account_unification_account_controller": {
"description": "",
@@ -1882,11 +1814,7 @@
],
"title": "AccountUnificationAccountController",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Controller",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"address": {
"description": "",
@@ -1969,6 +1897,7 @@
"application_fees_not_allowed",
"authentication_required",
"balance_insufficient",
+ "balance_invalid_parameter",
"bank_account_bad_routing_numbers",
"bank_account_declined",
"bank_account_exists",
@@ -1996,9 +1925,12 @@
"coupon_expired",
"customer_max_payment_methods",
"customer_max_subscriptions",
+ "customer_tax_location_invalid",
"debit_not_authorized",
"email_invalid",
"expired_card",
+ "financial_connections_account_inactive",
+ "financial_connections_no_successful_transaction_refresh",
"idempotency_key_in_use",
"incorrect_address",
"incorrect_cvc",
@@ -2103,11 +2035,13 @@
"taxes_calculation_failed",
"terminal_location_country_unsupported",
"terminal_reader_busy",
+ "terminal_reader_hardware_fault",
"terminal_reader_offline",
"terminal_reader_timeout",
"testmode_charges_only",
"tls_version_unsupported",
"token_already_used",
+ "token_card_network_invalid",
"token_in_use",
"transfer_source_balance_parameters_mismatch",
"transfers_not_allowed",
@@ -2698,11 +2632,7 @@
],
"title": "AutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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)",
@@ -2724,7 +2654,7 @@
"instant_available": {
"description": "Funds that you can pay out using Instant Payouts.",
"items": {
- "$ref": "#/components/schemas/balance_amount"
+ "$ref": "#/components/schemas/balance_amount_net"
},
"type": "array"
},
@@ -2819,11 +2749,7 @@
"type": "object",
"x-expandableFields": [
"source_types"
- ],
- "x-stripeResource": {
- "class_name": "Money",
- "in_package": ""
- }
+ ]
},
"balance_amount_by_source_type": {
"description": "",
@@ -2843,11 +2769,32 @@
},
"title": "BalanceAmountBySourceType",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SourceTypes",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "balance_amount_net": {
+ "description": "",
+ "properties": {
+ "amount": {
+ "description": "Balance amount.",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "type": "string"
+ },
+ "source_types": {
+ "$ref": "#/components/schemas/balance_amount_by_source_type"
+ }
+ },
+ "required": [
+ "amount",
+ "currency"
+ ],
+ "title": "BalanceAmountNet",
+ "type": "object",
+ "x-expandableFields": [
+ "source_types"
+ ]
},
"balance_detail": {
"description": "",
@@ -2867,11 +2814,7 @@
"type": "object",
"x-expandableFields": [
"available"
- ],
- "x-stripeResource": {
- "class_name": "Details",
- "in_package": ""
- }
+ ]
},
"balance_transaction": {
"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)",
@@ -2963,7 +2906,7 @@
"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`, `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.",
+ "description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
"enum": [
"adjustment",
"advance",
@@ -2972,6 +2915,8 @@
"application_fee",
"application_fee_refund",
"charge",
+ "climate_order_purchase",
+ "climate_order_refund",
"connect_collection_transfer",
"contribution",
"issuing_authorization_hold",
@@ -2986,8 +2931,11 @@
"obligation_reversal_outbound",
"payment",
"payment_failure_refund",
+ "payment_network_reserve_hold",
+ "payment_network_reserve_release",
"payment_refund",
"payment_reversal",
+ "payment_unreconciled",
"payout",
"payout_cancel",
"payout_failure",
@@ -3270,7 +3218,7 @@
"type": "string"
},
"status": {
- "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a transfer sent to this bank account fails, we'll set the status to `errored` and will not continue to send transfers until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.",
+ "description": "For bank accounts, possible values are `new`, `validated`, `verified`, `verification_failed`, or `errored`. A bank account that hasn't had any activity or validation performed is `new`. If Stripe can determine that the bank account exists, its status will be `validated`. Note that there often isn’t enough information to know (e.g., for smaller credit unions), and the validation is not always run. If customer bank account verification has succeeded, the bank account status will be `verified`. If the verification failed for any reason, such as microdeposit failure, the status will be `verification_failed`. If a payout sent to this bank account fails, we'll set the status to `errored` and will not continue to send [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) until the bank details are updated.\n\nFor external accounts, possible values are `new`, `errored` and `verification_failed`. If a payouts fails, the status is set to `errored` and scheduled payouts are stopped until account details are updated. In India, if we can't [verify the owner of the bank account](https://support.stripe.com/questions/bank-account-ownership-verification), we'll set the status to `verification_failed`. Other validations aren't run against external accounts because they're only used for payouts. This means the other statuses don't apply.",
"maxLength": 5000,
"type": "string"
}
@@ -3404,11 +3352,7 @@
"x-expandableFields": [
"account",
"customer"
- ],
- "x-stripeResource": {
- "class_name": "AccountHolder",
- "in_package": ""
- }
+ ]
},
"bank_connections_resource_balance": {
"description": "",
@@ -3450,11 +3394,7 @@
"x-expandableFields": [
"cash",
"credit"
- ],
- "x-stripeResource": {
- "class_name": "Balance",
- "in_package": ""
- }
+ ]
},
"bank_connections_resource_balance_api_resource_cash_balance": {
"description": "",
@@ -3473,11 +3413,7 @@
],
"title": "BankConnectionsResourceBalanceAPIResourceCashBalance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CashBalance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"bank_connections_resource_balance_api_resource_credit_balance": {
"description": "",
@@ -3496,11 +3432,7 @@
],
"title": "BankConnectionsResourceBalanceAPIResourceCreditBalance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CreditBalance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"bank_connections_resource_balance_refresh": {
"description": "",
@@ -3510,6 +3442,12 @@
"format": "unix-time",
"type": "integer"
},
+ "next_refresh_available_at": {
+ "description": "Time at which the next balance refresh can be initiated. This value will be `null` when `status` is `pending`. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
"status": {
"description": "The status of the last refresh attempt.",
"enum": [
@@ -3522,15 +3460,12 @@
},
"required": [
"last_attempted_at",
+ "next_refresh_available_at",
"status"
],
"title": "BankConnectionsResourceBalanceRefresh",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BalanceRefresh",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"bank_connections_resource_link_account_session_filters": {
"description": "",
@@ -3550,11 +3485,7 @@
],
"title": "BankConnectionsResourceLinkAccountSessionFilters",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Filters",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"bank_connections_resource_ownership_refresh": {
"description": "",
@@ -3580,11 +3511,7 @@
],
"title": "BankConnectionsResourceOwnershipRefresh",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "OwnershipRefresh",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"billing_details": {
"description": "",
@@ -3627,11 +3554,7 @@
"type": "object",
"x-expandableFields": [
"address"
- ],
- "x-stripeResource": {
- "class_name": "BillingDetails",
- "in_package": ""
- }
+ ]
},
"billing_portal.configuration": {
"description": "A portal configuration describes the functionality and behavior of a portal session.",
@@ -4034,11 +3957,7 @@
],
"title": "CancellationDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CancellationDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"capability": {
"description": "This is an object representing a capability for a Stripe account.\n\nRelated guide: [Account capabilities](https://stripe.com/docs/connect/account-capabilities)",
@@ -4386,7 +4305,7 @@
"type": "string"
},
"status": {
- "description": "For external accounts, possible values are `new` and `errored`. If a transfer fails, the status is set to `errored` and transfers are stopped until account details are updated.",
+ "description": "For external accounts that are cards, possible values are `new` and `errored`. If a payout fails, the status is set to `errored` and [scheduled payouts](https://stripe.com/docs/payouts#payout-schedule) are stopped until account details are updated.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -4495,22 +4414,14 @@
],
"title": "CardIssuingAccountTermsOfService",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TosAcceptance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"card_mandate_payment_method_details": {
"description": "",
"properties": {},
"title": "card_mandate_payment_method_details",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"cash_balance": {
"description": "A customer's `Cash balance` represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.",
@@ -5421,11 +5332,7 @@
},
"title": "ChargeFraudDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "FraudDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"charge_outcome": {
"description": "",
@@ -5492,11 +5399,7 @@
"type": "object",
"x-expandableFields": [
"rule"
- ],
- "x-stripeResource": {
- "class_name": "Outcome",
- "in_package": ""
- }
+ ]
},
"charge_transfer_data": {
"description": "",
@@ -5534,11 +5437,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "in_package": ""
- }
+ ]
},
"checkout.session": {
"description": "A Checkout Session represents your customer's session as they pay for\none-time purchases or subscriptions through [Checkout](https://stripe.com/docs/payments/checkout)\nor [Payment Links](https://stripe.com/docs/payments/payment-links). We recommend creating a\nnew Session each time your customer attempts to pay.\n\nOnce payment is successful, the Checkout Session will contain a reference\nto the [Customer](https://stripe.com/docs/api/customers), and either the successful\n[PaymentIntent](https://stripe.com/docs/api/payment_intents) or an active\n[Subscription](https://stripe.com/docs/api/subscriptions).\n\nYou can create a Checkout Session on your server and redirect to its URL\nto begin Checkout.\n\nRelated guide: [Checkout quickstart](https://stripe.com/docs/checkout/quickstart)",
@@ -6120,6 +6019,7 @@
"payment_intent",
"payment_link",
"payment_method_collection",
+ "payment_method_configuration_details",
"payment_method_options",
"payment_method_types",
"payment_status",
@@ -6326,11 +6226,7 @@
],
"title": "CheckoutAcssDebitMandateOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MandateOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_acss_debit_payment_method_options": {
"description": "",
@@ -6370,11 +6266,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ ]
},
"checkout_affirm_payment_method_options": {
"description": "",
@@ -6389,11 +6281,7 @@
},
"title": "CheckoutAffirmPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Affirm",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_afterpay_clearpay_payment_method_options": {
"description": "",
@@ -6427,11 +6315,7 @@
},
"title": "CheckoutAlipayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Alipay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_au_becs_debit_payment_method_options": {
"description": "",
@@ -6446,11 +6330,7 @@
},
"title": "CheckoutAuBecsDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_bacs_debit_payment_method_options": {
"description": "",
@@ -6467,11 +6347,7 @@
},
"title": "CheckoutBacsDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_bancontact_payment_method_options": {
"description": "",
@@ -6486,11 +6362,7 @@
},
"title": "CheckoutBancontactPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Bancontact",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_boleto_payment_method_options": {
"description": "",
@@ -6514,11 +6386,7 @@
],
"title": "CheckoutBoletoPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Boleto",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_card_installments_options": {
"description": "",
@@ -6530,11 +6398,7 @@
},
"title": "CheckoutCardInstallmentsOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Installments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_card_payment_method_options": {
"description": "",
@@ -6566,11 +6430,7 @@
"type": "object",
"x-expandableFields": [
"installments"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"checkout_cashapp_payment_method_options": {
"description": "",
@@ -6585,11 +6445,7 @@
},
"title": "CheckoutCashappPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Cashapp",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_customer_balance_bank_transfer_payment_method_options": {
"description": "",
@@ -6635,11 +6491,7 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "BankTransfer",
- "in_package": ""
- }
+ ]
},
"checkout_customer_balance_payment_method_options": {
"description": "",
@@ -6670,11 +6522,7 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "CustomerBalance",
- "in_package": ""
- }
+ ]
},
"checkout_eps_payment_method_options": {
"description": "",
@@ -6689,11 +6537,7 @@
},
"title": "CheckoutEpsPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Eps",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_fpx_payment_method_options": {
"description": "",
@@ -6708,11 +6552,7 @@
},
"title": "CheckoutFpxPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fpx",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_giropay_payment_method_options": {
"description": "",
@@ -6727,11 +6567,7 @@
},
"title": "CheckoutGiropayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Giropay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_grab_pay_payment_method_options": {
"description": "",
@@ -6746,11 +6582,7 @@
},
"title": "CheckoutGrabPayPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GrabPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_ideal_payment_method_options": {
"description": "",
@@ -6765,11 +6597,7 @@
},
"title": "CheckoutIdealPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Ideal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_klarna_payment_method_options": {
"description": "",
@@ -6786,11 +6614,7 @@
},
"title": "CheckoutKlarnaPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Klarna",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_konbini_payment_method_options": {
"description": "",
@@ -6813,11 +6637,7 @@
],
"title": "CheckoutKonbiniPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Konbini",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_link_payment_method_options": {
"description": "",
@@ -6833,11 +6653,7 @@
},
"title": "CheckoutLinkPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_oxxo_payment_method_options": {
"description": "",
@@ -6859,11 +6675,7 @@
],
"title": "CheckoutOxxoPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Oxxo",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_p24_payment_method_options": {
"description": "",
@@ -6878,11 +6690,7 @@
},
"title": "CheckoutP24PaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "P24",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_paynow_payment_method_options": {
"description": "",
@@ -6897,11 +6705,46 @@
},
"title": "CheckoutPaynowPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paynow",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "checkout_paypal_payment_method_options": {
+ "description": "",
+ "properties": {
+ "capture_method": {
+ "description": "Controls when the funds will be captured from the customer's account.",
+ "enum": [
+ "manual"
+ ],
+ "type": "string"
+ },
+ "preferred_locale": {
+ "description": "Preferred locale of the PayPal checkout page that the customer is redirected to.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "reference": {
+ "description": "A reference of the PayPal transaction visible to customer which is mapped to PayPal's invoice ID. This must be a globally unique ID if you have configured in your PayPal settings to block multiple payments per invoice ID.",
+ "maxLength": 5000,
+ "nullable": true,
+ "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": [
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "preferred_locale",
+ "reference"
+ ],
+ "title": "CheckoutPaypalPaymentMethodOptions",
+ "type": "object",
+ "x-expandableFields": []
},
"checkout_pix_payment_method_options": {
"description": "",
@@ -6917,11 +6760,14 @@
],
"title": "CheckoutPixPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Pix",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "checkout_revolut_pay_payment_method_options": {
+ "description": "",
+ "properties": {},
+ "title": "CheckoutRevolutPayPaymentMethodOptions",
+ "type": "object",
+ "x-expandableFields": []
},
"checkout_sepa_debit_payment_method_options": {
"description": "",
@@ -6938,11 +6784,7 @@
},
"title": "CheckoutSepaDebitPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_session_payment_method_options": {
"description": "",
@@ -7013,9 +6855,15 @@
"paynow": {
"$ref": "#/components/schemas/checkout_paynow_payment_method_options"
},
+ "paypal": {
+ "$ref": "#/components/schemas/checkout_paypal_payment_method_options"
+ },
"pix": {
"$ref": "#/components/schemas/checkout_pix_payment_method_options"
},
+ "revolut_pay": {
+ "$ref": "#/components/schemas/checkout_revolut_pay_payment_method_options"
+ },
"sepa_debit": {
"$ref": "#/components/schemas/checkout_sepa_debit_payment_method_options"
},
@@ -7051,15 +6899,13 @@
"oxxo",
"p24",
"paynow",
+ "paypal",
"pix",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodOptions",
- "in_package": ""
- }
+ ]
},
"checkout_sofort_payment_method_options": {
"description": "",
@@ -7074,11 +6920,7 @@
},
"title": "CheckoutSofortPaymentMethodOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Sofort",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"checkout_us_bank_account_payment_method_options": {
"description": "",
@@ -7109,12 +6951,646 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
+ ]
+ },
+ "climate.order": {
+ "description": "Orders represent your intent to purchase a particular Climate product. When you create an order, the\npayment is deducted from your merchant balance.",
+ "properties": {
+ "amount_fees": {
+ "description": "Total amount of [Frontier](https://frontierclimate.com/)'s service fees in the currency's smallest unit.",
+ "type": "integer"
+ },
+ "amount_subtotal": {
+ "description": "Total amount of the carbon removal in the currency's smallest unit.",
+ "type": "integer"
+ },
+ "amount_total": {
+ "description": "Total amount of the order including fees in the currency's smallest unit.",
+ "type": "integer"
+ },
+ "beneficiary": {
+ "$ref": "#/components/schemas/climate_removals_beneficiary"
+ },
+ "canceled_at": {
+ "description": "Time at which the order was canceled. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "cancellation_reason": {
+ "description": "Reason for the cancellation of this order.",
+ "enum": [
+ "expired",
+ "product_unavailable",
+ "requested"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "certificate": {
+ "description": "For delivered orders, a URL to a delivery certificate for the order.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "confirmed_at": {
+ "description": "Time at which the order was confirmed. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "currency": {
+ "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase, representing the currency for this order.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "delayed_at": {
+ "description": "Time at which the order's expected_delivery_year was delayed. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "delivered_at": {
+ "description": "Time at which the order was delivered. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "delivery_details": {
+ "description": "Details about the delivery of carbon removal for this order.",
+ "items": {
+ "$ref": "#/components/schemas/climate_removals_order_deliveries"
+ },
+ "type": "array"
+ },
+ "expected_delivery_year": {
+ "description": "The year this order is expected to be delivered.",
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
+ "type": "object"
+ },
+ "metric_tons": {
+ "description": "Quantity of carbon removal that is included in this order.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "climate.order"
+ ],
+ "type": "string"
+ },
+ "product": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "$ref": "#/components/schemas/climate.product"
+ }
+ ],
+ "description": "Unique ID for the Climate `Product` this order is purchasing.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/climate.product"
+ }
+ ]
+ }
+ },
+ "product_substituted_at": {
+ "description": "Time at which the order's product was substituted for a different product. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "status": {
+ "description": "The current status of this order.",
+ "enum": [
+ "awaiting_funds",
+ "canceled",
+ "confirmed",
+ "delivered",
+ "open"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount_fees",
+ "amount_subtotal",
+ "amount_total",
+ "canceled_at",
+ "cancellation_reason",
+ "certificate",
+ "confirmed_at",
+ "created",
+ "currency",
+ "delayed_at",
+ "delivered_at",
+ "delivery_details",
+ "expected_delivery_year",
+ "id",
+ "livemode",
+ "metadata",
+ "metric_tons",
+ "object",
+ "product",
+ "product_substituted_at",
+ "status"
+ ],
+ "title": "ClimateRemovalsOrders",
+ "type": "object",
+ "x-expandableFields": [
+ "beneficiary",
+ "delivery_details",
+ "product"
+ ],
+ "x-resourceId": "climate.order",
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/climate/orders/{order}"
+ },
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/climate/orders"
+ },
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/climate/orders"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/climate/orders/{order}"
+ },
+ {
+ "method_name": "cancel",
+ "method_on": "service",
+ "method_type": "custom",
+ "operation": "post",
+ "path": "/v1/climate/orders/{order}/cancel"
+ }
],
"x-stripeResource": {
- "class_name": "UsBankAccount",
- "in_package": ""
+ "class_name": "Order",
+ "has_collection_class": true,
+ "in_package": "Climate"
+ }
+ },
+ "climate.order.canceled": {
+ "description": "Occurs when a Climate order is canceled.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.order.canceled"
+ }
+ },
+ "climate.order.created": {
+ "description": "Occurs when a Climate order is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.order.created"
+ }
+ },
+ "climate.order.delayed": {
+ "description": "Occurs when a Climate order is delayed.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.order.delayed"
+ }
+ },
+ "climate.order.delivered": {
+ "description": "Occurs when a Climate order is delivered.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.order.delivered"
}
},
+ "climate.order.product_substituted": {
+ "description": "Occurs when a Climate order's product is substituted for another.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.order.product_substituted"
+ }
+ },
+ "climate.product": {
+ "description": "A Climate product represents a type of carbon removal unit available for reservation.\nYou can retrieve it to see the current price and availability.",
+ "properties": {
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "current_prices_per_metric_ton": {
+ "additionalProperties": {
+ "$ref": "#/components/schemas/climate_removals_products_price"
+ },
+ "description": "Current prices for a metric ton of carbon removal in a currency's smallest unit.",
+ "type": "object"
+ },
+ "delivery_year": {
+ "description": "The year in which the carbon removal is expected to be delivered.",
+ "nullable": true,
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier for the object. For convenience, Climate product IDs are human-readable strings\nthat start with `climsku_`. See [carbon removal inventory](https://stripe.com/docs/climate/orders/carbon-removal-inventory)\nfor a list of available carbon removal products.",
+ "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"
+ },
+ "metric_tons_available": {
+ "description": "The quantity of metric tons available for reservation.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "name": {
+ "description": "The Climate product's name.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "climate.product"
+ ],
+ "type": "string"
+ },
+ "suppliers": {
+ "description": "The carbon removal suppliers that fulfill orders for this Climate product.",
+ "items": {
+ "$ref": "#/components/schemas/climate.supplier"
+ },
+ "type": "array"
+ }
+ },
+ "required": [
+ "created",
+ "current_prices_per_metric_ton",
+ "delivery_year",
+ "id",
+ "livemode",
+ "metric_tons_available",
+ "name",
+ "object",
+ "suppliers"
+ ],
+ "title": "ClimateRemovalsProducts",
+ "type": "object",
+ "x-expandableFields": [
+ "current_prices_per_metric_ton",
+ "suppliers"
+ ],
+ "x-resourceId": "climate.product",
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/climate/products/{product}"
+ },
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/climate/products"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "Product",
+ "has_collection_class": true,
+ "in_package": "Climate"
+ }
+ },
+ "climate.product.created": {
+ "description": "Occurs when a Climate product is created.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.product"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.product.created"
+ }
+ },
+ "climate.product.pricing_updated": {
+ "description": "Occurs when a Climate product is updated.",
+ "properties": {
+ "object": {
+ "$ref": "#/components/schemas/climate.product"
+ }
+ },
+ "required": [
+ "object"
+ ],
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeEvent": {
+ "type": "climate.product.pricing_updated"
+ }
+ },
+ "climate.supplier": {
+ "description": "A supplier of carbon removal.",
+ "properties": {
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "info_url": {
+ "description": "Link to a webpage to learn more about the supplier.",
+ "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"
+ },
+ "locations": {
+ "description": "The locations in which this supplier operates.",
+ "items": {
+ "$ref": "#/components/schemas/climate_removals_location"
+ },
+ "type": "array"
+ },
+ "name": {
+ "description": "Name of this carbon removal supplier.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "object": {
+ "description": "String representing the object’s type. Objects of the same type share the same value.",
+ "enum": [
+ "climate.supplier"
+ ],
+ "type": "string"
+ },
+ "removal_pathway": {
+ "description": "The scientific pathway used for carbon removal.",
+ "enum": [
+ "biomass_carbon_removal_and_storage",
+ "direct_air_capture",
+ "enhanced_weathering"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "id",
+ "info_url",
+ "livemode",
+ "locations",
+ "name",
+ "object",
+ "removal_pathway"
+ ],
+ "title": "ClimateRemovalsSuppliers",
+ "type": "object",
+ "x-expandableFields": [
+ "locations"
+ ],
+ "x-resourceId": "climate.supplier",
+ "x-stripeOperations": [
+ {
+ "method_name": "retrieve",
+ "method_on": "service",
+ "method_type": "retrieve",
+ "operation": "get",
+ "path": "/v1/climate/suppliers/{supplier}"
+ },
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/climate/suppliers"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "Supplier",
+ "has_collection_class": true,
+ "in_package": "Climate"
+ }
+ },
+ "climate_removals_beneficiary": {
+ "description": "",
+ "properties": {
+ "public_name": {
+ "description": "Publicly displayable name for the end beneficiary of carbon removal.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "public_name"
+ ],
+ "title": "ClimateRemovalsBeneficiary",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "climate_removals_location": {
+ "description": "",
+ "properties": {
+ "city": {
+ "description": "The city where the supplier is located.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "country": {
+ "description": "Two-letter ISO code representing the country where the supplier is located.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "latitude": {
+ "description": "The geographic latitude where the supplier is located.",
+ "nullable": true,
+ "type": "number"
+ },
+ "longitude": {
+ "description": "The geographic longitude where the supplier is located.",
+ "nullable": true,
+ "type": "number"
+ },
+ "region": {
+ "description": "The state/county/province/region where the supplier is located.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "city",
+ "country",
+ "latitude",
+ "longitude",
+ "region"
+ ],
+ "title": "ClimateRemovalsLocation",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "climate_removals_order_deliveries": {
+ "description": "The delivery of a specified quantity of carbon for an order.",
+ "properties": {
+ "delivered_at": {
+ "description": "Time at which the delivery occurred. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "location": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/climate_removals_location"
+ }
+ ],
+ "description": "Specific location of this delivery.",
+ "nullable": true
+ },
+ "metric_tons": {
+ "description": "Quantity of carbon removal supplied by this delivery.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "registry_url": {
+ "description": "Once retired, a URL to the registry entry for the tons from this delivery.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "supplier": {
+ "$ref": "#/components/schemas/climate.supplier"
+ }
+ },
+ "required": [
+ "delivered_at",
+ "location",
+ "metric_tons",
+ "registry_url",
+ "supplier"
+ ],
+ "title": "ClimateRemovalsOrderDeliveries",
+ "type": "object",
+ "x-expandableFields": [
+ "location",
+ "supplier"
+ ]
+ },
+ "climate_removals_products_price": {
+ "description": "",
+ "properties": {
+ "amount_fees": {
+ "description": "Fees for one metric ton of carbon removal in the currency's smallest unit.",
+ "type": "integer"
+ },
+ "amount_subtotal": {
+ "description": "Subtotal for one metric ton of carbon removal (excluding fees) in the currency's smallest unit.",
+ "type": "integer"
+ },
+ "amount_total": {
+ "description": "Total for one metric ton of carbon removal (including fees) in the currency's smallest unit.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount_fees",
+ "amount_subtotal",
+ "amount_total"
+ ],
+ "title": "ClimateRemovalsProductsPrice",
+ "type": "object",
+ "x-expandableFields": []
+ },
"connect_collection_transfer": {
"description": "",
"properties": {
@@ -7188,6 +7664,15 @@
"properties": {
"account_onboarding": {
"$ref": "#/components/schemas/connect_embedded_base_config_claim"
+ },
+ "payment_details": {
+ "$ref": "#/components/schemas/connect_embedded_payments_config"
+ },
+ "payments": {
+ "$ref": "#/components/schemas/connect_embedded_payments_config"
+ },
+ "payouts": {
+ "$ref": "#/components/schemas/connect_embedded_payouts_config"
}
},
"required": [
@@ -7196,7 +7681,10 @@
"title": "ConnectEmbeddedAccountSessionCreateComponents",
"type": "object",
"x-expandableFields": [
- "account_onboarding"
+ "account_onboarding",
+ "payment_details",
+ "payments",
+ "payouts"
],
"x-stripeResource": {
"class_name": "Components",
@@ -7209,19 +7697,142 @@
"enabled": {
"description": "Whether the embedded component is enabled.",
"type": "boolean"
+ },
+ "features": {
+ "$ref": "#/components/schemas/connect_embedded_base_features"
}
},
"required": [
- "enabled"
+ "enabled",
+ "features"
],
"title": "ConnectEmbeddedBaseConfigClaim",
"type": "object",
- "x-expandableFields": [],
+ "x-expandableFields": [
+ "features"
+ ],
"x-stripeResource": {
"class_name": "BaseConfig",
"in_package": ""
}
},
+ "connect_embedded_base_features": {
+ "description": "",
+ "properties": {},
+ "title": "ConnectEmbeddedBaseFeatures",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "BaseFeatures",
+ "in_package": ""
+ }
+ },
+ "connect_embedded_payments_config": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "$ref": "#/components/schemas/connect_embedded_payments_features"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "ConnectEmbeddedPaymentsConfig",
+ "type": "object",
+ "x-expandableFields": [
+ "features"
+ ],
+ "x-stripeResource": {
+ "class_name": "PaymentsConfig",
+ "in_package": ""
+ }
+ },
+ "connect_embedded_payments_features": {
+ "description": "",
+ "properties": {
+ "capture_payments": {
+ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
+ "type": "boolean"
+ },
+ "dispute_management": {
+ "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
+ "type": "boolean"
+ },
+ "refund_management": {
+ "description": "Whether to allow sending refunds. This is `true` by default.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "capture_payments",
+ "dispute_management",
+ "refund_management"
+ ],
+ "title": "ConnectEmbeddedPaymentsFeatures",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "PaymentsFeatures",
+ "in_package": ""
+ }
+ },
+ "connect_embedded_payouts_config": {
+ "description": "",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "$ref": "#/components/schemas/connect_embedded_payouts_features"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "ConnectEmbeddedPayoutsConfig",
+ "type": "object",
+ "x-expandableFields": [
+ "features"
+ ],
+ "x-stripeResource": {
+ "class_name": "PayoutsConfig",
+ "in_package": ""
+ }
+ },
+ "connect_embedded_payouts_features": {
+ "description": "",
+ "properties": {
+ "edit_payout_schedule": {
+ "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ },
+ "instant_payouts": {
+ "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ },
+ "standard_payouts": {
+ "description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ }
+ },
+ "required": [
+ "edit_payout_schedule",
+ "instant_payouts",
+ "standard_payouts"
+ ],
+ "title": "ConnectEmbeddedPayoutsFeatures",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "PayoutsFeatures",
+ "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": {
@@ -7345,11 +7956,7 @@
],
"title": "CountrySpecVerificationFieldDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Details",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"country_spec_verification_fields": {
"description": "",
@@ -7370,11 +7977,7 @@
"x-expandableFields": [
"company",
"individual"
- ],
- "x-stripeResource": {
- "class_name": "VerificationFields",
- "in_package": ""
- }
+ ]
},
"coupon": {
"description": "A coupon contains information about a percent-off or amount-off discount you\nmight want to apply to a customer. Coupons may be applied to [subscriptions](https://stripe.com/docs/api#subscriptions), [invoices](https://stripe.com/docs/api#invoices),\n[checkout sessions](https://stripe.com/docs/api/checkout/sessions), [quotes](https://stripe.com/docs/api#quotes), and more. Coupons do not work with conventional one-off [charges](https://stripe.com/docs/api#create_charge) or [payment intents](https://stripe.com/docs/api/payment_intents).",
@@ -7607,11 +8210,7 @@
],
"title": "CouponAppliesTo",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AppliesTo",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"coupon_currency_option": {
"description": "",
@@ -7626,11 +8225,7 @@
],
"title": "CouponCurrencyOption",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrencyOption",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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)",
@@ -8268,11 +8863,7 @@
"type": "object",
"x-expandableFields": [
"tax_rate"
- ],
- "x-stripeResource": {
- "class_name": "TaxAmount",
- "in_package": ""
- }
+ ]
},
"currency_option": {
"description": "",
@@ -8326,11 +8917,7 @@
"x-expandableFields": [
"custom_unit_amount",
"tiers"
- ],
- "x-stripeResource": {
- "class_name": "CurrencyOption",
- "in_package": ""
- }
+ ]
},
"custom_unit_amount": {
"description": "",
@@ -8358,11 +8945,7 @@
],
"title": "CustomUnitAmount",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomUnitAmount",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer": {
"description": "This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.\n\nRelated guide: [Save a card during payment](https://stripe.com/docs/payments/save-during-payment)",
@@ -9196,11 +9779,7 @@
"x-expandableFields": [
"offline",
"online"
- ],
- "x-stripeResource": {
- "class_name": "CustomerAcceptance",
- "in_package": ""
- }
+ ]
},
"customer_balance_customer_balance_settings": {
"description": "",
@@ -9224,11 +9803,7 @@
],
"title": "CustomerBalanceCustomerBalanceSettings",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BalanceSettings",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer_balance_resource_cash_balance_transaction_resource_adjusted_for_overdraft": {
"description": "",
@@ -9317,11 +9892,7 @@
"type": "object",
"x-expandableFields": [
"payment_intent"
- ],
- "x-stripeResource": {
- "class_name": "AppliedToPayment",
- "in_package": ""
- }
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction": {
"description": "",
@@ -9337,11 +9908,7 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "Funded",
- "in_package": ""
- }
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer": {
"description": "",
@@ -9388,11 +9955,7 @@
"gb_bank_transfer",
"jp_bank_transfer",
"us_bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "BankTransfer",
- "in_package": ""
- }
+ ]
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_eu_bank_transfer": {
"description": "",
@@ -9423,11 +9986,7 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceEuBankTransfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EuBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_gb_bank_transfer": {
"description": "",
@@ -9458,11 +10017,7 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceGbBankTransfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GbBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_jp_bank_transfer": {
"description": "",
@@ -9493,11 +10048,7 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceJpBankTransfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "JpBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer_balance_resource_cash_balance_transaction_resource_funded_transaction_resource_bank_transfer_resource_us_bank_transfer": {
"description": "",
@@ -9523,11 +10074,7 @@
],
"title": "CustomerBalanceResourceCashBalanceTransactionResourceFundedTransactionResourceBankTransferResourceUsBankTransfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "UsBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction": {
"description": "",
@@ -9565,6 +10112,42 @@
"in_package": ""
}
},
+ "customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance": {
+ "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 transferred to your Stripe balance.",
+ "x-expansionResources": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/balance_transaction"
+ }
+ ]
+ }
+ }
+ },
+ "required": [
+ "balance_transaction"
+ ],
+ "title": "CustomerBalanceResourceCashBalanceTransactionResourceTransferredToBalance",
+ "type": "object",
+ "x-expandableFields": [
+ "balance_transaction"
+ ],
+ "x-stripeResource": {
+ "class_name": "TransferredToBalance",
+ "in_package": ""
+ }
+ },
"customer_balance_resource_cash_balance_transaction_resource_unapplied_from_payment_transaction": {
"description": "",
"properties": {
@@ -9876,6 +10459,9 @@
"refunded_from_payment": {
"$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_refunded_from_payment_transaction"
},
+ "transferred_to_balance": {
+ "$ref": "#/components/schemas/customer_balance_resource_cash_balance_transaction_resource_transferred_to_balance"
+ },
"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": [
@@ -9886,6 +10472,7 @@
"refunded_from_payment",
"return_canceled",
"return_initiated",
+ "transferred_to_balance",
"unapplied_from_payment"
],
"type": "string"
@@ -9913,6 +10500,7 @@
"customer",
"funded",
"refunded_from_payment",
+ "transferred_to_balance",
"unapplied_from_payment"
],
"x-resourceId": "customer_cash_balance_transaction",
@@ -10009,11 +10597,7 @@
"type": "object",
"x-expandableFields": [
"location"
- ],
- "x-stripeResource": {
- "class_name": "Tax",
- "in_package": ""
- }
+ ]
},
"customer_tax_location": {
"description": "",
@@ -10047,11 +10631,7 @@
],
"title": "CustomerTaxLocation",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Location",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"deleted_account": {
"description": "",
@@ -11041,6 +11621,13 @@
"in_package": ""
}
},
+ "destination_details_unimplemented": {
+ "description": "",
+ "properties": {},
+ "title": "destination_details_unimplemented",
+ "type": "object",
+ "x-expandableFields": []
+ },
"discount": {
"description": "A discount represents the actual application of a [coupon](https://stripe.com/docs/api#coupons) or [promotion code](https://stripe.com/docs/api#promotion_codes).\nIt contains information about when the discount began, when it will end, and what it is applied to.\n\nRelated guide: [Applying discounts to subscriptions](https://stripe.com/docs/billing/subscriptions/discounts)",
"properties": {
@@ -11207,11 +11794,7 @@
"type": "object",
"x-expandableFields": [
"discount"
- ],
- "x-stripeResource": {
- "class_name": "DiscountAmount",
- "in_package": ""
- }
+ ]
},
"dispute": {
"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)",
@@ -11737,11 +12320,7 @@
"service_documentation",
"shipping_documentation",
"uncategorized_file"
- ],
- "x-stripeResource": {
- "class_name": "Evidence",
- "in_package": ""
- }
+ ]
},
"dispute_evidence_details": {
"description": "",
@@ -11773,11 +12352,7 @@
],
"title": "DisputeEvidenceDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EvidenceDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"dispute_payment_method_details": {
"description": "",
@@ -11807,11 +12382,7 @@
"type": "object",
"x-expandableFields": [
"card"
- ],
- "x-stripeResource": {
- "class_name": "DisputePaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"dispute_payment_method_details_card": {
"description": "",
@@ -11834,11 +12405,7 @@
],
"title": "DisputePaymentMethodDetailsCard",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DisputePaymentMethodDetailsCard",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"email_sent": {
"description": "",
@@ -11860,11 +12427,7 @@
],
"title": "EmailSent",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EmailSent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"ephemeral_key": {
"description": "",
@@ -11950,7 +12513,7 @@
}
},
"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. 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.",
+ "description": "Events are our way of letting you know when something interesting happens in\nyour account. When an interesting event occurs, we create a new `Event`\nobject. For example, when a charge succeeds, we create a `charge.succeeded`\nevent, and when an invoice payment attempt fails, we create an\n`invoice.payment_failed` event. Certain API requests might create multiple\nevents. For example, if you create a new subscription for a\ncustomer, you receive both a `customer.subscription.created` event and a\n`charge.succeeded` event.\n\nEvents occur when the state of another API resource changes. The event's data\nfield embeds the resource's state at the time of the change. For\nexample, a `charge.succeeded` event contains a charge, and an\n`invoice.payment_failed` event contains an invoice.\n\nAs with other API resources, you can use endpoints to retrieve an\n[individual event](https://stripe.com/docs/api#retrieve_event) or a [list of events](https://stripe.com/docs/api#list_events)\nfrom the API. We also have a separate\n[webhooks](http://en.wikipedia.org/wiki/Webhook) system for sending the\n`Event` objects directly to an endpoint on your server. You can manage\nwebhooks in your\n[account settings](https://dashboard.stripe.com/account/webhooks). Learn how\nto [listen for events](https://stripe.com/docs/webhooks)\nso 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 originates the event.",
@@ -12035,6 +12598,13 @@
"checkout.session.async_payment_succeeded",
"checkout.session.completed",
"checkout.session.expired",
+ "climate.order.canceled",
+ "climate.order.created",
+ "climate.order.delayed",
+ "climate.order.delivered",
+ "climate.order.product_substituted",
+ "climate.product.created",
+ "climate.product.pricing_updated",
"coupon.created",
"coupon.deleted",
"coupon.updated",
@@ -12266,7 +12836,7 @@
}
},
"exchange_rate": {
- "description": "`Exchange Rate` objects allow you to determine the rates that Stripe is\ncurrently using to convert from one currency to another. Since this number is\nvariable throughout the day, there are various reasons why you might want to\nknow the current rate (for example, to dynamically price an item for a user\nwith a default payment in a foreign currency).\n\nIf you want a guarantee that the charge is made with a certain exchange rate\nyou expect is current, you can pass in `exchange_rate` to charges endpoints.\nIf the value is no longer up to date, the charge won't go through. Please\nrefer to our [Exchange Rates API](https://stripe.com/docs/exchange-rates) guide for more\ndetails.",
+ "description": "`ExchangeRate` objects allow you to determine the rates that Stripe is currently\nusing to convert from one currency to another. Since this number is variable\nthroughout the day, there are various reasons why you might want to know the current\nrate (for example, to dynamically price an item for a user with a default\npayment in a foreign currency).\n\nPlease refer to our [Exchange Rates API](https://stripe.com/docs/fx-rates) guide for more details.\n\n*[Note: this integration path is supported but no longer recommended]* Additionally,\nyou can guarantee that a charge is made with an exchange rate that you expect is\ncurrent. To do so, you must pass in the exchange_rate to charges endpoints. If the\nvalue is no longer up to date, the charge won't go through. Please refer to our\n[Using with charges](https://stripe.com/docs/exchange-rates) guide for more details.\n\n-----\n\n \n\n*This Exchange Rates API is a Beta Service and is subject to Stripe's terms of service. You may use the API solely for the purpose of transacting on Stripe. For example, the API may be queried in order to:*\n\n- *localize prices for processing payments on Stripe*\n- *reconcile Stripe transactions*\n- *determine how much money to send to a connected account*\n- *determine app fees to charge a connected account*\n\n*Using this Exchange Rates API beta for any purpose other than to transact on Stripe is strictly prohibited and constitutes a violation of Stripe's terms of service.*",
"properties": {
"id": {
"description": "Unique identifier for the object. Represented as the three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html) in lowercase.",
@@ -12443,11 +13013,7 @@
"type": "object",
"x-expandableFields": [
"errors"
- ],
- "x-stripeResource": {
- "class_name": "ExternalAccountRequirements",
- "in_package": ""
- }
+ ]
},
"fee": {
"description": "",
@@ -12487,11 +13053,7 @@
],
"title": "Fee",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fee",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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)",
@@ -12648,7 +13210,7 @@
}
},
"file": {
- "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)",
+ "description": "This object represents files hosted on Stripe's servers. You can upload\nfiles with the [create file](https://stripe.com/docs/api#create_file) request\n(for example, when uploading dispute evidence). Stripe also\ncreates files independently (for example, the results of a [Sigma scheduled\nquery](#scheduled_queries)).\n\nRelated guide: [File upload guide](https://stripe.com/docs/file-upload)",
"properties": {
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
@@ -12707,7 +13269,7 @@
"object",
"url"
],
- "title": "FileFileLinkList",
+ "title": "FileResourceFileLinkList",
"type": "object",
"x-expandableFields": [
"data"
@@ -13597,11 +14159,7 @@
},
"title": "FinancialReportingFinanceReportRunRunParameters",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Parameters",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"funding_instructions": {
"description": "Each customer has a [`balance`](https://stripe.com/docs/api/customers/object#customer_object-balance) that is\nautomatically applied to future invoices and payments using the `customer_balance` payment method.\nCustomers can fund this balance by initiating a bank transfer to any account in the\n`financial_addresses` field.\nRelated guide: [Customer balance funding instructions](https://stripe.com/docs/payments/customer-balance/funding-instructions)",
@@ -13691,9 +14249,44 @@
"in_package": ""
}
},
+ "funding_instructions_bank_transfer_aba_record": {
+ "description": "ABA Records contain U.S. bank account details per the ABA format.",
+ "properties": {
+ "account_number": {
+ "description": "The ABA account number",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "The bank name",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "routing_number": {
+ "description": "The ABA routing number",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "account_number",
+ "bank_name",
+ "routing_number"
+ ],
+ "title": "FundingInstructionsBankTransferABARecord",
+ "type": "object",
+ "x-expandableFields": [],
+ "x-stripeResource": {
+ "class_name": "Aba",
+ "in_package": ""
+ }
+ },
"funding_instructions_bank_transfer_financial_address": {
"description": "FinancialAddresses contain identifying information that resolves to a FinancialAccount.",
"properties": {
+ "aba": {
+ "$ref": "#/components/schemas/funding_instructions_bank_transfer_aba_record"
+ },
"iban": {
"$ref": "#/components/schemas/funding_instructions_bank_transfer_iban_record"
},
@@ -13707,10 +14300,13 @@
"description": "The payment networks supported by this FinancialAddress",
"items": {
"enum": [
+ "ach",
"bacs",
+ "domestic_wire_us",
"fps",
"sepa",
"spei",
+ "swift",
"zengin"
],
"type": "string",
@@ -13718,12 +14314,17 @@
},
"type": "array"
},
+ "swift": {
+ "$ref": "#/components/schemas/funding_instructions_bank_transfer_swift_record"
+ },
"type": {
"description": "The type of financial address",
"enum": [
+ "aba",
"iban",
"sort_code",
"spei",
+ "swift",
"zengin"
],
"type": "string",
@@ -13739,15 +14340,13 @@
"title": "FundingInstructionsBankTransferFinancialAddress",
"type": "object",
"x-expandableFields": [
+ "aba",
"iban",
"sort_code",
"spei",
+ "swift",
"zengin"
- ],
- "x-stripeResource": {
- "class_name": "FinancialAddress",
- "in_package": ""
- }
+ ]
},
"funding_instructions_bank_transfer_iban_record": {
"description": "Iban Records contain E.U. bank account details per the SEPA format.",
@@ -13781,11 +14380,7 @@
],
"title": "FundingInstructionsBankTransferIbanRecord",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Iban",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"funding_instructions_bank_transfer_sort_code_record": {
"description": "Sort Code Records contain U.K. bank account details per the sort code format.",
@@ -13815,7 +14410,7 @@
"type": "object",
"x-expandableFields": [],
"x-stripeResource": {
- "class_name": "SortCode",
+ "class_name": "SortCodeRecords",
"in_package": ""
}
},
@@ -13845,11 +14440,35 @@
],
"title": "FundingInstructionsBankTransferSpeiRecord",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Spei",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "funding_instructions_bank_transfer_swift_record": {
+ "description": "SWIFT Records contain U.S. bank account details per the SWIFT format.",
+ "properties": {
+ "account_number": {
+ "description": "The account number",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "bank_name": {
+ "description": "The bank name",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "swift_code": {
+ "description": "The SWIFT code",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "account_number",
+ "bank_name",
+ "swift_code"
+ ],
+ "title": "FundingInstructionsBankTransferSwiftRecord",
+ "type": "object",
+ "x-expandableFields": []
},
"funding_instructions_bank_transfer_zengin_record": {
"description": "Zengin Records contain Japan bank account details per the Zengin format.",
@@ -13908,11 +14527,7 @@
],
"title": "FundingInstructionsBankTransferZenginRecord",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Zengin",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_data_document_report_date_of_birth": {
"description": "Point in Time",
@@ -13940,11 +14555,7 @@
],
"title": "GelatoDataDocumentReportDateOfBirth",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_data_document_report_expiration_date": {
"description": "Point in Time",
@@ -13972,11 +14583,7 @@
],
"title": "GelatoDataDocumentReportExpirationDate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ExpirationDate",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_data_document_report_issued_date": {
"description": "Point in Time",
@@ -14004,11 +14611,7 @@
],
"title": "GelatoDataDocumentReportIssuedDate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "IssuedDate",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_data_id_number_report_date": {
"description": "Point in Time",
@@ -14036,11 +14639,7 @@
],
"title": "GelatoDataIdNumberReportDate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_data_verified_outputs_date": {
"description": "Point in Time",
@@ -14068,11 +14667,7 @@
],
"title": "GelatoDataVerifiedOutputsDate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_document_report": {
"description": "Result from a document check",
@@ -14197,11 +14792,7 @@
"error",
"expiration_date",
"issued_date"
- ],
- "x-stripeResource": {
- "class_name": "Document",
- "in_package": ""
- }
+ ]
},
"gelato_document_report_error": {
"description": "",
@@ -14230,11 +14821,7 @@
],
"title": "GelatoDocumentReportError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DocumentCheckError",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_id_number_report": {
"description": "Result from an id_number check",
@@ -14309,11 +14896,7 @@
"x-expandableFields": [
"dob",
"error"
- ],
- "x-stripeResource": {
- "class_name": "IdNumber",
- "in_package": ""
- }
+ ]
},
"gelato_id_number_report_error": {
"description": "",
@@ -14341,11 +14924,7 @@
],
"title": "GelatoIdNumberReportError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "IdNumberCheckError",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_report_document_options": {
"description": "",
@@ -14377,22 +14956,14 @@
},
"title": "GelatoReportDocumentOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Document",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_report_id_number_options": {
"description": "",
"properties": {},
"title": "GelatoReportIdNumberOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "IdNumber",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_selfie_report": {
"description": "Result from a selfie check",
@@ -14438,11 +15009,7 @@
"type": "object",
"x-expandableFields": [
"error"
- ],
- "x-stripeResource": {
- "class_name": "Selfie",
- "in_package": ""
- }
+ ]
},
"gelato_selfie_report_error": {
"description": "",
@@ -14471,11 +15038,7 @@
],
"title": "GelatoSelfieReportError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SelfieCheckError",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_session_document_options": {
"description": "",
@@ -14507,22 +15070,14 @@
},
"title": "GelatoSessionDocumentOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Document",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_session_id_number_options": {
"description": "",
"properties": {},
"title": "GelatoSessionIdNumberOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "IdNumber",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_session_last_error": {
"description": "Shows last VerificationSession error",
@@ -14563,11 +15118,7 @@
],
"title": "GelatoSessionLastError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LastError",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"gelato_verification_report_options": {
"description": "",
@@ -14584,11 +15135,7 @@
"x-expandableFields": [
"document",
"id_number"
- ],
- "x-stripeResource": {
- "class_name": "Options",
- "in_package": ""
- }
+ ]
},
"gelato_verification_session_options": {
"description": "",
@@ -14605,11 +15152,7 @@
"x-expandableFields": [
"document",
"id_number"
- ],
- "x-stripeResource": {
- "class_name": "Options",
- "in_package": ""
- }
+ ]
},
"gelato_verified_outputs": {
"description": "",
@@ -14674,11 +15217,7 @@
"x-expandableFields": [
"address",
"dob"
- ],
- "x-stripeResource": {
- "class_name": "VerifiedOutputs",
- "in_package": ""
- }
+ ]
},
"identity.verification_report": {
"description": "A VerificationReport is the result of an attempt to collect and verify data from a user.\nThe collection of verification checks performed is determined from the `type` and `options`\nparameters used. You can find the result of each verification check performed in the\nappropriate sub-resource: `document`, `id_number`, `selfie`.\n\nEach VerificationReport contains a copy of any data collected by the user as well as\nreference IDs which can be used to access collected images through the [FileUpload](https://stripe.com/docs/api/files)\nAPI. To configure and create VerificationReports, use the\n[VerificationSession](https://stripe.com/docs/api/identity/verification_sessions) API.\n\nRelated guides: [Accessing verification results](https://stripe.com/docs/identity/verification-sessions#results).",
@@ -15090,11 +15629,7 @@
"x-expandableFields": [
"billing_details",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "OriginPaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"inbound_transfers_payment_method_details_us_bank_account": {
"description": "",
@@ -16358,11 +16893,7 @@
],
"title": "invoice_installments_card",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Installments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_item_threshold_reason": {
"description": "",
@@ -16386,11 +16917,7 @@
],
"title": "InvoiceItemThresholdReason",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ThresholdItemReason",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_line_item_period": {
"description": "",
@@ -16412,11 +16939,7 @@
],
"title": "InvoiceLineItemPeriod",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceLineItemPeriod",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_mandate_options_card": {
"description": "",
@@ -16449,11 +16972,7 @@
],
"title": "invoice_mandate_options_card",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MandateOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_payment_method_options_acss_debit": {
"description": "",
@@ -16476,11 +16995,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ ]
},
"invoice_payment_method_options_acss_debit_mandate_options": {
"description": "",
@@ -16500,11 +17015,7 @@
],
"title": "invoice_payment_method_options_acss_debit_mandate_options",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MandateOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_payment_method_options_bancontact": {
"description": "",
@@ -16525,11 +17036,7 @@
],
"title": "invoice_payment_method_options_bancontact",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Bancontact",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_payment_method_options_card": {
"description": "",
@@ -16554,11 +17061,7 @@
"type": "object",
"x-expandableFields": [
"installments"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"invoice_payment_method_options_customer_balance": {
"description": "",
@@ -16582,11 +17085,7 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "CustomerBalance",
- "in_package": ""
- }
+ ]
},
"invoice_payment_method_options_customer_balance_bank_transfer": {
"description": "",
@@ -16607,11 +17106,7 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "BankTransfer",
- "in_package": ""
- }
+ ]
},
"invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer": {
"description": "",
@@ -16634,22 +17129,14 @@
],
"title": "invoice_payment_method_options_customer_balance_bank_transfer_eu_bank_transfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EuBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_payment_method_options_konbini": {
"description": "",
"properties": {},
"title": "invoice_payment_method_options_konbini",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Konbini",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_payment_method_options_us_bank_account": {
"description": "",
@@ -16672,11 +17159,7 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
- ],
- "x-stripeResource": {
- "class_name": "UsBankAccount",
- "in_package": ""
- }
+ ]
},
"invoice_payment_method_options_us_bank_account_linked_account_options": {
"description": "",
@@ -16712,11 +17195,7 @@
],
"title": "invoice_payment_method_options_us_bank_account_linked_account_options",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "FinancialConnections",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_rendering_pdf": {
"description": "",
@@ -16737,11 +17216,7 @@
],
"title": "InvoiceRenderingPdf",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceRenderingPdfResource",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_setting_custom_field": {
"description": "",
@@ -16763,11 +17238,7 @@
],
"title": "InvoiceSettingCustomField",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomField",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_setting_customer_setting": {
"description": "",
@@ -16828,11 +17299,7 @@
"custom_fields",
"default_payment_method",
"rendering_options"
- ],
- "x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_package": ""
- }
+ ]
},
"invoice_setting_quote_setting": {
"description": "",
@@ -16848,11 +17315,7 @@
],
"title": "InvoiceSettingQuoteSetting",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_setting_rendering_options": {
"description": "",
@@ -16869,11 +17332,7 @@
],
"title": "InvoiceSettingRenderingOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "RenderingOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_setting_subscription_schedule_phase_setting": {
"description": "",
@@ -16889,11 +17348,7 @@
],
"title": "InvoiceSettingSubscriptionSchedulePhaseSetting",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_setting_subscription_schedule_setting": {
"description": "",
@@ -16909,11 +17364,7 @@
],
"title": "InvoiceSettingSubscriptionScheduleSetting",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoice_tax_amount": {
"description": "",
@@ -16985,11 +17436,7 @@
"type": "object",
"x-expandableFields": [
"tax_rate"
- ],
- "x-stripeResource": {
- "class_name": "TaxAmount",
- "in_package": ""
- }
+ ]
},
"invoice_threshold_reason": {
"description": "",
@@ -17015,11 +17462,7 @@
"type": "object",
"x-expandableFields": [
"item_reasons"
- ],
- "x-stripeResource": {
- "class_name": "ThresholdReason",
- "in_package": ""
- }
+ ]
},
"invoice_transfer_data": {
"description": "",
@@ -17057,11 +17500,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "in_package": ""
- }
+ ]
},
"invoiceitem": {
"description": "Invoice Items represent the component lines of an [invoice](https://stripe.com/docs/api/invoices). An invoice item is added to an\ninvoice by creating or updating it with an `invoice` field, at which point it will be included as\n[an invoice line item](https://stripe.com/docs/api/invoices/line_item) within\n[invoice.lines](https://stripe.com/docs/api/invoices/object#invoice_object-lines).\n\nInvoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined\nwith a [subscription](https://stripe.com/docs/api/subscriptions). Sometimes you want to add a charge or credit to a customer, but actually charge\nor credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges\n(to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.\n\nRelated guides: [Integrate with the Invoicing API](https://stripe.com/docs/invoicing/integration), [Subscription Invoices](https://stripe.com/docs/billing/invoices/subscription#adding-upcoming-invoice-items).",
@@ -17425,11 +17864,7 @@
"type": "object",
"x-expandableFields": [
"invoice"
- ],
- "x-stripeResource": {
- "class_name": "FromInvoice",
- "in_package": ""
- }
+ ]
},
"invoices_invoice_rendering": {
"description": "",
@@ -17458,11 +17893,7 @@
"type": "object",
"x-expandableFields": [
"pdf"
- ],
- "x-stripeResource": {
- "class_name": "InvoiceRendering",
- "in_package": ""
- }
+ ]
},
"invoices_payment_method_options": {
"description": "",
@@ -17539,11 +17970,7 @@
"customer_balance",
"konbini",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodOptions",
- "in_package": ""
- }
+ ]
},
"invoices_payment_settings": {
"description": "",
@@ -17608,11 +18035,7 @@
"type": "object",
"x-expandableFields": [
"payment_method_options"
- ],
- "x-stripeResource": {
- "class_name": "PaymentSettings",
- "in_package": ""
- }
+ ]
},
"invoices_resource_invoice_tax_id": {
"description": "",
@@ -17703,11 +18126,7 @@
],
"title": "InvoicesResourceInvoiceTaxID",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomerTaxId",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoices_resource_line_items_credited_items": {
"description": "",
@@ -17732,11 +18151,7 @@
],
"title": "InvoicesResourceLineItemsCreditedItems",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CreditedItems",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"invoices_resource_line_items_proration_details": {
"description": "",
@@ -17758,11 +18173,7 @@
"type": "object",
"x-expandableFields": [
"credited_items"
- ],
- "x-stripeResource": {
- "class_name": "ProrationDetails",
- "in_package": ""
- }
+ ]
},
"invoices_shipping_cost": {
"description": "",
@@ -17818,11 +18229,7 @@
"x-expandableFields": [
"shipping_rate",
"taxes"
- ],
- "x-stripeResource": {
- "class_name": "ShippingCost",
- "in_package": ""
- }
+ ]
},
"invoices_status_transitions": {
"description": "",
@@ -17860,17 +18267,13 @@
],
"title": "InvoicesStatusTransitions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusTransitions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing.authorization": {
"description": "When an [issued card](https://stripe.com/docs/issuing) is used to make a purchase, an Issuing `Authorization`\nobject is created. [Authorizations](https://stripe.com/docs/issuing/purchases/authorizations) must be approved for the\npurchase to be completed successfully.\n\nRelated guide: [Issued card authorizations](https://stripe.com/docs/issuing/purchases/authorizations)",
"properties": {
"amount": {
- "description": "The total amount that was authorized or rejected. This amount is in the card's currency and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "description": "The total amount that was authorized or rejected. This amount is in `currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `amount` should be the same as `merchant_amount`, unless `currency` and `merchant_currency` are different.",
"type": "integer"
},
"amount_details": {
@@ -17933,7 +18336,7 @@
"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).",
+ "description": "The currency of the cardholder. This currency can be different from the currency presented at authorization and the `merchant_currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"type": "string"
},
"id": {
@@ -17946,11 +18349,11 @@
"type": "boolean"
},
"merchant_amount": {
- "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
+ "description": "The total amount that was authorized or rejected. This amount is in the `merchant_currency` and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal). `merchant_amount` should be the same as `amount`, unless `merchant_currency` and `currency` are different.",
"type": "integer"
},
"merchant_currency": {
- "description": "The currency that was presented to the cardholder for the authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "description": "The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the `currency` field on this authorization. Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"type": "string"
},
"merchant_data": {
@@ -19075,6 +19478,15 @@
"description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
"type": "object"
},
+ "network_data": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/issuing_transaction_network_data"
+ }
+ ],
+ "description": "Details about the transaction, such as processing dates, set by the card network.",
+ "nullable": true
+ },
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
@@ -19156,6 +19568,7 @@
"merchant_currency",
"merchant_data",
"metadata",
+ "network_data",
"object",
"purchase_details",
"type",
@@ -19171,6 +19584,7 @@
"cardholder",
"dispute",
"merchant_data",
+ "network_data",
"purchase_details",
"token",
"treasury"
@@ -19297,11 +19711,36 @@
],
"title": "IssuingAuthorizationAmountDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AmountDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "issuing_authorization_authentication_exemption": {
+ "description": "",
+ "properties": {
+ "claimed_by": {
+ "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.",
+ "enum": [
+ "acquirer",
+ "issuer"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The specific exemption claimed for this authorization.",
+ "enum": [
+ "low_value_transaction",
+ "transaction_risk_analysis"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "claimed_by",
+ "type"
+ ],
+ "title": "IssuingAuthorizationAuthenticationExemption",
+ "type": "object",
+ "x-expandableFields": []
},
"issuing_authorization_merchant_data": {
"description": "",
@@ -19356,6 +19795,12 @@
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "url": {
+ "description": "URL provided by the merchant on a 3DS request",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
@@ -19367,15 +19812,12 @@
"network_id",
"postal_code",
"state",
- "terminal_id"
+ "terminal_id",
+ "url"
],
"title": "IssuingAuthorizationMerchantData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MerchantData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_authorization_network_data": {
"description": "",
@@ -19385,18 +19827,28 @@
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "system_trace_audit_number": {
+ "description": "The System Trace Audit Number (STAN) is a 6-digit identifier assigned by the acquirer. Prefer `network_data.transaction_id` if present, unless you have special requirements.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
- "acquiring_institution_id"
+ "acquiring_institution_id",
+ "system_trace_audit_number",
+ "transaction_id"
],
"title": "IssuingAuthorizationNetworkData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "NetworkData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_authorization_pending_request": {
"description": "",
@@ -19429,6 +19881,11 @@
"merchant_currency": {
"description": "The local currency the merchant is requesting to authorize.",
"type": "string"
+ },
+ "network_risk_score": {
+ "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.",
+ "nullable": true,
+ "type": "integer"
}
},
"required": [
@@ -19437,17 +19894,14 @@
"currency",
"is_amount_controllable",
"merchant_amount",
- "merchant_currency"
+ "merchant_currency",
+ "network_risk_score"
],
"title": "IssuingAuthorizationPendingRequest",
"type": "object",
"x-expandableFields": [
"amount_details"
- ],
- "x-stripeResource": {
- "class_name": "PendingRequest",
- "in_package": ""
- }
+ ]
},
"issuing_authorization_request": {
"description": "",
@@ -19494,6 +19948,11 @@
"maxLength": 5000,
"type": "string"
},
+ "network_risk_score": {
+ "description": "The card network's estimate of the likelihood that an authorization is fraudulent. Takes on values between 1 and 99.",
+ "nullable": true,
+ "type": "integer"
+ },
"reason": {
"description": "When an authorization is approved or declined by you or by Stripe, this field provides additional detail on the reason for the outcome.",
"enum": [
@@ -19516,10 +19975,16 @@
"x-stripeBypassValidation": true
},
"reason_message": {
- "description": "If approve/decline decision is directly responsed to the webhook with json payload and if the response is invalid (e.g., parsing errors), we surface the detailed message via this field.",
+ "description": "If the `request_history.reason` is `webhook_error` because the direct webhook response is invalid (for example, parsing errors or missing parameters), we surface a more detailed error message via this field.",
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "requested_at": {
+ "description": "Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
}
},
"required": [
@@ -19531,18 +19996,38 @@
"currency",
"merchant_amount",
"merchant_currency",
+ "network_risk_score",
"reason",
- "reason_message"
+ "reason_message",
+ "requested_at"
],
"title": "IssuingAuthorizationRequest",
"type": "object",
"x-expandableFields": [
"amount_details"
+ ]
+ },
+ "issuing_authorization_three_d_secure": {
+ "description": "",
+ "properties": {
+ "result": {
+ "description": "The outcome of the 3D Secure authentication request.",
+ "enum": [
+ "attempt_acknowledged",
+ "authenticated",
+ "failed",
+ "required"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "result"
],
- "x-stripeResource": {
- "class_name": "RequestHistory",
- "in_package": ""
- }
+ "title": "IssuingAuthorizationThreeDSecure",
+ "type": "object",
+ "x-expandableFields": []
},
"issuing_authorization_treasury": {
"description": "",
@@ -19577,11 +20062,7 @@
],
"title": "IssuingAuthorizationTreasury",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Treasury",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_authorization_verification_data": {
"description": "",
@@ -19604,6 +20085,15 @@
],
"type": "string"
},
+ "authentication_exemption": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/issuing_authorization_authentication_exemption"
+ }
+ ],
+ "description": "The exemption applied to this authorization.",
+ "nullable": true
+ },
"cvc_check": {
"description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
"enum": [
@@ -19627,22 +20117,32 @@
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "three_d_secure": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/issuing_authorization_three_d_secure"
+ }
+ ],
+ "description": "3D Secure details.",
+ "nullable": true
}
},
"required": [
"address_line1_check",
"address_postal_code_check",
+ "authentication_exemption",
"cvc_check",
"expiry_check",
- "postal_code"
+ "postal_code",
+ "three_d_secure"
],
"title": "IssuingAuthorizationVerificationData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "VerificationData",
- "in_package": ""
- }
+ "x-expandableFields": [
+ "authentication_exemption",
+ "three_d_secure"
+ ]
},
"issuing_card.created": {
"description": "Occurs whenever a card is created.",
@@ -19700,11 +20200,7 @@
],
"title": "IssuingCardApplePay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ApplePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_card_authorization_controls": {
"description": "",
@@ -20343,11 +20839,7 @@
"type": "object",
"x-expandableFields": [
"spending_limits"
- ],
- "x-stripeResource": {
- "class_name": "SpendingControls",
- "in_package": ""
- }
+ ]
},
"issuing_card_google_pay": {
"description": "",
@@ -20373,11 +20865,7 @@
],
"title": "IssuingCardGooglePay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GooglePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_card_shipping": {
"description": "",
@@ -20490,11 +20978,7 @@
"x-expandableFields": [
"address",
"customs"
- ],
- "x-stripeResource": {
- "class_name": "Shipping",
- "in_package": ""
- }
+ ]
},
"issuing_card_shipping_customs": {
"description": "",
@@ -20511,11 +20995,7 @@
],
"title": "IssuingCardShippingCustoms",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Customs",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_card_spending_limit": {
"description": "",
@@ -20849,11 +21329,7 @@
],
"title": "IssuingCardSpendingLimit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SpendingLimit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_card_wallets": {
"description": "",
@@ -20881,11 +21357,7 @@
"x-expandableFields": [
"apple_pay",
"google_pay"
- ],
- "x-stripeResource": {
- "class_name": "Wallets",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder.created": {
"description": "Occurs whenever a cardholder is created.",
@@ -20933,11 +21405,7 @@
"type": "object",
"x-expandableFields": [
"address"
- ],
- "x-stripeResource": {
- "class_name": "Billing",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder_authorization_controls": {
"description": "",
@@ -21576,11 +22044,7 @@
"type": "object",
"x-expandableFields": [
"spending_limits"
- ],
- "x-stripeResource": {
- "class_name": "SpendingControls",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder_card_issuing": {
"description": "",
@@ -21602,11 +22066,7 @@
"type": "object",
"x-expandableFields": [
"user_terms_acceptance"
- ],
- "x-stripeResource": {
- "class_name": "CardIssuing",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder_company": {
"description": "",
@@ -21621,11 +22081,7 @@
],
"title": "IssuingCardholderCompany",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Company",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_cardholder_id_document": {
"description": "",
@@ -21680,11 +22136,7 @@
"x-expandableFields": [
"back",
"front"
- ],
- "x-stripeResource": {
- "class_name": "Document",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder_individual": {
"description": "",
@@ -21730,7 +22182,6 @@
}
},
"required": [
- "card_issuing",
"dob",
"first_name",
"last_name",
@@ -21742,11 +22193,7 @@
"card_issuing",
"dob",
"verification"
- ],
- "x-stripeResource": {
- "class_name": "Individual",
- "in_package": ""
- }
+ ]
},
"issuing_cardholder_individual_dob": {
"description": "",
@@ -21774,11 +22221,7 @@
],
"title": "IssuingCardholderIndividualDOB",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_cardholder_requirements": {
"description": "",
@@ -21821,11 +22264,7 @@
],
"title": "IssuingCardholderRequirements",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Requirements",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_cardholder_spending_limit": {
"description": "",
@@ -22159,11 +22598,7 @@
],
"title": "IssuingCardholderSpendingLimit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SpendingLimit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_cardholder_user_terms_acceptance": {
"description": "",
@@ -22194,11 +22629,7 @@
],
"title": "IssuingCardholderUserTermsAcceptance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "UserTermsAcceptance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_cardholder_verification": {
"description": "",
@@ -22220,11 +22651,7 @@
"type": "object",
"x-expandableFields": [
"document"
- ],
- "x-stripeResource": {
- "class_name": "Verification",
- "in_package": ""
- }
+ ]
},
"issuing_dispute.closed": {
"description": "Occurs whenever a dispute is won, lost or expired.",
@@ -22405,11 +22832,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "Canceled",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_duplicate_evidence": {
"description": "",
@@ -22522,11 +22945,7 @@
"card_statement",
"cash_receipt",
"check_image"
- ],
- "x-stripeResource": {
- "class_name": "Duplicate",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_evidence": {
"description": "",
@@ -22580,11 +22999,7 @@
"not_received",
"other",
"service_not_as_described"
- ],
- "x-stripeResource": {
- "class_name": "Evidence",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_fraudulent_evidence": {
"description": "",
@@ -22624,11 +23039,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "Fraudulent",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_merchandise_not_as_described_evidence": {
"description": "",
@@ -22699,11 +23110,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "MerchandiseNotAsDescribed",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_not_received_evidence": {
"description": "",
@@ -22767,11 +23174,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "NotReceived",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_other_evidence": {
"description": "",
@@ -22828,11 +23231,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "Other",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_service_not_as_described_evidence": {
"description": "",
@@ -22893,11 +23292,7 @@
"type": "object",
"x-expandableFields": [
"additional_documentation"
- ],
- "x-stripeResource": {
- "class_name": "ServiceNotAsDescribed",
- "in_package": ""
- }
+ ]
},
"issuing_dispute_treasury": {
"description": "",
@@ -22920,11 +23315,7 @@
],
"title": "IssuingDisputeTreasury",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Treasury",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_network_token_address": {
"description": "",
@@ -22946,11 +23337,7 @@
],
"title": "IssuingNetworkTokenAddress",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CardholderAddress",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_network_token_device": {
"description": "",
@@ -22992,11 +23379,7 @@
},
"title": "IssuingNetworkTokenDevice",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Device",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_network_token_mastercard": {
"description": "",
@@ -23028,11 +23411,7 @@
],
"title": "IssuingNetworkTokenMastercard",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Mastercard",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_network_token_network_data": {
"description": "",
@@ -23068,11 +23447,7 @@
"mastercard",
"visa",
"wallet_provider"
- ],
- "x-stripeResource": {
- "class_name": "NetworkData",
- "in_package": ""
- }
+ ]
},
"issuing_network_token_visa": {
"description": "",
@@ -23105,11 +23480,7 @@
],
"title": "IssuingNetworkTokenVisa",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Visa",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_network_token_wallet_provider": {
"description": "",
@@ -23206,11 +23577,7 @@
"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.",
@@ -23296,11 +23663,7 @@
],
"title": "IssuingTransactionAmountDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AmountDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_transaction_flight_data": {
"description": "",
@@ -23347,11 +23710,7 @@
"type": "object",
"x-expandableFields": [
"segments"
- ],
- "x-stripeResource": {
- "class_name": "Flight",
- "in_package": ""
- }
+ ]
},
"issuing_transaction_flight_data_leg": {
"description": "",
@@ -23402,11 +23761,7 @@
],
"title": "IssuingTransactionFlightDataLeg",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Segments",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_transaction_fuel_data": {
"description": "",
@@ -23441,11 +23796,7 @@
],
"title": "IssuingTransactionFuelData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fuel",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_transaction_lodging_data": {
"description": "",
@@ -23467,11 +23818,38 @@
],
"title": "IssuingTransactionLodgingData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Lodging",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "issuing_transaction_network_data": {
+ "description": "",
+ "properties": {
+ "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"
+ },
+ "processing_date": {
+ "description": "The date the transaction was processed by the card network. This can be different from the date the seller recorded the transaction depending on when the acquirer submits the transaction to the network.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "authorization_code",
+ "processing_date",
+ "transaction_id"
+ ],
+ "title": "IssuingTransactionNetworkData",
+ "type": "object",
+ "x-expandableFields": []
},
"issuing_transaction_purchase_details": {
"description": "",
@@ -23532,11 +23910,7 @@
"fuel",
"lodging",
"receipt"
- ],
- "x-stripeResource": {
- "class_name": "PurchaseDetails",
- "in_package": ""
- }
+ ]
},
"issuing_transaction_receipt_data": {
"description": "",
@@ -23571,11 +23945,7 @@
],
"title": "IssuingTransactionReceiptData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Receipt",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"issuing_transaction_treasury": {
"description": "",
@@ -23599,11 +23969,7 @@
],
"title": "IssuingTransactionTreasury",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Treasury",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"item": {
"description": "A line item.",
@@ -23839,11 +24205,7 @@
"address_kanji",
"ownership_declaration",
"verification"
- ],
- "x-stripeResource": {
- "class_name": "Company",
- "in_package": ""
- }
+ ]
},
"legal_entity_company_verification": {
"description": "",
@@ -23859,11 +24221,7 @@
"type": "object",
"x-expandableFields": [
"document"
- ],
- "x-stripeResource": {
- "class_name": "Verification",
- "in_package": ""
- }
+ ]
},
"legal_entity_company_verification_document": {
"description": "",
@@ -23932,11 +24290,7 @@
"x-expandableFields": [
"back",
"front"
- ],
- "x-stripeResource": {
- "class_name": "VerificationDocument",
- "in_package": ""
- }
+ ]
},
"legal_entity_dob": {
"description": "",
@@ -23964,11 +24318,7 @@
],
"title": "LegalEntityDOB",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"legal_entity_japan_address": {
"description": "",
@@ -24027,11 +24377,7 @@
],
"title": "LegalEntityJapanAddress",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "JapanAddress",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"legal_entity_person_verification": {
"description": "",
@@ -24074,11 +24420,7 @@
"x-expandableFields": [
"additional_document",
"document"
- ],
- "x-stripeResource": {
- "class_name": "Verification",
- "in_package": ""
- }
+ ]
},
"legal_entity_person_verification_document": {
"description": "",
@@ -24147,11 +24489,7 @@
"x-expandableFields": [
"back",
"front"
- ],
- "x-stripeResource": {
- "class_name": "VerificationDocument",
- "in_package": ""
- }
+ ]
},
"legal_entity_ubo_declaration": {
"description": "",
@@ -24182,11 +24520,7 @@
],
"title": "LegalEntityUBODeclaration",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "OwnershipDeclaration",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"level3": {
"description": "",
@@ -24225,11 +24559,7 @@
"type": "object",
"x-expandableFields": [
"line_items"
- ],
- "x-stripeResource": {
- "class_name": "Level3",
- "in_package": ""
- }
+ ]
},
"level3_line_items": {
"description": "",
@@ -24269,11 +24599,7 @@
],
"title": "Level3LineItems",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LineItem",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"line_item": {
"description": "",
@@ -24534,6 +24860,13 @@
"method_type": "list",
"operation": "get",
"path": "/v1/invoices/{invoice}/lines"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/invoices/{invoice}/lines/{line_item_id}"
}
],
"x-stripeResource": {
@@ -24561,11 +24894,7 @@
"type": "object",
"x-expandableFields": [
"discount"
- ],
- "x-stripeResource": {
- "class_name": "Discount",
- "in_package": ""
- }
+ ]
},
"line_items_tax_amount": {
"description": "",
@@ -24616,11 +24945,7 @@
"type": "object",
"x-expandableFields": [
"rate"
- ],
- "x-stripeResource": {
- "class_name": "Tax",
- "in_package": ""
- }
+ ]
},
"linked_account_options_us_bank_account": {
"description": "",
@@ -24661,11 +24986,7 @@
],
"title": "linked_account_options_us_bank_account",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "FinancialConnections",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"login_link": {
"description": "Login Links are single-use login link for an Express account to access their Stripe dashboard.",
@@ -24899,11 +25220,7 @@
],
"title": "mandate_au_becs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_bacs_debit": {
"description": "",
@@ -24936,11 +25253,7 @@
],
"title": "mandate_bacs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_cashapp": {
"description": "",
@@ -24958,22 +25271,14 @@
"properties": {},
"title": "mandate_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_multi_use": {
"description": "",
"properties": {},
"title": "mandate_multi_use",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MultiUse",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_payment_method_details": {
"description": "",
@@ -25026,11 +25331,7 @@
"paypal",
"sepa_debit",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"mandate_paypal": {
"description": "",
@@ -25049,15 +25350,12 @@
}
},
"required": [
- "billing_agreement_id"
+ "billing_agreement_id",
+ "payer_id"
],
"title": "mandate_paypal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_sepa_debit": {
"description": "",
@@ -25103,11 +25401,7 @@
],
"title": "mandate_single_use",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SingleUse",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"mandate_us_bank_account": {
"description": "",
@@ -25144,11 +25438,7 @@
],
"title": "networks",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Networks",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"notification_event_data": {
"description": "",
@@ -25195,22 +25485,14 @@
],
"title": "NotificationEventRequest",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EventRequest",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"offline_acceptance": {
"description": "",
"properties": {},
"title": "offline_acceptance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Offline",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"online_acceptance": {
"description": "",
@@ -25234,11 +25516,7 @@
],
"title": "online_acceptance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Online",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"outbound_payments_payment_method_details": {
"description": "",
@@ -25271,11 +25549,7 @@
"billing_details",
"financial_account",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "DestinationPaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"outbound_payments_payment_method_details_financial_account": {
"description": "",
@@ -25508,11 +25782,7 @@
],
"title": "PackageDimensions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PackageDimensions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_amount_details": {
"description": "",
@@ -25525,11 +25795,7 @@
"type": "object",
"x-expandableFields": [
"tip"
- ],
- "x-stripeResource": {
- "class_name": "AmountDetails",
- "in_package": ""
- }
+ ]
},
"payment_flows_amount_details_resource_tip": {
"description": "",
@@ -25541,11 +25807,7 @@
},
"title": "PaymentFlowsAmountDetailsResourceTip",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Tip",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_automatic_payment_methods_payment_intent": {
"description": "",
@@ -25568,11 +25830,7 @@
],
"title": "PaymentFlowsAutomaticPaymentMethodsPaymentIntent",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticPaymentMethodsPaymentIntent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_automatic_payment_methods_setup_intent": {
"description": "",
@@ -25596,11 +25854,7 @@
],
"title": "PaymentFlowsAutomaticPaymentMethodsSetupIntent",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticPaymentMethodsSetupIntent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_installment_options": {
"description": "",
@@ -25630,11 +25884,7 @@
"properties": {},
"title": "PaymentFlowsPrivatePaymentMethodsAlipay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Alipay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_alipay_details": {
"description": "",
@@ -25663,11 +25913,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsAlipayDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Alipay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_extended_authorization_extended_authorization": {
"description": "",
@@ -25686,11 +25932,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesExtendedAuthorizationExtendedAuthorization",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ExtendedAuthorizationRequest",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_incremental_authorization_incremental_authorization": {
"description": "",
@@ -25709,11 +25951,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesIncrementalAuthorizationIncrementalAuthorization",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "IncrementalAuthorizationRequest",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_card_details_api_resource_enterprise_features_overcapture_overcapture": {
"description": "",
@@ -25737,11 +25975,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceEnterpriseFeaturesOvercaptureOvercapture",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "OvercaptureRequest",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_card_details_api_resource_multicapture": {
"description": "",
@@ -25760,11 +25994,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsCardDetailsAPIResourceMulticapture",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MulticaptureRequest",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_flows_private_payment_methods_klarna_dob": {
"description": "",
@@ -25792,11 +26022,7 @@
],
"title": "PaymentFlowsPrivatePaymentMethodsKlarnaDOB",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DateOfBirth",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent": {
"description": "A PaymentIntent guides you through the process of collecting a payment from your customer.\nWe recommend that you create exactly one PaymentIntent for each order or\ncustomer session in your system. You can reference the PaymentIntent later to\nsee the history of payment attempts for a particular session.\n\nA PaymentIntent transitions through\n[multiple statuses](https://stripe.com/docs/payments/intents#intent-statuses)\nthroughout its lifetime as it interfaces with Stripe.js to perform\nauthentication flows and ultimately creates at most one successful charge.\n\nRelated guide: [Payment Intents API](https://stripe.com/docs/payments/payment-intents)",
@@ -25886,6 +26112,7 @@
"type": "string"
},
"confirmation_method": {
+ "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.",
"enum": [
"automatic",
"manual"
@@ -26161,7 +26388,7 @@
}
},
"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 card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -26220,12 +26447,14 @@
"id",
"invoice",
"last_payment_error",
+ "latest_charge",
"livemode",
"metadata",
"next_action",
"object",
"on_behalf_of",
"payment_method",
+ "payment_method_configuration_details",
"payment_method_options",
"payment_method_types",
"processing",
@@ -26572,11 +26801,7 @@
"wechat_pay_display_qr_code",
"wechat_pay_redirect_to_android_app",
"wechat_pay_redirect_to_ios_app"
- ],
- "x-stripeResource": {
- "class_name": "NextAction",
- "in_package": ""
- }
+ ]
},
"payment_intent_next_action_alipay_handle_redirect": {
"description": "",
@@ -27213,11 +27438,7 @@
],
"title": "PaymentIntentNextActionVerifyWithMicrodeposits",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "VerifyWithMicrodeposits",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_next_action_wechat_pay_display_qr_code": {
"description": "",
@@ -27426,6 +27647,9 @@
"promptpay": {
"$ref": "#/components/schemas/payment_method_options_promptpay"
},
+ "revolut_pay": {
+ "$ref": "#/components/schemas/payment_method_options_revolut_pay"
+ },
"sepa_debit": {
"$ref": "#/components/schemas/payment_intent_payment_method_options_sepa_debit"
},
@@ -27473,16 +27697,13 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
"wechat_pay",
"zip"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodOptions",
- "in_package": ""
- }
+ ]
},
"payment_intent_payment_method_options_acss_debit": {
"description": "",
@@ -27514,11 +27735,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ ]
},
"payment_intent_payment_method_options_au_becs_debit": {
"description": "",
@@ -27535,22 +27752,14 @@
},
"title": "payment_intent_payment_method_options_au_becs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_payment_method_options_blik": {
"description": "",
"properties": {},
"title": "payment_intent_payment_method_options_blik",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_payment_method_options_card": {
"description": "",
@@ -27631,14 +27840,14 @@
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
- "automatic",
- "challenge_only"
+ "automatic"
],
"nullable": true,
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
},
"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).",
@@ -27671,11 +27880,7 @@
"x-expandableFields": [
"installments",
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"payment_intent_payment_method_options_eps": {
"description": "",
@@ -27690,11 +27895,7 @@
},
"title": "payment_intent_payment_method_options_eps",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Eps",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_payment_method_options_link": {
"description": "",
@@ -27726,11 +27927,7 @@
],
"title": "payment_intent_payment_method_options_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_payment_method_options_mandate_options_acss_debit": {
"description": "",
@@ -27773,11 +27970,7 @@
],
"title": "payment_intent_payment_method_options_mandate_options_acss_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MandateOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_intent_payment_method_options_mandate_options_sepa_debit": {
"description": "",
@@ -27810,11 +28003,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ ]
},
"payment_intent_payment_method_options_us_bank_account": {
"description": "",
@@ -27854,11 +28043,7 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
- ],
- "x-stripeResource": {
- "class_name": "UsBankAccount",
- "in_package": ""
- }
+ ]
},
"payment_intent_processing": {
"description": "",
@@ -27881,11 +28066,7 @@
"type": "object",
"x-expandableFields": [
"card"
- ],
- "x-stripeResource": {
- "class_name": "Processing",
- "in_package": ""
- }
+ ]
},
"payment_intent_processing_customer_notification": {
"description": "",
@@ -27952,11 +28133,7 @@
"type": "object",
"x-expandableFields": [
"installments"
- ],
- "x-stripeResource": {
- "class_name": "PaymentIntentTypeSpecificPaymentMethodOptionsClient",
- "in_package": ""
- }
+ ]
},
"payment_link": {
"description": "A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.\n\nWhen a customer opens a payment link it will open a new [checkout session](https://stripe.com/docs/api/checkout/sessions) to render the payment page. You can use [checkout session events](https://stripe.com/docs/api/events/types#event_types-checkout.session.completed) to track payments through payment links.\n\nRelated guide: [Payment Links API](https://stripe.com/docs/payment-links)",
@@ -28055,6 +28232,12 @@
"maxLength": 5000,
"type": "string"
},
+ "inactive_message": {
+ "description": "The custom message to be displayed to a customer when a payment link is no longer active.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"invoice_creation": {
"anyOf": [
{
@@ -28201,6 +28384,15 @@
"phone_number_collection": {
"$ref": "#/components/schemas/payment_links_resource_phone_number_collection"
},
+ "restrictions": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_restrictions"
+ }
+ ],
+ "description": "Settings that restrict the usage of a payment link.",
+ "nullable": true
+ },
"shipping_address_collection": {
"anyOf": [
{
@@ -28300,6 +28492,7 @@
"on_behalf_of",
"payment_intent_data",
"phone_number_collection",
+ "restrictions",
"shipping_address_collection",
"shipping_options",
"subscription_data",
@@ -28408,11 +28601,7 @@
"x-expandableFields": [
"hosted_confirmation",
"redirect"
- ],
- "x-stripeResource": {
- "class_name": "AfterCompletion",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_automatic_tax": {
"description": "",
@@ -28427,11 +28616,27 @@
],
"title": "PaymentLinksResourceAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_links_resource_completed_sessions": {
+ "description": "",
+ "properties": {
+ "count": {
+ "description": "The current number of checkout sessions that have been completed on the payment link which count towards the `completed_sessions` restriction to be met.",
+ "type": "integer"
+ },
+ "limit": {
+ "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "count",
+ "limit"
+ ],
+ "title": "PaymentLinksResourceCompletedSessions",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_links_resource_completion_behavior_confirmation_page": {
"description": "",
@@ -28448,11 +28653,7 @@
],
"title": "PaymentLinksResourceCompletionBehaviorConfirmationPage",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "HostedConfirmation",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_completion_behavior_redirect": {
"description": "",
@@ -28468,15 +28669,20 @@
],
"title": "PaymentLinksResourceCompletionBehaviorRedirect",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Redirect",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_consent_collection": {
"description": "",
"properties": {
+ "payment_method_reuse_agreement": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_payment_method_reuse_agreement"
+ }
+ ],
+ "description": "Settings related to the payment method reuse text shown in the Checkout UI.",
+ "nullable": true
+ },
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications.",
"enum": [
@@ -28497,16 +28703,15 @@
}
},
"required": [
+ "payment_method_reuse_agreement",
"promotions",
"terms_of_service"
],
"title": "PaymentLinksResourceConsentCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ConsentCollection",
- "in_package": ""
- }
+ "x-expandableFields": [
+ "payment_method_reuse_agreement"
+ ]
},
"payment_links_resource_custom_fields": {
"description": "",
@@ -28555,11 +28760,7 @@
"label",
"numeric",
"text"
- ],
- "x-stripeResource": {
- "class_name": "CustomField",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_custom_fields_dropdown": {
"description": "",
@@ -28579,11 +28780,7 @@
"type": "object",
"x-expandableFields": [
"options"
- ],
- "x-stripeResource": {
- "class_name": "CustomFieldDropdown",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_custom_fields_dropdown_option": {
"description": "",
@@ -28634,11 +28831,7 @@
],
"title": "PaymentLinksResourceCustomFieldsLabel",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomFieldLabel",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_custom_fields_numeric": {
"description": "",
@@ -28660,11 +28853,7 @@
],
"title": "PaymentLinksResourceCustomFieldsNumeric",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomFieldNumeric",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_custom_fields_text": {
"description": "",
@@ -28686,15 +28875,20 @@
],
"title": "PaymentLinksResourceCustomFieldsText",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomFieldText",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_custom_text": {
"description": "",
"properties": {
+ "after_submit": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_links_resource_custom_text_position"
+ }
+ ],
+ "description": "Custom text that should be displayed after the payment confirmation button.",
+ "nullable": true
+ },
"shipping_address": {
"anyOf": [
{
@@ -28724,6 +28918,7 @@
}
},
"required": [
+ "after_submit",
"shipping_address",
"submit",
"terms_of_service_acceptance"
@@ -28731,14 +28926,11 @@
"title": "PaymentLinksResourceCustomText",
"type": "object",
"x-expandableFields": [
+ "after_submit",
"shipping_address",
"submit",
"terms_of_service_acceptance"
- ],
- "x-stripeResource": {
- "class_name": "CustomText",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_custom_text_position": {
"description": "",
@@ -28754,11 +28946,7 @@
],
"title": "PaymentLinksResourceCustomTextPosition",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Position",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_invoice_creation": {
"description": "",
@@ -28785,11 +28973,7 @@
"type": "object",
"x-expandableFields": [
"invoice_data"
- ],
- "x-stripeResource": {
- "class_name": "InvoiceCreation",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_invoice_settings": {
"description": "",
@@ -28876,11 +29060,7 @@
"account_tax_ids",
"custom_fields",
"rendering_options"
- ],
- "x-stripeResource": {
- "class_name": "InvoiceSettings",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_payment_intent_data": {
"description": "",
@@ -28895,6 +29075,12 @@
"nullable": true,
"type": "string"
},
+ "description": {
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"metadata": {
"additionalProperties": {
"maxLength": 500,
@@ -28923,22 +29109,45 @@
"maxLength": 5000,
"nullable": true,
"type": "string"
+ },
+ "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/connect/separate-charges-and-transfers) for details.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
}
},
"required": [
"capture_method",
+ "description",
"metadata",
"setup_future_usage",
"statement_descriptor",
- "statement_descriptor_suffix"
+ "statement_descriptor_suffix",
+ "transfer_group"
],
"title": "PaymentLinksResourcePaymentIntentData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PaymentIntentData",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_links_resource_payment_method_reuse_agreement": {
+ "description": "",
+ "properties": {
+ "position": {
+ "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
+ "enum": [
+ "auto",
+ "hidden"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "title": "PaymentLinksResourcePaymentMethodReuseAgreement",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_links_resource_phone_number_collection": {
"description": "",
@@ -28953,11 +29162,23 @@
],
"title": "PaymentLinksResourcePhoneNumberCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PhoneNumberCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_links_resource_restrictions": {
+ "description": "",
+ "properties": {
+ "completed_sessions": {
+ "$ref": "#/components/schemas/payment_links_resource_completed_sessions"
+ }
+ },
+ "required": [
+ "completed_sessions"
+ ],
+ "title": "PaymentLinksResourceRestrictions",
+ "type": "object",
+ "x-expandableFields": [
+ "completed_sessions"
+ ]
},
"payment_links_resource_shipping_address_collection": {
"description": "",
@@ -29214,11 +29435,7 @@
],
"title": "PaymentLinksResourceShippingAddressCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ShippingAddressCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_shipping_option": {
"description": "",
@@ -29255,17 +29472,13 @@
"type": "object",
"x-expandableFields": [
"shipping_rate"
- ],
- "x-stripeResource": {
- "class_name": "ShippingOption",
- "in_package": ""
- }
+ ]
},
"payment_links_resource_subscription_data": {
"description": "",
"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.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -29282,20 +29495,28 @@
"description": "Integer representing the number of trial period days before the customer is charged for the first time.",
"nullable": true,
"type": "integer"
+ },
+ "trial_settings": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/subscriptions_trials_resource_trial_settings"
+ }
+ ],
+ "description": "Settings related to subscription trials.",
+ "nullable": true
}
},
"required": [
"description",
"metadata",
- "trial_period_days"
+ "trial_period_days",
+ "trial_settings"
],
"title": "PaymentLinksResourceSubscriptionData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SubscriptionData",
- "in_package": ""
- }
+ "x-expandableFields": [
+ "trial_settings"
+ ]
},
"payment_links_resource_tax_id_collection": {
"description": "",
@@ -29310,11 +29531,7 @@
],
"title": "PaymentLinksResourceTaxIdCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TaxIdCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_links_resource_transfer_data": {
"description": "",
@@ -29352,11 +29569,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "in_package": ""
- }
+ ]
},
"payment_method": {
"description": "PaymentMethod objects represent your customer's payment instruments.\nYou can use them with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or save them to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).",
@@ -29501,6 +29714,9 @@
"radar_options": {
"$ref": "#/components/schemas/radar_radar_options"
},
+ "revolut_pay": {
+ "$ref": "#/components/schemas/payment_method_revolut_pay"
+ },
"sepa_debit": {
"$ref": "#/components/schemas/payment_method_sepa_debit"
},
@@ -29538,6 +29754,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -29601,6 +29818,7 @@
"pix",
"promptpay",
"radar_options",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -29765,33 +29983,21 @@
],
"title": "payment_method_acss_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_affirm": {
"description": "",
"properties": {},
"title": "payment_method_affirm",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Affirm",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_afterpay_clearpay": {
"description": "",
"properties": {},
"title": "payment_method_afterpay_clearpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AfterpayClearpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_au_becs_debit": {
"description": "",
@@ -29822,11 +30028,7 @@
],
"title": "payment_method_au_becs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_bacs_debit": {
"description": "",
@@ -29857,33 +30059,21 @@
],
"title": "payment_method_bacs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_bancontact": {
"description": "",
"properties": {},
"title": "payment_method_bancontact",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Bancontact",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_blik": {
"description": "",
"properties": {},
"title": "payment_method_blik",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_boleto": {
"description": "",
@@ -29899,11 +30089,7 @@
],
"title": "payment_method_boleto",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Boleto",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card": {
"description": "",
@@ -30017,11 +30203,7 @@
"networks",
"three_d_secure_usage",
"wallet"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"payment_method_card_checks": {
"description": "",
@@ -30052,11 +30234,7 @@
],
"title": "payment_method_card_checks",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Checks",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_present": {
"description": "",
@@ -30161,11 +30339,7 @@
"type": "object",
"x-expandableFields": [
"networks"
- ],
- "x-stripeResource": {
- "class_name": "CardPresent",
- "in_package": ""
- }
+ ]
},
"payment_method_card_present_networks": {
"description": "",
@@ -30191,11 +30365,7 @@
],
"title": "payment_method_card_present_networks",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Networks",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet": {
"description": "",
@@ -30255,55 +30425,35 @@
"masterpass",
"samsung_pay",
"visa_checkout"
- ],
- "x-stripeResource": {
- "class_name": "Wallet",
- "in_package": ""
- }
+ ]
},
"payment_method_card_wallet_amex_express_checkout": {
"description": "",
"properties": {},
"title": "payment_method_card_wallet_amex_express_checkout",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AmexExpressCheckout",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet_apple_pay": {
"description": "",
"properties": {},
"title": "payment_method_card_wallet_apple_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ApplePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet_google_pay": {
"description": "",
"properties": {},
"title": "payment_method_card_wallet_google_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GooglePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet_link": {
"description": "",
"properties": {},
"title": "payment_method_card_wallet_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet_masterpass": {
"description": "",
@@ -30350,22 +30500,14 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
- ],
- "x-stripeResource": {
- "class_name": "Masterpass",
- "in_package": ""
- }
+ ]
},
"payment_method_card_wallet_samsung_pay": {
"description": "",
"properties": {},
"title": "payment_method_card_wallet_samsung_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SamsungPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_card_wallet_visa_checkout": {
"description": "",
@@ -30412,11 +30554,7 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
- ],
- "x-stripeResource": {
- "class_name": "VisaCheckout",
- "in_package": ""
- }
+ ]
},
"payment_method_cashapp": {
"description": "",
@@ -30440,11 +30578,7 @@
],
"title": "payment_method_cashapp",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Cashapp",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_config_biz_payment_method_configuration_details": {
"description": "",
@@ -30467,11 +30601,7 @@
],
"title": "PaymentMethodConfigBizPaymentMethodConfigurationDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PaymentMethodConfigurationDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_config_resource_display_preference": {
"description": "",
@@ -30506,11 +30636,7 @@
],
"title": "PaymentMethodConfigResourceDisplayPreference",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DisplayPreference",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_config_resource_payment_method_properties": {
"description": "",
@@ -30531,11 +30657,7 @@
"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)",
@@ -30609,9 +30731,6 @@
"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"
},
@@ -30635,17 +30754,11 @@
"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": [
@@ -30665,9 +30778,6 @@
"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"
},
@@ -30677,13 +30787,13 @@
"promptpay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
- "sepa_debit": {
+ "revolut_pay": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
- "sofort": {
+ "sepa_debit": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
- "upi": {
+ "sofort": {
"$ref": "#/components/schemas/payment_method_config_resource_payment_method_properties"
},
"us_bank_account": {
@@ -30724,23 +30834,19 @@
"giropay",
"google_pay",
"grabpay",
- "id_bank_transfer",
"ideal",
"jcb",
"klarna",
"konbini",
"link",
- "multibanco",
- "netbanking",
"oxxo",
"p24",
- "pay_by_bank",
"paynow",
"paypal",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
- "upi",
"us_bank_account",
"wechat_pay"
],
@@ -30786,11 +30892,7 @@
"properties": {},
"title": "payment_method_customer_balance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomerBalance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details": {
"description": "",
@@ -30888,6 +30990,9 @@
"promptpay": {
"$ref": "#/components/schemas/payment_method_details_promptpay"
},
+ "revolut_pay": {
+ "$ref": "#/components/schemas/payment_method_details_revolut_pay"
+ },
"sepa_credit_transfer": {
"$ref": "#/components/schemas/payment_method_details_sepa_credit_transfer"
},
@@ -30955,6 +31060,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_credit_transfer",
"sepa_debit",
"sofort",
@@ -30963,11 +31069,7 @@
"wechat",
"wechat_pay",
"zip"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"payment_method_details_ach_credit_transfer": {
"description": "",
@@ -31005,11 +31107,7 @@
],
"title": "payment_method_details_ach_credit_transfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AchCreditTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_ach_debit": {
"description": "",
@@ -31064,11 +31162,7 @@
],
"title": "payment_method_details_ach_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AchDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_acss_debit": {
"description": "",
@@ -31118,22 +31212,14 @@
],
"title": "payment_method_details_acss_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_affirm": {
"description": "",
"properties": {},
"title": "payment_method_details_affirm",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Affirm",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_afterpay_clearpay": {
"description": "",
@@ -31157,11 +31243,7 @@
],
"title": "payment_method_details_afterpay_clearpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AfterpayClearpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_au_becs_debit": {
"description": "",
@@ -31197,11 +31279,7 @@
],
"title": "payment_method_details_au_becs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AuBecsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_bacs_debit": {
"description": "",
@@ -31239,11 +31317,7 @@
],
"title": "payment_method_details_bacs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_bancontact": {
"description": "",
@@ -31345,22 +31419,14 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
- ],
- "x-stripeResource": {
- "class_name": "Bancontact",
- "in_package": ""
- }
+ ]
},
"payment_method_details_blik": {
"description": "",
"properties": {},
"title": "payment_method_details_blik",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Blik",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_boleto": {
"description": "",
@@ -31376,11 +31442,7 @@
],
"title": "payment_method_details_boleto",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Boleto",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card": {
"description": "",
@@ -31396,6 +31458,11 @@
"nullable": true,
"type": "string"
},
+ "capture_before": {
+ "description": "When using manual capture, a future timestamp at which the charge will be automatically refunded if uncaptured.",
+ "format": "unix-time",
+ "type": "integer"
+ },
"checks": {
"anyOf": [
{
@@ -31522,6 +31589,7 @@
}
},
"required": [
+ "amount_authorized",
"brand",
"checks",
"country",
@@ -31547,11 +31615,7 @@
"overcapture",
"three_d_secure",
"wallet"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"payment_method_details_card_checks": {
"description": "",
@@ -31582,11 +31646,7 @@
],
"title": "payment_method_details_card_checks",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Checks",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_installments": {
"description": "",
@@ -31608,11 +31668,7 @@
"type": "object",
"x-expandableFields": [
"plan"
- ],
- "x-stripeResource": {
- "class_name": "Installments",
- "in_package": ""
- }
+ ]
},
"payment_method_details_card_installments_plan": {
"description": "",
@@ -31645,11 +31701,7 @@
],
"title": "payment_method_details_card_installments_plan",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Plan",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_network_token": {
"description": "",
@@ -31664,11 +31716,7 @@
],
"title": "payment_method_details_card_network_token",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "NetworkToken",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_present": {
"description": "",
@@ -31767,6 +31815,15 @@
"nullable": true,
"type": "string"
},
+ "offline": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_method_details_card_present_offline"
+ }
+ ],
+ "description": "Details about payments collected offline.",
+ "nullable": true
+ },
"overcapture_supported": {
"description": "Defines whether the authorized amount can be over-captured or not",
"type": "boolean"
@@ -31807,6 +31864,7 @@
"incremental_authorization_supported",
"last4",
"network",
+ "offline",
"overcapture_supported",
"read_method",
"receipt"
@@ -31814,10 +31872,28 @@
"title": "payment_method_details_card_present",
"type": "object",
"x-expandableFields": [
+ "offline",
"receipt"
+ ]
+ },
+ "payment_method_details_card_present_offline": {
+ "description": "",
+ "properties": {
+ "stored_at": {
+ "description": "Time at which the payment was collected while offline",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ }
+ },
+ "required": [
+ "stored_at"
],
+ "title": "payment_method_details_card_present_offline",
+ "type": "object",
+ "x-expandableFields": [],
"x-stripeResource": {
- "class_name": "CardPresent",
+ "class_name": "Offline",
"in_package": ""
}
},
@@ -31896,11 +31972,7 @@
],
"title": "payment_method_details_card_present_receipt",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Receipt",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet": {
"description": "",
@@ -31960,55 +32032,35 @@
"masterpass",
"samsung_pay",
"visa_checkout"
- ],
- "x-stripeResource": {
- "class_name": "Wallet",
- "in_package": ""
- }
+ ]
},
"payment_method_details_card_wallet_amex_express_checkout": {
"description": "",
"properties": {},
"title": "payment_method_details_card_wallet_amex_express_checkout",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AmexExpressCheckout",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet_apple_pay": {
"description": "",
"properties": {},
"title": "payment_method_details_card_wallet_apple_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ApplePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet_google_pay": {
"description": "",
"properties": {},
"title": "payment_method_details_card_wallet_google_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GooglePay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet_link": {
"description": "",
"properties": {},
"title": "payment_method_details_card_wallet_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet_masterpass": {
"description": "",
@@ -32055,22 +32107,14 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
- ],
- "x-stripeResource": {
- "class_name": "Masterpass",
- "in_package": ""
- }
+ ]
},
"payment_method_details_card_wallet_samsung_pay": {
"description": "",
"properties": {},
"title": "payment_method_details_card_wallet_samsung_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SamsungPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_card_wallet_visa_checkout": {
"description": "",
@@ -32117,11 +32161,7 @@
"x-expandableFields": [
"billing_address",
"shipping_address"
- ],
- "x-stripeResource": {
- "class_name": "VisaCheckout",
- "in_package": ""
- }
+ ]
},
"payment_method_details_cashapp": {
"description": "",
@@ -32145,22 +32185,14 @@
],
"title": "payment_method_details_cashapp",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Cashapp",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_customer_balance": {
"description": "",
"properties": {},
"title": "payment_method_details_customer_balance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomerBalance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_eps": {
"description": "",
@@ -32213,11 +32245,7 @@
],
"title": "payment_method_details_eps",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Eps",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_fpx": {
"description": "",
@@ -32273,11 +32301,7 @@
],
"title": "payment_method_details_fpx",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fpx",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_giropay": {
"description": "",
@@ -32315,11 +32339,7 @@
],
"title": "payment_method_details_giropay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Giropay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_grabpay": {
"description": "",
@@ -32336,11 +32356,7 @@
],
"title": "payment_method_details_grabpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Grabpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_ideal": {
"description": "",
@@ -32456,11 +32472,7 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
- ],
- "x-stripeResource": {
- "class_name": "Ideal",
- "in_package": ""
- }
+ ]
},
"payment_method_details_interac_present": {
"description": "",
@@ -32596,11 +32608,7 @@
"type": "object",
"x-expandableFields": [
"receipt"
- ],
- "x-stripeResource": {
- "class_name": "InteracPresent",
- "in_package": ""
- }
+ ]
},
"payment_method_details_interac_present_receipt": {
"description": "",
@@ -32704,11 +32712,7 @@
],
"title": "payment_method_details_klarna",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Klarna",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_konbini": {
"description": "",
@@ -32730,11 +32734,7 @@
"type": "object",
"x-expandableFields": [
"store"
- ],
- "x-stripeResource": {
- "class_name": "Konbini",
- "in_package": ""
- }
+ ]
},
"payment_method_details_konbini_store": {
"description": "",
@@ -32756,11 +32756,7 @@
],
"title": "payment_method_details_konbini_store",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Store",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_link": {
"description": "",
@@ -32777,11 +32773,7 @@
],
"title": "payment_method_details_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_multibanco": {
"description": "",
@@ -32805,11 +32797,7 @@
],
"title": "payment_method_details_multibanco",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Multibanco",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_oxxo": {
"description": "",
@@ -32826,11 +32814,7 @@
],
"title": "payment_method_details_oxxo",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Oxxo",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_p24": {
"description": "",
@@ -32887,11 +32871,7 @@
],
"title": "payment_method_details_p24",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "P24",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_paynow": {
"description": "",
@@ -32908,11 +32888,7 @@
],
"title": "payment_method_details_paynow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paynow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_paypal": {
"description": "",
@@ -32951,15 +32927,18 @@
"type": "string"
}
},
+ "required": [
+ "payer_email",
+ "payer_id",
+ "payer_name",
+ "seller_protection",
+ "transaction_id"
+ ],
"title": "payment_method_details_paypal",
"type": "object",
"x-expandableFields": [
"seller_protection"
- ],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ ]
},
"payment_method_details_pix": {
"description": "",
@@ -32973,11 +32952,7 @@
},
"title": "payment_method_details_pix",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Pix",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_promptpay": {
"description": "",
@@ -32994,11 +32969,14 @@
],
"title": "payment_method_details_promptpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Promptpay",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_method_details_revolut_pay": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_details_revolut_pay",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_method_details_sepa_credit_transfer": {
"description": "",
@@ -33029,11 +33007,7 @@
],
"title": "payment_method_details_sepa_credit_transfer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaCreditTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_sepa_debit": {
"description": "",
@@ -33069,7 +33043,7 @@
"type": "string"
},
"mandate": {
- "description": "ID of the mandate used to make this payment.",
+ "description": "Find the ID of the mandate used for this payment under the [payment_method_details.sepa_debit.mandate](https://stripe.com/docs/api/charges/object#charge_object-payment_method_details-sepa_debit-mandate) property on the Charge. Use this mandate ID to [retrieve the Mandate](https://stripe.com/docs/api/mandates/retrieve).",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -33085,11 +33059,7 @@
],
"title": "payment_method_details_sepa_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_sofort": {
"description": "",
@@ -33201,22 +33171,14 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
- ],
- "x-stripeResource": {
- "class_name": "Sofort",
- "in_package": ""
- }
+ ]
},
"payment_method_details_stripe_account": {
"description": "",
"properties": {},
"title": "payment_method_details_stripe_account",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StripeAccount",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_us_bank_account": {
"description": "",
@@ -33274,22 +33236,14 @@
],
"title": "payment_method_details_us_bank_account",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "UsBankAccount",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_wechat": {
"description": "",
"properties": {},
"title": "payment_method_details_wechat",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Wechat",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_wechat_pay": {
"description": "",
@@ -33313,22 +33267,14 @@
],
"title": "payment_method_details_wechat_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "WechatPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_details_zip": {
"description": "",
"properties": {},
"title": "payment_method_details_zip",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Zip",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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).",
@@ -33462,11 +33408,7 @@
"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.",
@@ -33482,11 +33424,7 @@
],
"title": "PaymentMethodDomainResourcePaymentMethodStatusDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PaymentMethodDomainPaymentMethodStatusDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_eps": {
"description": "",
@@ -33532,11 +33470,7 @@
],
"title": "payment_method_eps",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Eps",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_fpx": {
"description": "",
@@ -33585,33 +33519,21 @@
],
"title": "payment_method_fpx",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fpx",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_giropay": {
"description": "",
"properties": {},
"title": "payment_method_giropay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Giropay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_grabpay": {
"description": "",
"properties": {},
"title": "payment_method_grabpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Grabpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_ideal": {
"description": "",
@@ -33668,11 +33590,7 @@
],
"title": "payment_method_ideal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Ideal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_interac_present": {
"description": "",
@@ -33787,11 +33705,7 @@
"type": "object",
"x-expandableFields": [
"networks"
- ],
- "x-stripeResource": {
- "class_name": "InteracPresent",
- "in_package": ""
- }
+ ]
},
"payment_method_klarna": {
"description": "",
@@ -33813,22 +33727,14 @@
"type": "object",
"x-expandableFields": [
"dob"
- ],
- "x-stripeResource": {
- "class_name": "Klarna",
- "in_package": ""
- }
+ ]
},
"payment_method_konbini": {
"description": "",
"properties": {},
"title": "payment_method_konbini",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Konbini",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_link": {
"description": "",
@@ -33850,11 +33756,7 @@
],
"title": "payment_method_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_affirm": {
"description": "",
@@ -33881,11 +33783,7 @@
},
"title": "payment_method_options_affirm",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Affirm",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_afterpay_clearpay": {
"description": "",
@@ -33917,11 +33815,7 @@
],
"title": "payment_method_options_afterpay_clearpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AfterpayClearpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_alipay": {
"description": "",
@@ -33937,11 +33831,7 @@
},
"title": "payment_method_options_alipay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Alipay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_bacs_debit": {
"description": "",
@@ -33958,11 +33848,7 @@
},
"title": "payment_method_options_bacs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_bancontact": {
"description": "",
@@ -33991,11 +33877,7 @@
],
"title": "payment_method_options_bancontact",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Bancontact",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_boleto": {
"description": "",
@@ -34019,11 +33901,7 @@
],
"title": "payment_method_options_boleto",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Boleto",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_card_installments": {
"description": "",
@@ -34060,11 +33938,7 @@
"x-expandableFields": [
"available_plans",
"plan"
- ],
- "x-stripeResource": {
- "class_name": "Installments",
- "in_package": ""
- }
+ ]
},
"payment_method_options_card_mandate_options": {
"description": "",
@@ -34170,11 +34044,7 @@
],
"title": "payment_method_options_card_present",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CardPresent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_cashapp": {
"description": "",
@@ -34198,11 +34068,7 @@
},
"title": "payment_method_options_cashapp",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Cashapp",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_customer_balance": {
"description": "",
@@ -34233,11 +34099,7 @@
"type": "object",
"x-expandableFields": [
"bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "CustomerBalance",
- "in_package": ""
- }
+ ]
},
"payment_method_options_customer_balance_bank_transfer": {
"description": "",
@@ -34283,11 +34145,7 @@
"type": "object",
"x-expandableFields": [
"eu_bank_transfer"
- ],
- "x-stripeResource": {
- "class_name": "BankTransfer",
- "in_package": ""
- }
+ ]
},
"payment_method_options_customer_balance_eu_bank_account": {
"description": "",
@@ -34310,11 +34168,7 @@
],
"title": "payment_method_options_customer_balance_eu_bank_account",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EuBankTransfer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_fpx": {
"description": "",
@@ -34329,11 +34183,7 @@
},
"title": "payment_method_options_fpx",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Fpx",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_giropay": {
"description": "",
@@ -34348,11 +34198,7 @@
},
"title": "payment_method_options_giropay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Giropay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_grabpay": {
"description": "",
@@ -34367,11 +34213,7 @@
},
"title": "payment_method_options_grabpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Grabpay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_ideal": {
"description": "",
@@ -34387,22 +34229,14 @@
},
"title": "payment_method_options_ideal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Ideal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_interac_present": {
"description": "",
"properties": {},
"title": "payment_method_options_interac_present",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InteracPresent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_klarna": {
"description": "",
@@ -34425,7 +34259,8 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
"required": [
@@ -34433,11 +34268,7 @@
],
"title": "payment_method_options_klarna",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Klarna",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_konbini": {
"description": "",
@@ -34481,11 +34312,7 @@
],
"title": "payment_method_options_konbini",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Konbini",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_oxxo": {
"description": "",
@@ -34507,11 +34334,7 @@
],
"title": "payment_method_options_oxxo",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Oxxo",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_p24": {
"description": "",
@@ -34526,11 +34349,7 @@
},
"title": "payment_method_options_p24",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "P24",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_paynow": {
"description": "",
@@ -34545,11 +34364,7 @@
},
"title": "payment_method_options_paynow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paynow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_paypal": {
"description": "",
@@ -34583,15 +34398,12 @@
}
},
"required": [
- "preferred_locale"
+ "preferred_locale",
+ "reference"
],
"title": "payment_method_options_paypal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_pix": {
"description": "",
@@ -34620,11 +34432,7 @@
],
"title": "payment_method_options_pix",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Pix",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_promptpay": {
"description": "",
@@ -34639,11 +34447,14 @@
},
"title": "payment_method_options_promptpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Promptpay",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_method_options_revolut_pay": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_options_revolut_pay",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_method_options_sofort": {
"description": "",
@@ -34676,11 +34487,7 @@
],
"title": "payment_method_options_sofort",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Sofort",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_wechat_pay": {
"description": "",
@@ -34716,11 +34523,7 @@
],
"title": "payment_method_options_wechat_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "WechatPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_options_zip": {
"description": "",
@@ -34735,22 +34538,14 @@
},
"title": "payment_method_options_zip",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Zip",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_oxxo": {
"description": "",
"properties": {},
"title": "payment_method_oxxo",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Oxxo",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_p24": {
"description": "",
@@ -34794,22 +34589,14 @@
],
"title": "payment_method_p24",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "P24",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_paynow": {
"description": "",
"properties": {},
"title": "payment_method_paynow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paynow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_paypal": {
"description": "",
@@ -34827,35 +34614,34 @@
"type": "string"
}
},
+ "required": [
+ "payer_email",
+ "payer_id"
+ ],
"title": "payment_method_paypal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_pix": {
"description": "",
"properties": {},
"title": "payment_method_pix",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Pix",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_promptpay": {
"description": "",
"properties": {},
"title": "payment_method_promptpay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Promptpay",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "payment_method_revolut_pay": {
+ "description": "",
+ "properties": {},
+ "title": "payment_method_revolut_pay",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_method_sepa_debit": {
"description": "",
@@ -34912,11 +34698,7 @@
"type": "object",
"x-expandableFields": [
"generated_from"
- ],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ ]
},
"payment_method_sofort": {
"description": "",
@@ -34933,11 +34715,7 @@
],
"title": "payment_method_sofort",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Sofort",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_us_bank_account": {
"description": "",
@@ -35025,11 +34803,7 @@
"x-expandableFields": [
"networks",
"status_details"
- ],
- "x-stripeResource": {
- "class_name": "USBankAccount",
- "in_package": ""
- }
+ ]
},
"payment_method_us_bank_account_blocked": {
"description": "",
@@ -35073,11 +34847,7 @@
],
"title": "payment_method_us_bank_account_blocked",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusDetailsBlocked",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_us_bank_account_status_details": {
"description": "",
@@ -35090,33 +34860,21 @@
"type": "object",
"x-expandableFields": [
"blocked"
- ],
- "x-stripeResource": {
- "class_name": "StatusDetails",
- "in_package": ""
- }
+ ]
},
"payment_method_wechat_pay": {
"description": "",
"properties": {},
"title": "payment_method_wechat_pay",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "WechatPay",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_method_zip": {
"description": "",
"properties": {},
"title": "payment_method_zip",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Zip",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_after_expiration": {
"description": "",
@@ -35138,11 +34896,7 @@
"type": "object",
"x-expandableFields": [
"recovery"
- ],
- "x-stripeResource": {
- "class_name": "AfterExpiration",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_after_expiration_recovery": {
"description": "",
@@ -35176,11 +34930,7 @@
],
"title": "PaymentPagesCheckoutSessionAfterExpirationRecovery",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Recovery",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_automatic_tax": {
"description": "",
@@ -35206,11 +34956,7 @@
],
"title": "PaymentPagesCheckoutSessionAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_consent": {
"description": "",
@@ -35240,15 +34986,20 @@
],
"title": "PaymentPagesCheckoutSessionConsent",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Consent",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_consent_collection": {
"description": "",
"properties": {
+ "payment_method_reuse_agreement": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_payment_method_reuse_agreement"
+ }
+ ],
+ "description": "If set to `hidden`, it will hide legal text related to the reuse of a payment method.",
+ "nullable": true
+ },
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
"enum": [
@@ -35269,16 +35020,15 @@
}
},
"required": [
+ "payment_method_reuse_agreement",
"promotions",
"terms_of_service"
],
"title": "PaymentPagesCheckoutSessionConsentCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ConsentCollection",
- "in_package": ""
- }
+ "x-expandableFields": [
+ "payment_method_reuse_agreement"
+ ]
},
"payment_pages_checkout_session_currency_conversion": {
"description": "",
@@ -35310,11 +35060,7 @@
],
"title": "PaymentPagesCheckoutSessionCurrencyConversion",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrencyConversion",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_custom_fields": {
"description": "",
@@ -35363,11 +35109,7 @@
"label",
"numeric",
"text"
- ],
- "x-stripeResource": {
- "class_name": "CustomField",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_custom_fields_dropdown": {
"description": "",
@@ -35423,11 +35165,7 @@
],
"title": "PaymentPagesCheckoutSessionCustomFieldsLabel",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomFieldLabel",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_custom_fields_numeric": {
"description": "",
@@ -35515,15 +35253,20 @@
],
"title": "PaymentPagesCheckoutSessionCustomFieldsText",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomFieldText",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_custom_text": {
"description": "",
"properties": {
+ "after_submit": {
+ "anyOf": [
+ {
+ "$ref": "#/components/schemas/payment_pages_checkout_session_custom_text_position"
+ }
+ ],
+ "description": "Custom text that should be displayed after the payment confirmation button.",
+ "nullable": true
+ },
"shipping_address": {
"anyOf": [
{
@@ -35553,6 +35296,7 @@
}
},
"required": [
+ "after_submit",
"shipping_address",
"submit",
"terms_of_service_acceptance"
@@ -35560,14 +35304,11 @@
"title": "PaymentPagesCheckoutSessionCustomText",
"type": "object",
"x-expandableFields": [
+ "after_submit",
"shipping_address",
"submit",
"terms_of_service_acceptance"
- ],
- "x-stripeResource": {
- "class_name": "CustomText",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_custom_text_position": {
"description": "",
@@ -35583,11 +35324,7 @@
],
"title": "PaymentPagesCheckoutSessionCustomTextPosition",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Position",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_customer_details": {
"description": "",
@@ -35651,11 +35388,7 @@
"x-expandableFields": [
"address",
"tax_ids"
- ],
- "x-stripeResource": {
- "class_name": "CustomerDetails",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_invoice_creation": {
"description": "",
@@ -35676,11 +35409,7 @@
"type": "object",
"x-expandableFields": [
"invoice_data"
- ],
- "x-stripeResource": {
- "class_name": "InvoiceCreation",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_invoice_settings": {
"description": "",
@@ -35767,11 +35496,26 @@
"account_tax_ids",
"custom_fields",
"rendering_options"
+ ]
+ },
+ "payment_pages_checkout_session_payment_method_reuse_agreement": {
+ "description": "",
+ "properties": {
+ "position": {
+ "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's defaults will be used.\n\nWhen set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
+ "enum": [
+ "auto",
+ "hidden"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "position"
],
- "x-stripeResource": {
- "class_name": "InvoiceData",
- "in_package": ""
- }
+ "title": "PaymentPagesCheckoutSessionPaymentMethodReuseAgreement",
+ "type": "object",
+ "x-expandableFields": []
},
"payment_pages_checkout_session_phone_number_collection": {
"description": "",
@@ -35786,11 +35530,7 @@
],
"title": "PaymentPagesCheckoutSessionPhoneNumberCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PhoneNumberCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_shipping_address_collection": {
"description": "",
@@ -36107,11 +35847,7 @@
"x-expandableFields": [
"shipping_rate",
"taxes"
- ],
- "x-stripeResource": {
- "class_name": "ShippingCost",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_shipping_option": {
"description": "",
@@ -36148,11 +35884,7 @@
"type": "object",
"x-expandableFields": [
"shipping_rate"
- ],
- "x-stripeResource": {
- "class_name": "ShippingOption",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_tax_id": {
"description": "",
@@ -36243,11 +35975,7 @@
],
"title": "PaymentPagesCheckoutSessionTaxID",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TaxID",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_tax_id_collection": {
"description": "",
@@ -36262,11 +35990,7 @@
],
"title": "PaymentPagesCheckoutSessionTaxIDCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TaxIDCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"payment_pages_checkout_session_total_details": {
"description": "",
@@ -36297,11 +36021,7 @@
"type": "object",
"x-expandableFields": [
"breakdown"
- ],
- "x-stripeResource": {
- "class_name": "TotalDetails",
- "in_package": ""
- }
+ ]
},
"payment_pages_checkout_session_total_details_resource_breakdown": {
"description": "",
@@ -36330,11 +36050,7 @@
"x-expandableFields": [
"discounts",
"taxes"
- ],
- "x-stripeResource": {
- "class_name": "Breakdown",
- "in_package": ""
- }
+ ]
},
"payment_source": {
"anyOf": [
@@ -36833,11 +36549,7 @@
],
"title": "paypal_seller_protection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SellerProtection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"period": {
"description": "",
@@ -36861,11 +36573,7 @@
],
"title": "Period",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Period",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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/handling-api-verification#person-information)",
@@ -37209,11 +36917,7 @@
],
"title": "PersonAdditionalTOSAcceptance",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PersonAdditionalTosAcceptance",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"person_additional_tos_acceptances": {
"description": "",
@@ -37229,11 +36933,7 @@
"type": "object",
"x-expandableFields": [
"account"
- ],
- "x-stripeResource": {
- "class_name": "PersonAdditionalTosAcceptances",
- "in_package": ""
- }
+ ]
},
"person_future_requirements": {
"description": "",
@@ -37299,11 +36999,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "FutureRequirements",
- "in_package": ""
- }
+ ]
},
"person_relationship": {
"description": "",
@@ -37356,11 +37052,7 @@
],
"title": "PersonRelationship",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Relationship",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"person_requirements": {
"description": "",
@@ -37426,11 +37118,7 @@
"x-expandableFields": [
"alternatives",
"errors"
- ],
- "x-stripeResource": {
- "class_name": "Requirements",
- "in_package": ""
- }
+ ]
},
"plan": {
"description": "You can now model subscriptions more flexibly using the [Prices API](https://stripe.com/docs/api#prices). It replaces the Plans API and is backwards compatible to simplify your migration.\n\nPlans define the base price, currency, and billing cycle for recurring purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has plans for $10/month, $100/year, €9/month, and €90/year.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription) and more about [products and prices](https://stripe.com/docs/products-prices/overview).",
@@ -37748,11 +37436,7 @@
],
"title": "PlanTier",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Tier",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"platform_tax_fee": {
"description": "",
@@ -37832,11 +37516,7 @@
],
"title": "PortalBusinessProfile",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BusinessProfile",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_customer_update": {
"description": "",
@@ -37867,11 +37547,7 @@
],
"title": "PortalCustomerUpdate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CustomerUpdate",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_features": {
"description": "",
@@ -37912,11 +37588,7 @@
"subscription_cancel",
"subscription_pause",
"subscription_update"
- ],
- "x-stripeResource": {
- "class_name": "Features",
- "in_package": ""
- }
+ ]
},
"portal_flows_after_completion_hosted_confirmation": {
"description": "",
@@ -37933,11 +37605,7 @@
],
"title": "PortalFlowsAfterCompletionHostedConfirmation",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "HostedConfirmation",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_flows_after_completion_redirect": {
"description": "",
@@ -37953,11 +37621,7 @@
],
"title": "PortalFlowsAfterCompletionRedirect",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Redirect",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_flows_coupon_offer": {
"description": "",
@@ -37973,11 +37637,7 @@
],
"title": "PortalFlowsCouponOffer",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CouponOffer",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_flows_flow": {
"description": "",
@@ -38037,11 +37697,7 @@
"subscription_cancel",
"subscription_update",
"subscription_update_confirm"
- ],
- "x-stripeResource": {
- "class_name": "Flow",
- "in_package": ""
- }
+ ]
},
"portal_flows_flow_after_completion": {
"description": "",
@@ -38084,11 +37740,7 @@
"x-expandableFields": [
"hosted_confirmation",
"redirect"
- ],
- "x-stripeResource": {
- "class_name": "AfterCompletion",
- "in_package": ""
- }
+ ]
},
"portal_flows_flow_subscription_cancel": {
"description": "",
@@ -38116,11 +37768,7 @@
"type": "object",
"x-expandableFields": [
"retention"
- ],
- "x-stripeResource": {
- "class_name": "SubscriptionCancel",
- "in_package": ""
- }
+ ]
},
"portal_flows_flow_subscription_update": {
"description": "",
@@ -38136,11 +37784,7 @@
],
"title": "PortalFlowsFlowSubscriptionUpdate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SubscriptionUpdate",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_flows_flow_subscription_update_confirm": {
"description": "",
@@ -38176,11 +37820,7 @@
"x-expandableFields": [
"discounts",
"items"
- ],
- "x-stripeResource": {
- "class_name": "SubscriptionUpdateConfirm",
- "in_package": ""
- }
+ ]
},
"portal_flows_retention": {
"description": "",
@@ -38210,11 +37850,7 @@
"type": "object",
"x-expandableFields": [
"coupon_offer"
- ],
- "x-stripeResource": {
- "class_name": "Retention",
- "in_package": ""
- }
+ ]
},
"portal_flows_subscription_update_confirm_discount": {
"description": "",
@@ -38238,11 +37874,7 @@
],
"title": "PortalFlowsSubscriptionUpdateConfirmDiscount",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Discount",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_flows_subscription_update_confirm_item": {
"description": "",
@@ -38270,11 +37902,7 @@
],
"title": "PortalFlowsSubscriptionUpdateConfirmItem",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Item",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_invoice_list": {
"description": "",
@@ -38289,11 +37917,7 @@
],
"title": "PortalInvoiceList",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "InvoiceHistory",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_login_page": {
"description": "",
@@ -38315,11 +37939,7 @@
],
"title": "PortalLoginPage",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LoginPage",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_payment_method_update": {
"description": "",
@@ -38334,11 +37954,7 @@
],
"title": "PortalPaymentMethodUpdate",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PaymentMethodUpdate",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_subscription_cancel": {
"description": "",
@@ -38378,11 +37994,7 @@
"type": "object",
"x-expandableFields": [
"cancellation_reason"
- ],
- "x-stripeResource": {
- "class_name": "SubscriptionCancel",
- "in_package": ""
- }
+ ]
},
"portal_subscription_cancellation_reason": {
"description": "",
@@ -38415,11 +38027,7 @@
],
"title": "PortalSubscriptionCancellationReason",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CancellationReason",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_subscription_pause": {
"description": "",
@@ -38434,11 +38042,7 @@
],
"title": "PortalSubscriptionPause",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SubscriptionPause",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"portal_subscription_update": {
"description": "",
@@ -38460,7 +38064,7 @@
"type": "boolean"
},
"products": {
- "description": "The list of products that support subscription updates.",
+ "description": "The list of up to 10 products that support subscription updates.",
"items": {
"$ref": "#/components/schemas/portal_subscription_update_product"
},
@@ -38487,11 +38091,7 @@
"type": "object",
"x-expandableFields": [
"products"
- ],
- "x-stripeResource": {
- "class_name": "SubscriptionUpdate",
- "in_package": ""
- }
+ ]
},
"portal_subscription_update_product": {
"description": "",
@@ -38516,11 +38116,7 @@
],
"title": "PortalSubscriptionUpdateProduct",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Product",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"price": {
"description": "Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products.\n[Products](https://stripe.com/docs/api#products) help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.\n\nFor example, you might have a single \"gold\" product that has prices for $10/month, $100/year, and €9 once.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription), [create an invoice](https://stripe.com/docs/billing/invoices/create), and more about [products and prices](https://stripe.com/docs/products-prices/overview).",
@@ -38851,11 +38447,7 @@
],
"title": "PriceTier",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Tier",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"product": {
"description": "Products describe the specific goods or services you offer to your customers.\nFor example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product.\nThey can be used in conjunction with [Prices](https://stripe.com/docs/api#prices) to configure pricing in Payment Links, Checkout, and Subscriptions.\n\nRelated guides: [Set up a subscription](https://stripe.com/docs/billing/subscriptions/set-up-subscription),\n[share a Payment Link](https://stripe.com/docs/payment-links),\n[accept payments with Checkout](https://stripe.com/docs/payments/accept-a-payment#create-product-prices-upfront),\nand more about [Products and Prices](https://stripe.com/docs/products-prices/overview)",
@@ -39140,16 +38732,9 @@
"type": "string"
}
},
- "required": [
- "name"
- ],
"title": "ProductFeature",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ProductFeature",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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.",
@@ -39345,11 +38930,7 @@
],
"title": "PromotionCodeCurrencyOption",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrencyOption",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"promotion_codes_resource_restrictions": {
"description": "",
@@ -39386,11 +38967,7 @@
"type": "object",
"x-expandableFields": [
"currency_options"
- ],
- "x-stripeResource": {
- "class_name": "Restrictions",
- "in_package": ""
- }
+ ]
},
"quote": {
"description": "A Quote is a way to model prices that you'd like to provide to a customer.\nOnce accepted, it will automatically create an invoice, subscription or subscription schedule.",
@@ -39598,13 +39175,7 @@
}
},
"invoice_settings": {
- "anyOf": [
- {
- "$ref": "#/components/schemas/invoice_setting_quote_setting"
- }
- ],
- "description": "All invoices will be billed using the specified settings.",
- "nullable": true
+ "$ref": "#/components/schemas/invoice_setting_quote_setting"
},
"line_items": {
"description": "A list of items the customer is being quoted for.",
@@ -40004,11 +39575,7 @@
],
"title": "QuotesResourceAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"quotes_resource_computed": {
"description": "",
@@ -40035,11 +39602,7 @@
"x-expandableFields": [
"recurring",
"upfront"
- ],
- "x-stripeResource": {
- "class_name": "Computed",
- "in_package": ""
- }
+ ]
},
"quotes_resource_from_quote": {
"description": "",
@@ -40076,11 +39639,7 @@
"type": "object",
"x-expandableFields": [
"quote"
- ],
- "x-stripeResource": {
- "class_name": "FromQuote",
- "in_package": ""
- }
+ ]
},
"quotes_resource_recurring": {
"description": "",
@@ -40122,11 +39681,7 @@
"type": "object",
"x-expandableFields": [
"total_details"
- ],
- "x-stripeResource": {
- "class_name": "Recurring",
- "in_package": ""
- }
+ ]
},
"quotes_resource_status_transitions": {
"description": "",
@@ -40157,17 +39712,13 @@
],
"title": "QuotesResourceStatusTransitions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusTransitions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"quotes_resource_subscription_data_subscription_data": {
"description": "",
"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.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -40178,6 +39729,15 @@
"nullable": true,
"type": "integer"
},
+ "metadata": {
+ "additionalProperties": {
+ "maxLength": 500,
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "nullable": true,
+ "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,
@@ -40187,15 +39747,12 @@
"required": [
"description",
"effective_date",
+ "metadata",
"trial_period_days"
],
"title": "QuotesResourceSubscriptionDataSubscriptionData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SubscriptionData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"quotes_resource_total_details": {
"description": "",
@@ -40226,11 +39783,7 @@
"type": "object",
"x-expandableFields": [
"breakdown"
- ],
- "x-stripeResource": {
- "class_name": "TotalDetails",
- "in_package": ""
- }
+ ]
},
"quotes_resource_total_details_resource_breakdown": {
"description": "",
@@ -40259,11 +39812,7 @@
"x-expandableFields": [
"discounts",
"taxes"
- ],
- "x-stripeResource": {
- "class_name": "Breakdown",
- "in_package": ""
- }
+ ]
},
"quotes_resource_transfer_data": {
"description": "",
@@ -40307,11 +39856,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "in_package": ""
- }
+ ]
},
"quotes_resource_upfront": {
"description": "",
@@ -40377,11 +39922,7 @@
"x-expandableFields": [
"line_items",
"total_details"
- ],
- "x-stripeResource": {
- "class_name": "Upfront",
- "in_package": ""
- }
+ ]
},
"radar.early_fraud_warning": {
"description": "An early fraud warning indicates that the card issuer has notified us that a\ncharge may be fraudulent.\n\nRelated guide: [Early fraud warnings](https://stripe.com/docs/disputes/measuring#early-fraud-warnings)",
@@ -40789,11 +40330,7 @@
},
"title": "RadarRadarOptions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "RadarOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"radar_review_resource_location": {
"description": "",
@@ -40836,11 +40373,7 @@
],
"title": "RadarReviewResourceLocation",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Location",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"radar_review_resource_session": {
"description": "",
@@ -40878,11 +40411,7 @@
],
"title": "RadarReviewResourceSession",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Session",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"received_payment_method_details_financial_account": {
"description": "",
@@ -40916,7 +40445,7 @@
"description": "",
"properties": {
"aggregate_usage": {
- "description": "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.",
+ "description": "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.",
"enum": [
"last_during_period",
"last_ever",
@@ -40963,11 +40492,7 @@
],
"title": "Recurring",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Recurring",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"refund": {
"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)",
@@ -41030,6 +40555,9 @@
"maxLength": 5000,
"type": "string"
},
+ "destination_details": {
+ "$ref": "#/components/schemas/refund_destination_details"
+ },
"failure_balance_transaction": {
"anyOf": [
{
@@ -41142,7 +40670,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`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).",
+ "description": "Status of the refund. This can be `pending`, `requires_action`, `succeeded`, `failed`, or `canceled`. Learn more about [failed refunds](https://stripe.com/docs/refunds#failed-refunds).",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -41189,6 +40717,7 @@
"x-expandableFields": [
"balance_transaction",
"charge",
+ "destination_details",
"failure_balance_transaction",
"next_action",
"payment_intent",
@@ -41295,6 +40824,190 @@
"type": "refund.updated"
}
},
+ "refund_destination_details": {
+ "description": "",
+ "properties": {
+ "affirm": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "afterpay_clearpay": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "alipay": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "au_bank_transfer": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "blik": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "br_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "card": {
+ "$ref": "#/components/schemas/refund_destination_details_card"
+ },
+ "cashapp": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "customer_cash_balance": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "eps": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "eu_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "gb_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "giropay": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "grabpay": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "jp_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "klarna": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "mx_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "p24": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "paynow": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "paypal": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "pix": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "revolut": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "sofort": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "th_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "type": {
+ "description": "The type of transaction-specific details of the payment method used in the refund (e.g., `card`). An additional hash is included on `destination_details` with a name matching this value. It contains information specific to the refund transaction.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "us_bank_transfer": {
+ "$ref": "#/components/schemas/refund_destination_details_generic"
+ },
+ "wechat_pay": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ },
+ "zip": {
+ "$ref": "#/components/schemas/destination_details_unimplemented"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "refund_destination_details",
+ "type": "object",
+ "x-expandableFields": [
+ "affirm",
+ "afterpay_clearpay",
+ "alipay",
+ "au_bank_transfer",
+ "blik",
+ "br_bank_transfer",
+ "card",
+ "cashapp",
+ "customer_cash_balance",
+ "eps",
+ "eu_bank_transfer",
+ "gb_bank_transfer",
+ "giropay",
+ "grabpay",
+ "jp_bank_transfer",
+ "klarna",
+ "mx_bank_transfer",
+ "p24",
+ "paynow",
+ "paypal",
+ "pix",
+ "revolut",
+ "sofort",
+ "th_bank_transfer",
+ "us_bank_transfer",
+ "wechat_pay",
+ "zip"
+ ]
+ },
+ "refund_destination_details_card": {
+ "description": "",
+ "properties": {
+ "reference": {
+ "description": "Value of the reference number assigned to the refund.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "reference_status": {
+ "description": "Status of the reference number on the refund. This can be `pending`, `available` or `unavailable`.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "reference_type": {
+ "description": "Type of the reference number assigned to the refund.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
+ "description": "The type of refund. This can be `refund`, `reversal`, or `pending`.",
+ "enum": [
+ "pending",
+ "refund",
+ "reversal"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "refund_destination_details_card",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "refund_destination_details_generic": {
+ "description": "",
+ "properties": {
+ "reference": {
+ "description": "The reference assigned to the refund.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "reference_status": {
+ "description": "Status of the reference on the refund. This can be `pending`, `available` or `unavailable`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "reference",
+ "reference_status"
+ ],
+ "title": "refund_destination_details_generic",
+ "type": "object",
+ "x-expandableFields": []
+ },
"refund_next_action": {
"description": "",
"properties": {
@@ -41321,11 +41034,7 @@
"type": "object",
"x-expandableFields": [
"display_details"
- ],
- "x-stripeResource": {
- "class_name": "NextAction",
- "in_package": ""
- }
+ ]
},
"refund_next_action_display_details": {
"description": "",
@@ -41347,11 +41056,7 @@
"type": "object",
"x-expandableFields": [
"email_sent"
- ],
- "x-stripeResource": {
- "class_name": "NextActionDisplayDetails",
- "in_package": ""
- }
+ ]
},
"reporting.report_run": {
"description": "The Report Run object represents an instance of a report type generated with\nspecific run parameters. Once the object is created, Stripe begins processing the report.\nWhen the report has finished running, it will give you a reference to a file\nwhere you can retrieve your results. For an overview, see\n[API Access to Reports](https://stripe.com/docs/reporting/statements/api).\n\nNote that certain report types can only be run based on your live-mode data (not test-mode\ndata), and will error when queried without a [live-mode API key](https://stripe.com/docs/keys#test-live-modes).",
@@ -42001,11 +41706,7 @@
],
"title": "SchedulesPhaseAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"secret_service_resource_scope": {
"description": "",
@@ -42029,11 +41730,7 @@
],
"title": "SecretServiceResourceScope",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Scope",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"sepa_debit_generated_from": {
"description": "",
@@ -42088,11 +41785,7 @@
"x-expandableFields": [
"charge",
"setup_attempt"
- ],
- "x-stripeResource": {
- "class_name": "GeneratedFrom",
- "in_package": ""
- }
+ ]
},
"setup_attempt": {
"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.",
@@ -42379,22 +42072,14 @@
"sepa_debit",
"sofort",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"setup_attempt_payment_method_details_acss_debit": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_acss_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_au_becs_debit": {
"description": "",
@@ -42412,11 +42097,7 @@
"properties": {},
"title": "setup_attempt_payment_method_details_bacs_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_bancontact": {
"description": "",
@@ -42529,11 +42210,7 @@
"properties": {},
"title": "setup_attempt_payment_method_details_boleto",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Boleto",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_card": {
"description": "",
@@ -42547,7 +42224,7 @@
"checks": {
"anyOf": [
{
- "$ref": "#/components/schemas/payment_method_details_card_checks"
+ "$ref": "#/components/schemas/setup_attempt_payment_method_details_card_checks"
}
],
"description": "Check results by Card networks on Card address and CVC at the time of authorization",
@@ -42648,11 +42325,38 @@
"checks",
"three_d_secure",
"wallet"
+ ]
+ },
+ "setup_attempt_payment_method_details_card_checks": {
+ "description": "",
+ "properties": {
+ "address_line1_check": {
+ "description": "If a address line1 was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "address_postal_code_check": {
+ "description": "If a address postal code was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
+ "cvc_check": {
+ "description": "If a CVC was provided, results of the check, one of `pass`, `fail`, `unavailable`, or `unchecked`.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ }
+ },
+ "required": [
+ "address_line1_check",
+ "address_postal_code_check",
+ "cvc_check"
],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ "title": "setup_attempt_payment_method_details_card_checks",
+ "type": "object",
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_card_present": {
"description": "",
@@ -42718,22 +42422,14 @@
"x-expandableFields": [
"apple_pay",
"google_pay"
- ],
- "x-stripeResource": {
- "class_name": "Wallet",
- "in_package": ""
- }
+ ]
},
"setup_attempt_payment_method_details_cashapp": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_cashapp",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Cashapp",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_ideal": {
"description": "",
@@ -42849,55 +42545,35 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
- ],
- "x-stripeResource": {
- "class_name": "Ideal",
- "in_package": ""
- }
+ ]
},
"setup_attempt_payment_method_details_klarna": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_klarna",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Klarna",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_link": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_paypal": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_paypal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_sepa_debit": {
"description": "",
"properties": {},
"title": "setup_attempt_payment_method_details_sepa_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_attempt_payment_method_details_sofort": {
"description": "",
@@ -42999,11 +42675,7 @@
"x-expandableFields": [
"generated_sepa_debit",
"generated_sepa_debit_mandate"
- ],
- "x-stripeResource": {
- "class_name": "Sofort",
- "in_package": ""
- }
+ ]
},
"setup_attempt_payment_method_details_us_bank_account": {
"description": "",
@@ -43323,6 +42995,7 @@
"object",
"on_behalf_of",
"payment_method",
+ "payment_method_configuration_details",
"payment_method_options",
"payment_method_types",
"single_use_mandate",
@@ -43514,11 +43187,7 @@
"cashapp_handle_redirect_or_display_qr_code",
"redirect_to_url",
"verify_with_microdeposits"
- ],
- "x-stripeResource": {
- "class_name": "NextAction",
- "in_package": ""
- }
+ ]
},
"setup_intent_next_action_redirect_to_url": {
"description": "",
@@ -43578,11 +43247,7 @@
],
"title": "SetupIntentNextActionVerifyWithMicrodeposits",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "VerifyWithMicrodeposits",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_intent_payment_method_options": {
"description": "",
@@ -43615,11 +43280,7 @@
"paypal",
"sepa_debit",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodOptions",
- "in_package": ""
- }
+ ]
},
"setup_intent_payment_method_options_acss_debit": {
"description": "",
@@ -43654,11 +43315,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "AcssDebit",
- "in_package": ""
- }
+ ]
},
"setup_intent_payment_method_options_card": {
"description": "",
@@ -43691,14 +43348,14 @@
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
- "automatic",
- "challenge_only"
+ "automatic"
],
"nullable": true,
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
"required": [
@@ -43710,11 +43367,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"setup_intent_payment_method_options_card_mandate_options": {
"description": "",
@@ -43820,11 +43473,7 @@
],
"title": "setup_intent_payment_method_options_link",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Link",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_intent_payment_method_options_mandate_options_acss_debit": {
"description": "",
@@ -43878,11 +43527,7 @@
],
"title": "setup_intent_payment_method_options_mandate_options_acss_debit",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "MandateOptions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_intent_payment_method_options_mandate_options_sepa_debit": {
"description": "",
@@ -43910,11 +43555,7 @@
],
"title": "setup_intent_payment_method_options_paypal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Paypal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"setup_intent_payment_method_options_sepa_debit": {
"description": "",
@@ -43927,11 +43568,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "SepaDebit",
- "in_package": ""
- }
+ ]
},
"setup_intent_payment_method_options_us_bank_account": {
"description": "",
@@ -43954,11 +43591,7 @@
"type": "object",
"x-expandableFields": [
"financial_connections"
- ],
- "x-stripeResource": {
- "class_name": "UsBankAccount",
- "in_package": ""
- }
+ ]
},
"setup_intent_type_specific_payment_method_options_client": {
"description": "",
@@ -43976,11 +43609,7 @@
},
"title": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SetupIntentTypeSpecificPaymentMethodOptionsClient",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"shipping": {
"description": "",
@@ -44194,11 +43823,7 @@
],
"title": "ShippingRateCurrencyOption",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrencyOption",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"shipping_rate_delivery_estimate": {
"description": "",
@@ -44231,11 +43856,7 @@
"x-expandableFields": [
"maximum",
"minimum"
- ],
- "x-stripeResource": {
- "class_name": "DeliveryEstimate",
- "in_package": ""
- }
+ ]
},
"shipping_rate_delivery_estimate_bound": {
"description": "",
@@ -44262,11 +43883,7 @@
],
"title": "ShippingRateDeliveryEstimateBound",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "DeliveryEstimateBound",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"shipping_rate_fixed_amount": {
"description": "",
@@ -44295,11 +43912,7 @@
"type": "object",
"x-expandableFields": [
"currency_options"
- ],
- "x-stripeResource": {
- "class_name": "FixedAmount",
- "in_package": ""
- }
+ ]
},
"sigma.scheduled_query_run.created": {
"description": "Occurs whenever a Sigma scheduled query run finishes.",
@@ -44331,11 +43944,7 @@
],
"title": "SigmaScheduledQueryRunError",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "RunError",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source": {
"description": "`Source` objects allow you to accept a variety of payment methods. They\nrepresent a customer's payment instrument, and can be used with the Stripe API\njust like a `Card` object: once chargeable, they can be charged, or can be\nattached to customers.\n\nStripe doesn't recommend using the deprecated [Sources API](https://stripe.com/docs/api/sources).\nWe recommend that you adopt the [PaymentMethods API](https://stripe.com/docs/api/payment_methods).\nThis newer API provides access to our latest features and payment method types.\n\nRelated guides: [Sources API](https://stripe.com/docs/sources) and [Sources & Customers](https://stripe.com/docs/sources/customers).",
@@ -44727,11 +44336,7 @@
],
"title": "SourceCodeVerificationFlow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CodeVerificationFlow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_mandate_notification": {
"description": "Source mandate notifications should be created when a notification related to\na source mandate must be sent to the payer. They will trigger a webhook or\ndeliver an email to the customer.",
@@ -44825,11 +44430,7 @@
},
"title": "SourceMandateNotificationAcssDebitData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AcssDebitData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_mandate_notification_bacs_debit_data": {
"description": "",
@@ -44842,11 +44443,7 @@
},
"title": "SourceMandateNotificationBacsDebitData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BacsDebitData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_mandate_notification_sepa_debit_data": {
"description": "",
@@ -44869,11 +44466,7 @@
},
"title": "SourceMandateNotificationSepaDebitData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaDebitData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_order": {
"description": "",
@@ -44913,11 +44506,7 @@
"x-expandableFields": [
"items",
"shipping"
- ],
- "x-stripeResource": {
- "class_name": "Order",
- "in_package": ""
- }
+ ]
},
"source_order_item": {
"description": "",
@@ -44965,11 +44554,7 @@
],
"title": "SourceOrderItem",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "OrderItem",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_owner": {
"description": "",
@@ -45044,11 +44629,7 @@
"x-expandableFields": [
"address",
"verified_address"
- ],
- "x-stripeResource": {
- "class_name": "Owner",
- "in_package": ""
- }
+ ]
},
"source_receiver_flow": {
"description": "",
@@ -45092,11 +44673,7 @@
],
"title": "SourceReceiverFlow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ReceiverFlow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_redirect_flow": {
"description": "",
@@ -45131,11 +44708,7 @@
],
"title": "SourceRedirectFlow",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "RedirectFlow",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_transaction": {
"description": "Some payment methods have no required amount that a customer must send.\nCustomers can be instructed to send any amount, and it can be made up of\nmultiple transactions. As such, sources can have multiple associated\ntransactions.",
@@ -45270,11 +44843,7 @@
},
"title": "SourceTransactionAchCreditTransferData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AchCreditTransferData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_transaction_chf_credit_transfer_data": {
"description": "",
@@ -45307,11 +44876,7 @@
},
"title": "SourceTransactionChfCreditTransferData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ChfCreditTransferData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_transaction_gbp_credit_transfer_data": {
"description": "",
@@ -45354,11 +44919,7 @@
},
"title": "SourceTransactionGbpCreditTransferData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "GbpCreditTransferData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_transaction_paper_check_data": {
"description": "",
@@ -45376,11 +44937,7 @@
},
"title": "SourceTransactionPaperCheckData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PaperCheckData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_transaction_sepa_credit_transfer_data": {
"description": "",
@@ -45403,11 +44960,7 @@
},
"title": "SourceTransactionSepaCreditTransferData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SepaCreditTransferData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"source_type_ach_credit_transfer": {
"properties": {
@@ -46389,7 +45942,7 @@
"type": "array"
},
"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.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
"nullable": true,
"type": "string"
@@ -46812,11 +46365,7 @@
],
"title": "SubscriptionAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_billing_thresholds": {
"description": "",
@@ -46838,11 +46387,7 @@
],
"title": "SubscriptionBillingThresholds",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BillingThresholds",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_details_data": {
"description": "",
@@ -46862,11 +46407,7 @@
],
"title": "SubscriptionDetailsData",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "SubscriptionDetailsData",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_item": {
"description": "Subscription items allow you to create customer subscriptions with more than\none plan, making it easy to represent complex billing relationships.",
@@ -47012,11 +46553,7 @@
],
"title": "SubscriptionItemBillingThresholds",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BillingThresholds",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_payment_method_options_card": {
"description": "",
@@ -47060,11 +46597,7 @@
"type": "object",
"x-expandableFields": [
"mandate_options"
- ],
- "x-stripeResource": {
- "class_name": "Card",
- "in_package": ""
- }
+ ]
},
"subscription_pending_invoice_item_interval": {
"description": "",
@@ -47090,11 +46623,7 @@
],
"title": "SubscriptionPendingInvoiceItemInterval",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PendingInvoiceItemInterval",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_schedule": {
"description": "A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.\n\nRelated guide: [Subscription schedules](https://stripe.com/docs/billing/subscriptions/subscription-schedules)",
@@ -47530,11 +47059,7 @@
"x-expandableFields": [
"price",
"tax_rates"
- ],
- "x-stripeResource": {
- "class_name": "AddInvoiceItem",
- "in_package": ""
- }
+ ]
},
"subscription_schedule_configuration_item": {
"description": "A phase item describes the price and quantity of a phase.",
@@ -47633,11 +47158,7 @@
"plan",
"price",
"tax_rates"
- ],
- "x-stripeResource": {
- "class_name": "PhaseItem",
- "in_package": ""
- }
+ ]
},
"subscription_schedule_current_phase": {
"description": "",
@@ -47659,11 +47180,7 @@
],
"title": "SubscriptionScheduleCurrentPhase",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrentPhase",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_schedule_phase_configuration": {
"description": "A phase describes the plans, coupon, and trialing status of a subscription for a predefined time period.",
@@ -47769,7 +47286,7 @@
"type": "array"
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -47887,11 +47404,7 @@
"items",
"on_behalf_of",
"transfer_data"
- ],
- "x-stripeResource": {
- "class_name": "Phase",
- "in_package": ""
- }
+ ]
},
"subscription_schedules_resource_default_settings": {
"description": "",
@@ -47951,7 +47464,7 @@
}
},
"description": {
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 5000,
"nullable": true,
"type": "string"
@@ -48015,11 +47528,7 @@
"invoice_settings",
"on_behalf_of",
"transfer_data"
- ],
- "x-stripeResource": {
- "class_name": "DefaultSettings",
- "in_package": ""
- }
+ ]
},
"subscription_schedules_resource_default_settings_automatic_tax": {
"description": "",
@@ -48034,11 +47543,7 @@
],
"title": "SubscriptionSchedulesResourceDefaultSettingsAutomaticTax",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "AutomaticTax",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscription_transfer_data": {
"description": "",
@@ -48076,11 +47581,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "in_package": ""
- }
+ ]
},
"subscriptions_resource_pause_collection": {
"description": "The Pause Collection settings determine how we will pause collection for this subscription and for how long the subscription\nshould be paused.",
@@ -48107,11 +47608,7 @@
],
"title": "SubscriptionsResourcePauseCollection",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PauseCollection",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscriptions_resource_payment_method_options": {
"description": "",
@@ -48188,11 +47685,7 @@
"customer_balance",
"konbini",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "PaymentMethodOptions",
- "in_package": ""
- }
+ ]
},
"subscriptions_resource_payment_settings": {
"description": "",
@@ -48260,11 +47753,7 @@
"type": "object",
"x-expandableFields": [
"payment_method_options"
- ],
- "x-stripeResource": {
- "class_name": "PaymentSettings",
- "in_package": ""
- }
+ ]
},
"subscriptions_resource_pending_update": {
"description": "Pending Updates store the changes pending from a previous update that will be applied\nto the Subscription upon successful payment.",
@@ -48311,11 +47800,7 @@
"type": "object",
"x-expandableFields": [
"subscription_items"
- ],
- "x-stripeResource": {
- "class_name": "PendingUpdate",
- "in_package": ""
- }
+ ]
},
"subscriptions_trials_resource_end_behavior": {
"description": "Defines how a subscription behaves when a free trial ends.",
@@ -48335,11 +47820,7 @@
],
"title": "SubscriptionsTrialsResourceEndBehavior",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EndBehavior",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"subscriptions_trials_resource_trial_settings": {
"description": "Configures how this subscription behaves during the trial period.",
@@ -48355,11 +47836,7 @@
"type": "object",
"x-expandableFields": [
"end_behavior"
- ],
- "x-stripeResource": {
- "class_name": "TrialSettings",
- "in_package": ""
- }
+ ]
},
"tax.calculation": {
"description": "A Tax Calculation allows you to calculate the tax to collect from your customer.\n\nRelated guide: [Calculate tax in your custom payment flow](https://stripe.com/docs/tax/custom)",
@@ -48612,6 +48089,105 @@
"in_package": "Tax"
}
},
+ "tax.registration": {
+ "description": "A Tax `Registration` lets us know that your business is registered to collect tax on payments within a region, enabling you to [automatically collect tax](https://stripe.com/docs/tax).\n\nStripe doesn't register on your behalf with the relevant authorities when you create a Tax `Registration` object. For more information on how to register to collect tax, see [our guide](https://stripe.com/docs/tax/registering).\n\nRelated guide: [Using the Registrations API](https://stripe.com/docs/tax/registrations-api)",
+ "properties": {
+ "active_from": {
+ "description": "Time at which the registration becomes active. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country_options": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options"
+ },
+ "created": {
+ "description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "expires_at": {
+ "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "nullable": true,
+ "type": "integer"
+ },
+ "id": {
+ "description": "Unique identifier for the object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "livemode": {
+ "description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
+ "type": "boolean"
+ },
+ "object": {
+ "description": "String representing the object's type. Objects of the same type share the same value.",
+ "enum": [
+ "tax.registration"
+ ],
+ "type": "string"
+ },
+ "status": {
+ "description": "The status of the registration. This field is present for convenience and can be deduced from `active_from` and `expires_at`.",
+ "enum": [
+ "active",
+ "expired",
+ "scheduled"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "active_from",
+ "country",
+ "country_options",
+ "created",
+ "expires_at",
+ "id",
+ "livemode",
+ "object",
+ "status"
+ ],
+ "title": "TaxProductRegistrationsResourceTaxRegistration",
+ "type": "object",
+ "x-expandableFields": [
+ "country_options"
+ ],
+ "x-resourceId": "tax.registration",
+ "x-stripeOperations": [
+ {
+ "method_name": "list",
+ "method_on": "service",
+ "method_type": "list",
+ "operation": "get",
+ "path": "/v1/tax/registrations"
+ },
+ {
+ "method_name": "create",
+ "method_on": "service",
+ "method_type": "create",
+ "operation": "post",
+ "path": "/v1/tax/registrations"
+ },
+ {
+ "method_name": "update",
+ "method_on": "service",
+ "method_type": "update",
+ "operation": "post",
+ "path": "/v1/tax/registrations/{id}"
+ }
+ ],
+ "x-stripeResource": {
+ "class_name": "Registration",
+ "has_collection_class": true,
+ "in_package": "Tax"
+ }
+ },
"tax.settings": {
"description": "You can use Tax `Settings` to manage configurations used by Stripe Tax calculations.\n\nRelated guide: [Using the Settings API](https://stripe.com/docs/tax/settings-api)",
"properties": {
@@ -49350,11 +48926,402 @@
],
"title": "tax_id_verification",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Verification",
- "in_package": ""
- }
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options": {
+ "description": "",
+ "properties": {
+ "ae": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "at": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "au": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "be": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "bg": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "ca": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_canada"
+ },
+ "ch": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "cl": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "co": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "cy": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "cz": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "de": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "dk": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "ee": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "es": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "fi": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "fr": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "gb": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "gr": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "hr": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "hu": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "id": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "ie": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "is": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "it": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "jp": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "kr": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "lt": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "lu": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "lv": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "mt": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "mx": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "my": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "nl": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "no": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "nz": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "pl": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "pt": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "ro": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "sa": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "se": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "sg": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ },
+ "si": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "sk": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_europe"
+ },
+ "th": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "tr": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "us": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_united_states"
+ },
+ "vn": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_simplified"
+ },
+ "za": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_default"
+ }
+ },
+ "title": "TaxProductRegistrationsResourceCountryOptions",
+ "type": "object",
+ "x-expandableFields": [
+ "ae",
+ "at",
+ "au",
+ "be",
+ "bg",
+ "ca",
+ "ch",
+ "cl",
+ "co",
+ "cy",
+ "cz",
+ "de",
+ "dk",
+ "ee",
+ "es",
+ "fi",
+ "fr",
+ "gb",
+ "gr",
+ "hr",
+ "hu",
+ "id",
+ "ie",
+ "is",
+ "it",
+ "jp",
+ "kr",
+ "lt",
+ "lu",
+ "lv",
+ "mt",
+ "mx",
+ "my",
+ "nl",
+ "no",
+ "nz",
+ "pl",
+ "pt",
+ "ro",
+ "sa",
+ "se",
+ "sg",
+ "si",
+ "sk",
+ "th",
+ "tr",
+ "us",
+ "vn",
+ "za"
+ ]
+ },
+ "tax_product_registrations_resource_country_options_ca_province_standard": {
+ "description": "",
+ "properties": {
+ "province": {
+ "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "province"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsCaProvinceStandard",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options_canada": {
+ "description": "",
+ "properties": {
+ "province_standard": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_ca_province_standard"
+ },
+ "type": {
+ "description": "Type of registration in Canada.",
+ "enum": [
+ "province_standard",
+ "simplified",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsCanada",
+ "type": "object",
+ "x-expandableFields": [
+ "province_standard"
+ ]
+ },
+ "tax_product_registrations_resource_country_options_default": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "Type of registration in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsDefault",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options_eu_standard": {
+ "description": "",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsEuStandard",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options_europe": {
+ "description": "",
+ "properties": {
+ "standard": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_eu_standard"
+ },
+ "type": {
+ "description": "Type of registration in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsEurope",
+ "type": "object",
+ "x-expandableFields": [
+ "standard"
+ ]
+ },
+ "tax_product_registrations_resource_country_options_simplified": {
+ "description": "",
+ "properties": {
+ "type": {
+ "description": "Type of registration in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsSimplified",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options_united_states": {
+ "description": "",
+ "properties": {
+ "local_amusement_tax": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_amusement_tax"
+ },
+ "local_lease_tax": {
+ "$ref": "#/components/schemas/tax_product_registrations_resource_country_options_us_local_lease_tax"
+ },
+ "state": {
+ "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of registration in the US.",
+ "enum": [
+ "local_amusement_tax",
+ "local_lease_tax",
+ "state_communications_tax",
+ "state_sales_tax"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "state",
+ "type"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsUnitedStates",
+ "type": "object",
+ "x-expandableFields": [
+ "local_amusement_tax",
+ "local_lease_tax"
+ ]
+ },
+ "tax_product_registrations_resource_country_options_us_local_amusement_tax": {
+ "description": "",
+ "properties": {
+ "jurisdiction": {
+ "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "jurisdiction"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalAmusementTax",
+ "type": "object",
+ "x-expandableFields": []
+ },
+ "tax_product_registrations_resource_country_options_us_local_lease_tax": {
+ "description": "",
+ "properties": {
+ "jurisdiction": {
+ "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "jurisdiction"
+ ],
+ "title": "TaxProductRegistrationsResourceCountryOptionsUsLocalLeaseTax",
+ "type": "object",
+ "x-expandableFields": []
},
"tax_product_resource_customer_details": {
"description": "",
@@ -49412,11 +49379,7 @@
"x-expandableFields": [
"address",
"tax_ids"
- ],
- "x-stripeResource": {
- "class_name": "CustomerDetails",
- "in_package": ""
- }
+ ]
},
"tax_product_resource_customer_details_resource_tax_id": {
"description": "",
@@ -49506,11 +49469,7 @@
],
"title": "TaxProductResourceCustomerDetailsResourceTaxId",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TaxID",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_jurisdiction": {
"description": "",
@@ -49551,11 +49510,7 @@
],
"title": "TaxProductResourceJurisdiction",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Jurisdiction",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_line_item_tax_breakdown": {
"description": "",
@@ -49623,11 +49578,7 @@
"x-expandableFields": [
"jurisdiction",
"tax_rate_details"
- ],
- "x-stripeResource": {
- "class_name": "LineItemTaxBreakdown",
- "in_package": ""
- }
+ ]
},
"tax_product_resource_line_item_tax_rate_details": {
"description": "",
@@ -49668,11 +49619,7 @@
],
"title": "TaxProductResourceLineItemTaxRateDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LineItemTaxRateDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_postal_address": {
"description": "",
@@ -49723,11 +49670,7 @@
],
"title": "TaxProductResourcePostalAddress",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PostalAddress",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_breakdown": {
"description": "",
@@ -49780,11 +49723,7 @@
"type": "object",
"x-expandableFields": [
"tax_rate_details"
- ],
- "x-stripeResource": {
- "class_name": "TaxBreakdown",
- "in_package": ""
- }
+ ]
},
"tax_product_resource_tax_calculation_shipping_cost": {
"description": "",
@@ -49833,11 +49772,7 @@
"type": "object",
"x-expandableFields": [
"tax_breakdown"
- ],
- "x-stripeResource": {
- "class_name": "CalculationShippingCost",
- "in_package": "Tax"
- }
+ ]
},
"tax_product_resource_tax_rate_details": {
"description": "",
@@ -49887,11 +49822,7 @@
],
"title": "TaxProductResourceTaxRateDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TaxRateDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_settings_defaults": {
"description": "",
@@ -49919,11 +49850,7 @@
],
"title": "TaxProductResourceTaxSettingsDefaults",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Defaults",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_settings_head_office": {
"description": "",
@@ -49939,11 +49866,7 @@
"type": "object",
"x-expandableFields": [
"address"
- ],
- "x-stripeResource": {
- "class_name": "HeadOffice",
- "in_package": ""
- }
+ ]
},
"tax_product_resource_tax_settings_status_details": {
"description": "",
@@ -49960,22 +49883,14 @@
"x-expandableFields": [
"active",
"pending"
- ],
- "x-stripeResource": {
- "class_name": "StatusDetails",
- "in_package": ""
- }
+ ]
},
"tax_product_resource_tax_settings_status_details_resource_active": {
"description": "",
"properties": {},
"title": "TaxProductResourceTaxSettingsStatusDetailsResourceActive",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Active",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_settings_status_details_resource_pending": {
"description": "",
@@ -49995,11 +49910,7 @@
],
"title": "TaxProductResourceTaxSettingsStatusDetailsResourcePending",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Pending",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_transaction_line_item_resource_reversal": {
"description": "",
@@ -50015,11 +49926,7 @@
],
"title": "TaxProductResourceTaxTransactionLineItemResourceReversal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Reversal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_transaction_resource_reversal": {
"description": "",
@@ -50036,11 +49943,7 @@
],
"title": "TaxProductResourceTaxTransactionResourceReversal",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Reversal",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"tax_product_resource_tax_transaction_shipping_cost": {
"description": "",
@@ -50089,11 +49992,7 @@
"type": "object",
"x-expandableFields": [
"tax_breakdown"
- ],
- "x-stripeResource": {
- "class_name": "TransactionShippingCost",
- "in_package": "Tax"
- }
+ ]
},
"tax_rate": {
"description": "Tax rates can be applied to [invoices](https://stripe.com/docs/billing/invoices/tax-rates), [subscriptions](https://stripe.com/docs/billing/subscriptions/taxes) and [Checkout Sessions](https://stripe.com/docs/payments/checkout/set-up-a-subscription#tax-rates) to collect tax.\n\nRelated guide: [Tax rates](https://stripe.com/docs/billing/taxes/tax-rates)",
@@ -50781,11 +50680,7 @@
},
"title": "TerminalConfigurationConfigurationResourceCurrencySpecificConfig",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "CurrencySpecificConfig",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"terminal_configuration_configuration_resource_device_type_specific_config": {
"description": "",
@@ -50814,11 +50709,7 @@
"type": "object",
"x-expandableFields": [
"splashscreen"
- ],
- "x-stripeResource": {
- "class_name": "DeviceTypeSpecificConfig",
- "in_package": ""
- }
+ ]
},
"terminal_configuration_configuration_resource_offline_config": {
"description": "",
@@ -50834,11 +50725,7 @@
],
"title": "TerminalConfigurationConfigurationResourceOfflineConfig",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "OfflineConfig",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"terminal_configuration_configuration_resource_tipping": {
"description": "",
@@ -50903,11 +50790,7 @@
"sek",
"sgd",
"usd"
- ],
- "x-stripeResource": {
- "class_name": "Tipping",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_cart": {
"description": "Represents a cart to be displayed on the reader",
@@ -50943,11 +50826,7 @@
"type": "object",
"x-expandableFields": [
"line_items"
- ],
- "x-stripeResource": {
- "class_name": "Cart",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_line_item": {
"description": "Represents a line item to be displayed on the reader",
@@ -50973,11 +50852,7 @@
],
"title": "TerminalReaderReaderResourceLineItem",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LineItem",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"terminal_reader_reader_resource_process_config": {
"description": "Represents a per-transaction override of a reader configuration",
@@ -50994,11 +50869,7 @@
"type": "object",
"x-expandableFields": [
"tipping"
- ],
- "x-stripeResource": {
- "class_name": "ProcessConfig",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_process_payment_intent_action": {
"description": "Represents a reader action to process a payment intent",
@@ -51034,22 +50905,14 @@
"x-expandableFields": [
"payment_intent",
"process_config"
- ],
- "x-stripeResource": {
- "class_name": "ProcessPaymentIntentAction",
- "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": ""
- }
+ "x-expandableFields": []
},
"terminal_reader_reader_resource_process_setup_intent_action": {
"description": "Represents a reader action to process a setup intent",
@@ -51090,11 +50953,7 @@
"x-expandableFields": [
"process_config",
"setup_intent"
- ],
- "x-stripeResource": {
- "class_name": "ProcessSetupIntentAction",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_reader_action": {
"description": "Represents an action performed by the reader",
@@ -51157,11 +51016,7 @@
"process_setup_intent",
"refund_payment",
"set_reader_display"
- ],
- "x-stripeResource": {
- "class_name": "ReaderAction",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_refund_payment_action": {
"description": "Represents a reader action to refund a payment",
@@ -51259,11 +51114,7 @@
"charge",
"payment_intent",
"refund"
- ],
- "x-stripeResource": {
- "class_name": "RefundPaymentAction",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_set_reader_display_action": {
"description": "Represents a reader action to set the reader display",
@@ -51293,11 +51144,7 @@
"type": "object",
"x-expandableFields": [
"cart"
- ],
- "x-stripeResource": {
- "class_name": "SetReaderDisplayAction",
- "in_package": ""
- }
+ ]
},
"terminal_reader_reader_resource_tipping_config": {
"description": "Represents a per-transaction tipping configuration",
@@ -51309,11 +51156,7 @@
},
"title": "TerminalReaderReaderResourceTippingConfig",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TippingConfig",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"test_helpers.test_clock": {
"description": "A test clock enables deterministic control over objects in testmode. With a test clock, you can create\nobjects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances,\nyou can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.",
@@ -51514,6 +51357,19 @@
"nullable": true,
"type": "string"
},
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
"result": {
"description": "Indicates the outcome of 3D Secure authentication.",
"enum": [
@@ -51541,6 +51397,12 @@
"nullable": true,
"type": "string"
},
+ "transaction_id": {
+ "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"version": {
"description": "The version of 3D Secure that was used.",
"enum": [
@@ -51555,17 +51417,15 @@
},
"required": [
"authentication_flow",
+ "electronic_commerce_indicator",
"result",
"result_reason",
+ "transaction_id",
"version"
],
"title": "three_d_secure_details",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ThreeDSecure",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"three_d_secure_details_charge": {
"description": "",
@@ -51579,6 +51439,32 @@
"nullable": true,
"type": "string"
},
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI). A protocol-level field\nindicating what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "nullable": true,
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "exemption_indicator": {
+ "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
+ "enum": [
+ "low_risk",
+ "none"
+ ],
+ "nullable": true,
+ "type": "string"
+ },
+ "exemption_indicator_applied": {
+ "description": "Whether Stripe requested the value of `exemption_indicator` in the transaction. This will depend on\nthe outcome of Stripe's internal risk assessment.",
+ "type": "boolean"
+ },
"result": {
"description": "Indicates the outcome of 3D Secure authentication.",
"enum": [
@@ -51606,6 +51492,12 @@
"nullable": true,
"type": "string"
},
+ "transaction_id": {
+ "description": "The 3D Secure 1 XID or 3D Secure 2 Directory Server Transaction ID\n(dsTransId) for this payment.",
+ "maxLength": 5000,
+ "nullable": true,
+ "type": "string"
+ },
"version": {
"description": "The version of 3D Secure that was used.",
"enum": [
@@ -51620,17 +51512,16 @@
},
"required": [
"authentication_flow",
+ "electronic_commerce_indicator",
+ "exemption_indicator",
"result",
"result_reason",
+ "transaction_id",
"version"
],
"title": "three_d_secure_details_charge",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ThreeDSecure",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"three_d_secure_usage": {
"description": "",
@@ -51645,11 +51536,7 @@
],
"title": "three_d_secure_usage",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ThreeDSecureUsage",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"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. 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.",
@@ -51824,7 +51711,7 @@
"$ref": "#/components/schemas/source"
}
],
- "description": "For most Stripe users, the source of every top-up is a bank account. This hash is then the [source object](https://stripe.com/docs/api#source_object) describing that bank account.",
+ "description": "The source field is deprecated. It might not always be present in the API response.",
"nullable": true
},
"statement_descriptor": {
@@ -52334,11 +52221,7 @@
"type": "object",
"x-expandableFields": [
"destination"
- ],
- "x-stripeResource": {
- "class_name": "TransferData",
- "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)",
@@ -52566,11 +52449,7 @@
],
"title": "TransferSchedule",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "PayoutSchedule",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"transform_quantity": {
"description": "",
@@ -52594,11 +52473,7 @@
],
"title": "TransformQuantity",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TransformQuantity",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"transform_usage": {
"description": "",
@@ -52622,11 +52497,7 @@
],
"title": "TransformUsage",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "TransformUsage",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury.credit_reversal": {
"description": "You can reverse some [ReceivedCredits](https://stripe.com/docs/api#received_credits) depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.",
@@ -55218,11 +55089,7 @@
"type": "object",
"x-expandableFields": [
"aba"
- ],
- "x-stripeResource": {
- "class_name": "FinancialAddress",
- "in_package": ""
- }
+ ]
},
"treasury_financial_accounts_resource_financial_addresses_features": {
"description": "Settings related to Financial Addresses features on a Financial Account",
@@ -55478,11 +55345,7 @@
],
"title": "TreasuryInboundTransfersResourceFailureDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "FailureDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_linked_flows": {
"description": "",
@@ -55499,11 +55362,7 @@
],
"title": "TreasuryInboundTransfersResourceInboundTransferResourceLinkedFlows",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LinkedFlows",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_inbound_transfers_resource_inbound_transfer_resource_status_transitions": {
"description": "",
@@ -55559,11 +55418,7 @@
],
"title": "TreasuryOutboundPaymentsResourceOutboundPaymentResourceEndUserDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "EndUserDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_outbound_payments_resource_outbound_payment_resource_status_transitions": {
"description": "",
@@ -55654,11 +55509,7 @@
"type": "object",
"x-expandableFields": [
"transaction"
- ],
- "x-stripeResource": {
- "class_name": "ReturnedDetails",
- "in_package": ""
- }
+ ]
},
"treasury_outbound_transfers_resource_returned_details": {
"description": "",
@@ -55810,11 +55661,7 @@
"type": "object",
"x-expandableFields": [
"source_flow_details"
- ],
- "x-stripeResource": {
- "class_name": "LinkedFlows",
- "in_package": ""
- }
+ ]
},
"treasury_received_credits_resource_reversal_details": {
"description": "",
@@ -55844,11 +55691,7 @@
],
"title": "TreasuryReceivedCreditsResourceReversalDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ReversalDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_received_credits_resource_source_flows_details": {
"description": "",
@@ -55883,11 +55726,7 @@
"credit_reversal",
"outbound_payment",
"payout"
- ],
- "x-stripeResource": {
- "class_name": "SourceFlowDetails",
- "in_package": ""
- }
+ ]
},
"treasury_received_credits_resource_status_transitions": {
"description": "",
@@ -55904,11 +55743,7 @@
],
"title": "TreasuryReceivedCreditsResourceStatusTransitions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusTransitions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_received_debits_resource_debit_reversal_linked_flows": {
"description": "",
@@ -55925,11 +55760,7 @@
],
"title": "TreasuryReceivedDebitsResourceDebitReversalLinkedFlows",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LinkedFlows",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_received_debits_resource_linked_flows": {
"description": "",
@@ -55967,11 +55798,7 @@
],
"title": "TreasuryReceivedDebitsResourceLinkedFlows",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "LinkedFlows",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_received_debits_resource_reversal_details": {
"description": "",
@@ -56001,11 +55828,7 @@
],
"title": "TreasuryReceivedDebitsResourceReversalDetails",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "ReversalDetails",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_received_debits_resource_status_transitions": {
"description": "",
@@ -56022,11 +55845,7 @@
],
"title": "TreasuryReceivedDebitsResourceStatusTransitions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusTransitions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_shared_resource_billing_details": {
"description": "",
@@ -56109,11 +55928,7 @@
"billing_details",
"financial_account",
"us_bank_account"
- ],
- "x-stripeResource": {
- "class_name": "InitiatingPaymentMethodDetails",
- "in_package": ""
- }
+ ]
},
"treasury_shared_resource_initiating_payment_method_details_us_bank_account": {
"description": "",
@@ -56172,11 +55987,7 @@
],
"title": "TreasuryTransactionsResourceAbstractTransactionResourceStatusTransitions",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "StatusTransitions",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_transactions_resource_balance_impact": {
"description": "Change to a FinancialAccount's balance",
@@ -56201,11 +56012,7 @@
],
"title": "TreasuryTransactionsResourceBalanceImpact",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "BalanceImpact",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"treasury_transactions_resource_flow_details": {
"description": "",
@@ -56264,11 +56071,7 @@
"outbound_transfer",
"received_credit",
"received_debit"
- ],
- "x-stripeResource": {
- "class_name": "FlowDetails",
- "in_package": "Treasury"
- }
+ ]
},
"us_bank_account_networks": {
"description": "",
@@ -56297,11 +56100,7 @@
],
"title": "us_bank_account_networks",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Networks",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"usage_record": {
"description": "Usage records allow you to report customer usage and metrics to Stripe for\nmetered billing of subscription prices.\n\nRelated guide: [Metered billing](https://stripe.com/docs/billing/subscriptions/metered-billing)",
@@ -56448,11 +56247,7 @@
],
"title": "verification_session_redaction",
"type": "object",
- "x-expandableFields": [],
- "x-stripeResource": {
- "class_name": "Redaction",
- "in_package": ""
- }
+ "x-expandableFields": []
},
"webhook_endpoint": {
"description": "You can configure [webhook endpoints](https://stripe.com/docs/webhooks/) via the API to be\nnotified about events that happen in your Stripe account or connected\naccounts.\n\nMost users configure webhooks from [the dashboard](https://dashboard.stripe.com/webhooks), which provides a user interface for registering and testing your webhook endpoints.\n\nRelated guide: [Setting up webhooks](https://stripe.com/docs/webhooks/configure)",
@@ -56797,6 +56592,12 @@
"enabled": {
"description": "Whether the embedded component is enabled.",
"type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {},
+ "title": "base_features_param",
+ "type": "object"
}
},
"required": [
@@ -56804,6 +56605,105 @@
],
"title": "base_config_param",
"type": "object"
+ },
+ "payment_details": {
+ "description": "Configuration for the payment details embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {
+ "capture_payments": {
+ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
+ "type": "boolean"
+ },
+ "dispute_management": {
+ "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
+ "type": "boolean"
+ },
+ "refund_management": {
+ "description": "Whether to allow sending refunds. This is `true` by default.",
+ "type": "boolean"
+ }
+ },
+ "title": "payments_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "payments_config_param",
+ "type": "object"
+ },
+ "payments": {
+ "description": "Configuration for the payments embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {
+ "capture_payments": {
+ "description": "Whether to allow capturing and cancelling payment intents. This is `true` by default.",
+ "type": "boolean"
+ },
+ "dispute_management": {
+ "description": "Whether to allow responding to disputes, including submitting evidence and accepting disputes. This is `true` by default.",
+ "type": "boolean"
+ },
+ "refund_management": {
+ "description": "Whether to allow sending refunds. This is `true` by default.",
+ "type": "boolean"
+ }
+ },
+ "title": "payments_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "payments_config_param",
+ "type": "object"
+ },
+ "payouts": {
+ "description": "Configuration for the payouts embedded component.",
+ "properties": {
+ "enabled": {
+ "description": "Whether the embedded component is enabled.",
+ "type": "boolean"
+ },
+ "features": {
+ "description": "The list of features enabled in the embedded component.",
+ "properties": {
+ "edit_payout_schedule": {
+ "description": "Whether to allow payout schedule to be changed. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ },
+ "instant_payouts": {
+ "description": "Whether to allow creation of instant payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ },
+ "standard_payouts": {
+ "description": "Whether to allow creation of standard payouts. Default `true` when Stripe owns Loss Liability, default `false` otherwise.",
+ "type": "boolean"
+ }
+ },
+ "title": "payouts_features_param",
+ "type": "object"
+ }
+ },
+ "required": [
+ "enabled"
+ ],
+ "title": "payouts_config_param",
+ "type": "object"
}
},
"title": "account_session_create_components_param",
@@ -57490,6 +57390,17 @@
"title": "capability_param",
"type": "object"
},
+ "revolut_pay_payments": {
+ "description": "The revolut_pay_payments capability.",
+ "properties": {
+ "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.",
+ "type": "boolean"
+ }
+ },
+ "title": "capability_param",
+ "type": "object"
+ },
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
"properties": {
@@ -58351,6 +58262,17 @@
"settings": {
"description": "Options for customizing how the account functions within Stripe.",
"properties": {
+ "bacs_debit_payments": {
+ "description": "Settings specific to Bacs Direct Debit.",
+ "properties": {
+ "display_name": {
+ "description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
+ "type": "string"
+ }
+ },
+ "title": "bacs_debit_payments_specs",
+ "type": "object"
+ },
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
"properties": {
@@ -59280,6 +59202,17 @@
"title": "capability_param",
"type": "object"
},
+ "revolut_pay_payments": {
+ "description": "The revolut_pay_payments capability.",
+ "properties": {
+ "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.",
+ "type": "boolean"
+ }
+ },
+ "title": "capability_param",
+ "type": "object"
+ },
"sepa_debit_payments": {
"description": "The sepa_debit_payments capability.",
"properties": {
@@ -60136,6 +60069,17 @@
"settings": {
"description": "Options for customizing how the account functions within Stripe.",
"properties": {
+ "bacs_debit_payments": {
+ "description": "Settings specific to Bacs Direct Debit payments.",
+ "properties": {
+ "display_name": {
+ "description": "The Bacs Direct Debit Display Name for this account. For payments made with Bacs Direct Debit, this name appears on the mandate as the statement descriptor. Mobile banking apps display it as the name of the business. To use custom branding, set the Bacs Direct Debit Display Name during or right after creation. Custom branding incurs an additional monthly fee for the platform. If you don't set the display name before requesting Bacs capability, it's automatically set as \"Stripe\" and the account is onboarded to Stripe branding, which is free.",
+ "type": "string"
+ }
+ },
+ "title": "bacs_debit_payments_specs",
+ "type": "object"
+ },
"branding": {
"description": "Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.",
"properties": {
@@ -64548,7 +64492,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`, `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`.",
+ "description": "Only returns transactions of the given type. One of: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_inbound`, `obligation_outbound`, `obligation_reversal_inbound`, `obligation_reversal_outbound`, `obligation_payout`, `obligation_payout_failure`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`.",
"in": "query",
"name": "type",
"required": false,
@@ -65150,7 +65094,7 @@
"type": "string"
}
],
- "description": "The list of products that support subscription updates."
+ "description": "The list of up to 10 products that support subscription updates."
},
"proration_behavior": {
"description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.",
@@ -65631,7 +65575,7 @@
"type": "string"
}
],
- "description": "The list of products that support subscription updates."
+ "description": "The list of up to 10 products that support subscription updates."
},
"proration_behavior": {
"description": "Determines how to handle prorations resulting from subscription updates. Valid values are `none`, `create_prorations`, and `always_invoice`.",
@@ -66349,7 +66293,7 @@
"type": "string"
}
},
- "title": "radar_options",
+ "title": "radar_options_with_hidden_options",
"type": "object"
},
"receipt_email": {
@@ -67222,6 +67166,43 @@
"description": "Returns a list of Checkout Sessions.
",
"operationId": "GetCheckoutSessions",
"parameters": [
+ {
+ "description": "Only return the Checkout Sessions 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": "Only return the Checkout Sessions for the Customer specified.",
"in": "query",
@@ -67323,6 +67304,21 @@
},
"style": "form"
},
+ {
+ "description": "Only return the Checkout Sessions matching the given status.",
+ "in": "query",
+ "name": "status",
+ "required": false,
+ "schema": {
+ "enum": [
+ "complete",
+ "expired",
+ "open"
+ ],
+ "type": "string"
+ },
+ "style": "form"
+ },
{
"description": "Only return the Checkout Session for the subscription specified.",
"in": "query",
@@ -67561,6 +67557,24 @@
"consent_collection": {
"description": "Configure fields for the Checkout Session to gather active consent from customers.",
"properties": {
+ "payment_method_reuse_agreement": {
+ "description": "Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.",
+ "properties": {
+ "position": {
+ "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
+ "enum": [
+ "auto",
+ "hidden"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "title": "payment_method_reuse_agreement_params",
+ "type": "object"
+ },
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
"enum": [
@@ -67582,7 +67596,7 @@
"type": "object"
},
"currency": {
- "description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
+ "description": "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). Required in `setup` mode when `payment_method_types` is not set.",
"type": "string"
},
"custom_fields": {
@@ -67708,6 +67722,31 @@
"custom_text": {
"description": "Display additional text for your customers using custom text.",
"properties": {
+ "after_submit": {
+ "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 after the payment confirmation button."
+ },
"shipping_address": {
"anyOf": [
{
@@ -67788,7 +67827,7 @@
"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 `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.",
+ "description": "ID of an existing Customer, if one exists. In `payment` mode, the customer’s most recently saved 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, otherwise the most recently saved 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"
},
@@ -68936,6 +68975,21 @@
"title": "payment_method_options_param",
"type": "object"
},
+ "revolut_pay": {
+ "description": "contains details about the RevolutPay payment method options.",
+ "properties": {
+ "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": [
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "contains details about the Sepa Debit payment method options.",
"properties": {
@@ -69061,7 +69115,7 @@
"type": "object"
},
"payment_method_types": {
- "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nIn `payment` and `subscription` mode, you can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nIt is required in `setup` mode.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.",
+ "description": "A list of the types of payment methods (e.g., `card`) this Checkout Session can accept.\n\nYou can omit this attribute to manage your payment methods from the [Stripe Dashboard](https://dashboard.stripe.com/settings/payment_methods).\nSee [Dynamic Payment Methods](https://stripe.com/docs/payments/payment-methods/integration-options#using-dynamic-payment-methods) for more details.\n\nRead more about the supported payment methods and their requirements in our [payment\nmethod details guide](/docs/payments/checkout/payment-methods).\n\nIf multiple payment methods are passed, Checkout will dynamically reorder them to\nprioritize the most relevant payment methods based on the customer's location and\nother characteristics.",
"items": {
"enum": [
"acss_debit",
@@ -69090,6 +69144,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -69683,7 +69738,7 @@
"type": "object"
},
"success_url": {
- "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nIf you’d like to use information from the successful Checkout Session on your page,\nread the guide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).",
+ "description": "The URL to which Stripe should send customers when payment or setup\nis complete.\nThis parameter is not allowed if ui_mode is `embedded`. If you’d like to use\ninformation from the successful Checkout Session on your page, read the\nguide on [customizing your success page](https://stripe.com/docs/payments/checkout/custom-success-page).",
"maxLength": 5000,
"type": "string"
},
@@ -70012,10 +70067,10 @@
}
}
},
- "/v1/country_specs": {
+ "/v1/climate/orders": {
"get": {
- "description": "Lists all Country Spec objects available in the API.
",
- "operationId": "GetCountrySpecs",
+ "description": "Lists all Climate order objects. The orders are returned sorted by creation date, with the\nmost recently created orders appearing first.
",
+ "operationId": "GetClimateOrders",
"parameters": [
{
"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.",
@@ -70087,7 +70142,7 @@
"properties": {
"data": {
"items": {
- "$ref": "#/components/schemas/country_spec"
+ "$ref": "#/components/schemas/climate.order"
},
"type": "array"
},
@@ -70105,7 +70160,7 @@
"url": {
"description": "The URL where this list can be accessed.",
"maxLength": 5000,
- "pattern": "^/v1/country_specs",
+ "pattern": "^/v1/climate/orders",
"type": "string"
}
},
@@ -70115,7 +70170,7 @@
"object",
"url"
],
- "title": "CountrySpecList",
+ "title": "ClimateRemovalsOrdersList",
"type": "object",
"x-expandableFields": [
"data"
@@ -70136,23 +70191,118 @@
"description": "Error response."
}
}
+ },
+ "post": {
+ "description": "Creates a Climate order object for a given Climate product. The order will be processed immediately\nafter creation and payment will be deducted your Stripe balance.
",
+ "operationId": "PostClimateOrders",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "beneficiary": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "amount": {
+ "description": "Requested amount of carbon removal units. Either this or `metric_tons` must be specified.",
+ "type": "integer"
+ },
+ "beneficiary": {
+ "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set.",
+ "properties": {
+ "public_name": {
+ "description": "Publicly displayable name for the end beneficiary of carbon removal.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "public_name"
+ ],
+ "title": "beneficiary_params",
+ "type": "object"
+ },
+ "currency": {
+ "description": "Request currency for the order as a three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a supported [settlement currency for your account](https://stripe.com/docs/currencies). If omitted, the account's default currency will be used.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "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"
+ },
+ "metric_tons": {
+ "description": "Requested number of tons for the order. Either this or `amount` must be specified.",
+ "format": "decimal",
+ "type": "string"
+ },
+ "product": {
+ "description": "Unique identifier of the Climate product.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "product"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
}
},
- "/v1/country_specs/{country}": {
+ "/v1/climate/orders/{order}": {
"get": {
- "description": "Returns a Country Spec for a given Country code.
",
- "operationId": "GetCountrySpecsCountry",
+ "description": "Retrieves the details of a Climate order object with the given ID.
",
+ "operationId": "GetClimateOrdersOrder",
"parameters": [
- {
- "in": "path",
- "name": "country",
- "required": true,
- "schema": {
- "maxLength": 5000,
- "type": "string"
- },
- "style": "simple"
- },
{
"description": "Specifies which fields in the response should be expanded.",
"explode": true,
@@ -70167,6 +70317,17 @@
"type": "array"
},
"style": "deepObject"
+ },
+ {
+ "description": "Unique identifier of the order.",
+ "in": "path",
+ "name": "order",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
}
],
"requestBody": {
@@ -70187,7 +70348,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/country_spec"
+ "$ref": "#/components/schemas/climate.order"
}
}
},
@@ -70204,49 +70365,815 @@
"description": "Error response."
}
}
- }
- },
- "/v1/coupons": {
- "get": {
- "description": "Returns a list of your coupons.
",
- "operationId": "GetCoupons",
+ },
+ "post": {
+ "description": "Updates the specified order by setting the values of the parameters passed.
",
+ "operationId": "PostClimateOrdersOrder",
"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.",
- "explode": true,
- "in": "query",
- "name": "created",
- "required": false,
+ "description": "Unique identifier of the order.",
+ "in": "path",
+ "name": "order",
+ "required": true,
"schema": {
- "anyOf": [
- {
- "properties": {
- "gt": {
- "description": "Minimum value to filter by (exclusive)",
- "type": "integer"
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "beneficiary": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "beneficiary": {
+ "anyOf": [
+ {
+ "properties": {
+ "public_name": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Publicly displayable name for the end beneficiary of carbon removal."
+ }
+ },
+ "required": [
+ "public_name"
+ ],
+ "title": "beneficiary_params",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Publicly sharable reference for the end beneficiary of carbon removal. Assumed to be the Stripe account if not set."
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
},
- "gte": {
- "description": "Minimum value to filter by (inclusive)",
- "type": "integer"
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
},
- "lt": {
- "description": "Maximum value to filter by (exclusive)",
- "type": "integer"
+ "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"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/climate.order"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/climate/orders/{order}/cancel": {
+ "post": {
+ "description": "Cancels a Climate order. You can cancel an order within 30 days of creation. Stripe refunds the\nreservation amount_subtotal, but not the amount_fees for user-triggered cancellations. Frontier\nmight cancel reservations if suppliers fail to deliver. If Frontier cancels the reservation, Stripe\nprovides 90 days advance notice and refunds the amount_total.
",
+ "operationId": "PostClimateOrdersOrderCancel",
+ "parameters": [
+ {
+ "description": "Unique identifier of the order.",
+ "in": "path",
+ "name": "order",
+ "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"
},
- "lte": {
- "description": "Maximum value to filter by (inclusive)",
- "type": "integer"
- }
- },
- "title": "range_query_specs",
- "type": "object"
+ "type": "array"
+ }
},
- {
- "type": "integer"
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/climate.order"
}
- ]
+ }
},
- "style": "deepObject"
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/climate/products": {
+ "get": {
+ "description": "Lists all available Climate product objects.
",
+ "operationId": "GetClimateProducts",
+ "parameters": [
+ {
+ "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/climate.product"
+ },
+ "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/climate/products",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "ClimateRemovalsProductsList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/climate/products/{product}": {
+ "get": {
+ "description": "Retrieves the details of a Climate product with the given ID.
",
+ "operationId": "GetClimateProductsProduct",
+ "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": "product",
+ "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/climate.product"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/climate/suppliers": {
+ "get": {
+ "description": "Lists all available Climate supplier objects.
",
+ "operationId": "GetClimateSuppliers",
+ "parameters": [
+ {
+ "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/climate.supplier"
+ },
+ "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/climate/suppliers",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "ClimateRemovalsSuppliersList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/climate/suppliers/{supplier}": {
+ "get": {
+ "description": "Retrieves a Climate supplier object.
",
+ "operationId": "GetClimateSuppliersSupplier",
+ "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": "supplier",
+ "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/climate.supplier"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/country_specs": {
+ "get": {
+ "description": "Lists all Country Spec objects available in the API.
",
+ "operationId": "GetCountrySpecs",
+ "parameters": [
+ {
+ "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/country_spec"
+ },
+ "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/country_specs",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "CountrySpecList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/country_specs/{country}": {
+ "get": {
+ "description": "Returns a Country Spec for a given Country code.
",
+ "operationId": "GetCountrySpecsCountry",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "country",
+ "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/country_spec"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/coupons": {
+ "get": {
+ "description": "Returns a list of your coupons.
",
+ "operationId": "GetCoupons",
+ "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.",
+ "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.",
@@ -70980,6 +71907,44 @@
"description": "The line item quantity to credit.",
"type": "integer"
},
+ "tax_amounts": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "amount": {
+ "description": "The amount, in cents (or local equivalent), of the tax.",
+ "type": "integer"
+ },
+ "tax_rate": {
+ "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "taxable_amount": {
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ],
+ "title": "tax_amount_with_tax_rate_param",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ },
"tax_rates": {
"anyOf": [
{
@@ -70996,7 +71961,7 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -71193,6 +72158,44 @@
"description": "The line item quantity to credit.",
"type": "integer"
},
+ "tax_amounts": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "amount": {
+ "description": "The amount, in cents (or local equivalent), of the tax.",
+ "type": "integer"
+ },
+ "tax_rate": {
+ "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "taxable_amount": {
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ],
+ "title": "tax_amount_with_tax_rate_param",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ },
"tax_rates": {
"anyOf": [
{
@@ -71209,7 +72212,7 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -71477,6 +72480,44 @@
"description": "The line item quantity to credit.",
"type": "integer"
},
+ "tax_amounts": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "amount": {
+ "description": "The amount, in cents (or local equivalent), of the tax.",
+ "type": "integer"
+ },
+ "tax_rate": {
+ "description": "The id of the tax rate for this tax amount. The tax rate must have been automatically created by Stripe.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "taxable_amount": {
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount",
+ "tax_rate",
+ "taxable_amount"
+ ],
+ "title": "tax_amount_with_tax_rate_param",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A list of up to 10 tax amounts for the credit note line item. Cannot be mixed with `tax_rates`."
+ },
"tax_rates": {
"anyOf": [
{
@@ -71493,7 +72534,7 @@
"type": "string"
}
],
- "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item`."
+ "description": "The tax rates which apply to the credit note line item. Only valid when the `type` is `custom_line_item` and cannot be mixed with `tax_amounts`."
},
"type": {
"description": "Type of the credit note line item, one of `invoice_line_item` or `custom_line_item`",
@@ -72595,6 +73636,14 @@
}
],
"description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes."
+ },
+ "validate_location": {
+ "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.",
+ "enum": [
+ "deferred",
+ "immediately"
+ ],
+ "type": "string"
}
},
"title": "tax_param",
@@ -73370,6 +74419,14 @@
}
],
"description": "A recent IP address of the customer used for tax reporting and tax location inference. Stripe recommends updating the IP address when a new PaymentMethod is attached or the address field on the customer is updated. We recommend against updating this field more frequently since it could result in unexpected tax location/reporting outcomes."
+ },
+ "validate_location": {
+ "description": "A flag that indicates when Stripe should validate the customer tax location. Defaults to `deferred`.",
+ "enum": [
+ "deferred",
+ "immediately"
+ ],
+ "type": "string"
}
},
"title": "tax_param",
@@ -74486,6 +75543,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -77081,7 +78139,7 @@
"object",
"url"
],
- "title": "FileFileLinkList",
+ "title": "FileResourceFileLinkList",
"type": "object",
"x-expandableFields": [
"data"
@@ -77537,7 +78595,7 @@
"object",
"url"
],
- "title": "FileFileList",
+ "title": "FileResourceFileList",
"type": "object",
"x-expandableFields": [
"data"
@@ -82228,7 +83286,7 @@
"style": "deepObject"
},
{
- "description": "Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.",
+ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.",
"explode": true,
"in": "query",
"name": "subscription_cancel_at",
@@ -82501,7 +83559,7 @@
"style": "form"
},
{
- "description": "Date a subscription is intended to start (can be future or past)",
+ "description": "Date a subscription is intended to start (can be future or past).",
"in": "query",
"name": "subscription_start_date",
"required": false,
@@ -83227,7 +84285,7 @@
"style": "deepObject"
},
{
- "description": "Timestamp indicating when the subscription should be scheduled to cancel. Will prorate if within the current period and prorations have been enabled using `proration_behavior`.",
+ "description": "A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using `proration_behavior`. If set during a future period, this will always cause a proration for that period.",
"explode": true,
"in": "query",
"name": "subscription_cancel_at",
@@ -83500,7 +84558,7 @@
"style": "form"
},
{
- "description": "Date a subscription is intended to start (can be future or past)",
+ "description": "Date a subscription is intended to start (can be future or past).",
"in": "query",
"name": "subscription_start_date",
"required": false,
@@ -84961,12 +86019,13 @@
}
}
},
- "/v1/invoices/{invoice}/mark_uncollectible": {
+ "/v1/invoices/{invoice}/lines/{line_item_id}": {
"post": {
- "description": "Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
",
- "operationId": "PostInvoicesInvoiceMarkUncollectible",
+ "description": "Updates an invoice’s line item. Some fields, such as tax_amounts, only live on the invoice line item,\nso they can only be updated through this endpoint. Other fields, such as amount, live on both the invoice\nitem and the invoice line item, so updates on this endpoint will propagate to the invoice item as well.\nUpdating an invoice’s line item is only possible before the invoice is finalized.
",
+ "operationId": "PostInvoicesInvoiceLinesLineItemId",
"parameters": [
{
+ "description": "Invoice ID of line item",
"in": "path",
"name": "invoice",
"required": true,
@@ -84975,20 +86034,98 @@
"type": "string"
},
"style": "simple"
+ },
+ {
+ "description": "Invoice line item ID",
+ "in": "path",
+ "name": "line_item_id",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
}
],
"requestBody": {
"content": {
"application/x-www-form-urlencoded": {
"encoding": {
+ "discounts": {
+ "explode": true,
+ "style": "deepObject"
+ },
"expand": {
"explode": true,
"style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "period": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "price_data": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tax_amounts": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "tax_rates": {
+ "explode": true,
+ "style": "deepObject"
}
},
"schema": {
"additionalProperties": false,
"properties": {
+ "amount": {
+ "description": "The integer amount in cents (or local equivalent) of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
+ "type": "integer"
+ },
+ "description": {
+ "description": "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "discountable": {
+ "description": "Controls whether discounts apply to this line item. Defaults to false for prorations or negative line items, and true for all other line items. Cannot be set to true for prorations.",
+ "type": "boolean"
+ },
+ "discounts": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "coupon": {
+ "description": "ID of the coupon to create a new discount for.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "discount": {
+ "description": "ID of an existing discount on the object (or one of its ancestors) to reuse.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "title": "discounts_data_param",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The coupons & existing discounts which apply to the line item. Item discounts are applied before invoice discounts. Pass an empty string to remove previously-defined discounts."
+ },
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"items": {
@@ -84996,6 +86133,244 @@
"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`."
+ },
+ "period": {
+ "description": "The period associated with this invoice item. When set to different values, the period will be rendered on the invoice. If you have [Stripe Revenue Recognition](https://stripe.com/docs/revenue-recognition) enabled, the period will be used to recognize and defer revenue. See the [Revenue Recognition documentation](https://stripe.com/docs/revenue-recognition/methodology/subscriptions-and-invoicing) for details.",
+ "properties": {
+ "end": {
+ "description": "The end of the period, which must be greater than or equal to the start. This value is inclusive.",
+ "format": "unix-time",
+ "type": "integer"
+ },
+ "start": {
+ "description": "The start of the period. This value is inclusive.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "end",
+ "start"
+ ],
+ "title": "period",
+ "type": "object"
+ },
+ "price": {
+ "description": "The ID of the price object.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "price_data": {
+ "description": "Data used to generate a new [Price](https://stripe.com/docs/api/prices) object inline.",
+ "properties": {
+ "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"
+ },
+ "product": {
+ "description": "The ID of the product that this price will belong to. One of `product` or `product_data` is required.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "product_data": {
+ "description": "Data used to generate a new product object inline. One of `product` or `product_data` is required.",
+ "properties": {
+ "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"
+ },
+ "images": {
+ "description": "A list of up to 8 URLs of images for this product, meant to be displayable to the customer.",
+ "items": {
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "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"
+ },
+ "name": {
+ "description": "The product's name, meant to be displayable to the customer.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "tax_code": {
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "name"
+ ],
+ "title": "product_data",
+ "type": "object"
+ },
+ "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": [
+ "exclusive",
+ "inclusive",
+ "unspecified"
+ ],
+ "type": "string"
+ },
+ "unit_amount": {
+ "description": "A non-negative integer in cents (or local equivalent) representing how much to charge. One of `unit_amount` or `unit_amount_decimal` is required.",
+ "type": "integer"
+ },
+ "unit_amount_decimal": {
+ "description": "Same as `unit_amount`, but accepts a decimal value in cents (or local equivalent) with at most 12 decimal places. Only one of `unit_amount` and `unit_amount_decimal` can be set.",
+ "format": "decimal",
+ "type": "string"
+ }
+ },
+ "required": [
+ "currency"
+ ],
+ "title": "one_time_price_data_with_product_data",
+ "type": "object"
+ },
+ "quantity": {
+ "description": "Non-negative integer. The quantity of units for the line item.",
+ "type": "integer"
+ },
+ "tax_amounts": {
+ "anyOf": [
+ {
+ "items": {
+ "properties": {
+ "amount": {
+ "description": "The amount, in cents (or local equivalent), of the tax.",
+ "type": "integer"
+ },
+ "tax_rate_data": {
+ "description": "Data to find or create a TaxRate object.\n\nStripe automatically creates or reuses a TaxRate object for each tax amount. If the `tax_rate_data` exactly matches a previous value, Stripe will reuse the TaxRate object. TaxRate objects created automatically by Stripe are immediately archived, do not appear in the line item’s `tax_rates`, and cannot be directly added to invoices, payments, or line items.",
+ "properties": {
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "description": {
+ "description": "An arbitrary string attached to the tax rate for your internal use only. It will not be visible to your customers.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "display_name": {
+ "description": "The display name of the tax rate, which will be shown to users.",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "inclusive": {
+ "description": "This specifies if the tax rate is inclusive or exclusive.",
+ "type": "boolean"
+ },
+ "jurisdiction": {
+ "description": "The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. It also appears on your customer’s invoice.",
+ "maxLength": 50,
+ "type": "string"
+ },
+ "percentage": {
+ "description": "The statutory tax rate percent. This field accepts decimal values between 0 and 100 inclusive with at most 4 decimal places. To accommodate fixed-amount taxes, set the percentage to zero. Stripe will not display zero percentages on the invoice unless the `amount` of the tax is also zero.",
+ "type": "number"
+ },
+ "state": {
+ "description": "[ISO 3166-2 subdivision code](https://en.wikipedia.org/wiki/ISO_3166-2:US), without country prefix. For example, \"NY\" for New York, United States.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "tax_type": {
+ "description": "The high-level tax type, such as `vat` or `sales_tax`.",
+ "enum": [
+ "amusement_tax",
+ "communications_tax",
+ "gst",
+ "hst",
+ "igst",
+ "jct",
+ "lease_tax",
+ "pst",
+ "qst",
+ "rst",
+ "sales_tax",
+ "service_tax",
+ "vat"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "display_name",
+ "inclusive",
+ "percentage"
+ ],
+ "title": "tax_rate_data_param",
+ "type": "object"
+ },
+ "taxable_amount": {
+ "description": "The amount on which tax is calculated, in cents (or local equivalent).",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount",
+ "tax_rate_data",
+ "taxable_amount"
+ ],
+ "title": "tax_amount_param",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "A list of up to 10 tax amounts for this line item. This can be useful if you calculate taxes on your own or use a third-party to calculate them. You cannot set tax amounts if any line item has [tax_rates](https://stripe.com/docs/api/invoices/line_item#invoice_line_item_object-tax_rates) or if the invoice has [default_tax_rates](https://stripe.com/docs/api/invoices/object#invoice_object-default_tax_rates) or uses [automatic tax](https://stripe.com/docs/tax/invoicing). Pass an empty string to remove previously defined tax amounts."
+ },
+ "tax_rates": {
+ "anyOf": [
+ {
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The tax rates which apply to the line item. When set, the `default_tax_rates` on the invoice do not apply to this line item. Pass an empty string to remove previously-defined tax rates."
}
},
"type": "object"
@@ -85009,7 +86384,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/invoice"
+ "$ref": "#/components/schemas/line_item"
}
}
},
@@ -85028,10 +86403,10 @@
}
}
},
- "/v1/invoices/{invoice}/pay": {
+ "/v1/invoices/{invoice}/mark_uncollectible": {
"post": {
- "description": "Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
",
- "operationId": "PostInvoicesInvoicePay",
+ "description": "Marking an invoice as uncollectible is useful for keeping track of bad debts that can be written off for accounting purposes.
",
+ "operationId": "PostInvoicesInvoiceMarkUncollectible",
"parameters": [
{
"in": "path",
@@ -85051,10 +86426,6 @@
"expand": {
"explode": true,
"style": "deepObject"
- },
- "mandate": {
- "explode": true,
- "style": "deepObject"
}
},
"schema": {
@@ -85067,43 +86438,114 @@
"type": "string"
},
"type": "array"
- },
- "forgive": {
- "description": "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.",
- "type": "boolean"
- },
- "mandate": {
- "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).",
- "type": "boolean"
- },
- "paid_out_of_band": {
- "description": "Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.",
- "type": "boolean"
- },
- "payment_method": {
- "description": "A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.",
- "maxLength": 5000,
- "type": "string"
- },
- "source": {
- "description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.",
- "maxLength": 5000,
- "type": "string"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/invoice"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/invoices/{invoice}/pay": {
+ "post": {
+ "description": "Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you’d like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you can do so.
",
+ "operationId": "PostInvoicesInvoicePay",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "invoice",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "mandate": {
+ "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"
+ },
+ "forgive": {
+ "description": "In cases where the source used to pay the invoice has insufficient funds, passing `forgive=true` controls whether a charge should be attempted for the full amount available on the source, up to the amount to fully pay the invoice. This effectively forgives the difference between the amount available on the source and the amount due. \n\nPassing `forgive=false` will fail the charge if the source hasn't been pre-funded with the right amount. An example for this case is with ACH Credit Transfers and wires: if the amount wired is less than the amount due by a small amount, you might want to forgive the difference. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "mandate": {
+ "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).",
+ "type": "boolean"
+ },
+ "paid_out_of_band": {
+ "description": "Boolean representing whether an invoice is paid outside of Stripe. This will result in no charge being made. Defaults to `false`.",
+ "type": "boolean"
+ },
+ "payment_method": {
+ "description": "A PaymentMethod to be charged. The PaymentMethod must be the ID of a PaymentMethod belonging to the customer associated with the invoice being paid.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "source": {
+ "description": "A payment source to be charged. The source must be the ID of a source belonging to the customer associated with the invoice being paid.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"type": "object"
@@ -94016,6 +95458,7 @@
"type": "boolean"
},
"confirmation_method": {
+ "description": "Describes whether we can confirm this PaymentIntent automatically, or if it requires customer action to confirm the payment.",
"enum": [
"automatic",
"manual"
@@ -94652,6 +96095,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -94717,6 +96166,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -95305,12 +96755,11 @@
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
@@ -95353,6 +96802,114 @@
}
],
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "exemption_indicator": {
+ "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
+ "enum": [
+ "low_risk",
+ "none"
+ ],
+ "type": "string"
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "cryptogram",
+ "transaction_id",
+ "version"
+ ],
+ "title": "payment_method_options_param",
+ "type": "object"
}
},
"title": "payment_intent_param",
@@ -95375,14 +96932,6 @@
"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"
@@ -95726,7 +97275,8 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
"title": "payment_method_options_param",
@@ -96072,6 +97622,32 @@
],
"description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
},
+ "revolut_pay": {
+ "anyOf": [
+ {
+ "properties": {
+ "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": [
+ "",
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options."
+ },
"sepa_debit": {
"anyOf": [
{
@@ -96422,7 +97998,7 @@
"type": "object"
},
"statement_descriptor": {
- "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.",
+ "description": "For card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 22,
"type": "string"
},
@@ -96432,7 +98008,7 @@
"type": "string"
},
"transfer_data": {
- "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).",
+ "description": "The parameters that you can use to automatically create a Transfer.\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.",
@@ -97330,6 +98906,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -97395,6 +98977,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -97983,12 +99566,11 @@
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
@@ -98031,6 +99613,114 @@
}
],
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "exemption_indicator": {
+ "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
+ "enum": [
+ "low_risk",
+ "none"
+ ],
+ "type": "string"
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "cryptogram",
+ "transaction_id",
+ "version"
+ ],
+ "title": "payment_method_options_param",
+ "type": "object"
}
},
"title": "payment_intent_param",
@@ -98053,14 +99743,6 @@
"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"
@@ -98404,7 +100086,8 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
"title": "payment_method_options_param",
@@ -98750,6 +100433,32 @@
],
"description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
},
+ "revolut_pay": {
+ "anyOf": [
+ {
+ "properties": {
+ "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": [
+ "",
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options."
+ },
"sepa_debit": {
"anyOf": [
{
@@ -99105,7 +100814,7 @@
"description": "Shipping information for this PaymentIntent."
},
"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 card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 22,
"type": "string"
},
@@ -99388,7 +101097,7 @@
"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`."
},
"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 card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 22,
"type": "string"
},
@@ -100151,6 +101860,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -100216,6 +101931,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -100804,12 +102520,11 @@
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
},
@@ -100852,6 +102567,114 @@
}
],
"description": "Provides information about a card payment that customers see on their statements. Concatenated with the Kanji prefix (shortened Kanji descriptor) or Kanji statement descriptor that’s set on the account to form the complete statement descriptor. Maximum 17 characters. On card statements, the *concatenation* of both prefix and suffix (including separators) will appear truncated to 17 characters."
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this payment.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "exemption_indicator": {
+ "description": "The exemption requested via 3DS and accepted by the issuer at authentication time.",
+ "enum": [
+ "low_risk",
+ "none"
+ ],
+ "type": "string"
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "cryptogram",
+ "transaction_id",
+ "version"
+ ],
+ "title": "payment_method_options_param",
+ "type": "object"
}
},
"title": "payment_intent_param",
@@ -100874,14 +102697,6 @@
"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"
@@ -101225,7 +103040,8 @@
"enum": [
"none"
],
- "type": "string"
+ "type": "string",
+ "x-stripeBypassValidation": true
}
},
"title": "payment_method_options_param",
@@ -101571,6 +103387,32 @@
],
"description": "If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options."
},
+ "revolut_pay": {
+ "anyOf": [
+ {
+ "properties": {
+ "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": [
+ "",
+ "none",
+ "off_session"
+ ],
+ "type": "string"
+ }
+ },
+ "title": "payment_method_options_param",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If this is a `revolut_pay` PaymentMethod, this sub-hash contains details about the Demo Pay payment method options."
+ },
"sepa_debit": {
"anyOf": [
{
@@ -102033,7 +103875,7 @@
"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 card charges, use [statement_descriptor_suffix](https://stripe.com/docs/payments/account/statement-descriptors#dynamic). Otherwise, you can use this value as the complete description of a charge on your customers' statements. It must contain at least one letter and be 1–22 characters long.",
"maxLength": 22,
"type": "string"
},
@@ -102355,6 +104197,10 @@
"explode": true,
"style": "deepObject"
},
+ "restrictions": {
+ "explode": true,
+ "style": "deepObject"
+ },
"shipping_address_collection": {
"explode": true,
"style": "deepObject"
@@ -102461,6 +104307,24 @@
"consent_collection": {
"description": "Configure fields to gather active consent from customers.",
"properties": {
+ "payment_method_reuse_agreement": {
+ "description": "Determines the display of payment method reuse agreement text in the UI. If set to `hidden`, it will hide legal text related to the reuse of a payment method.",
+ "properties": {
+ "position": {
+ "description": "Determines the position and visibility of the payment method reuse agreement in the UI. When set to `auto`, Stripe's\ndefaults will be used. When set to `hidden`, the payment method reuse agreement text will always be hidden in the UI.",
+ "enum": [
+ "auto",
+ "hidden"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "position"
+ ],
+ "title": "payment_method_reuse_agreement_params",
+ "type": "object"
+ },
"promotions": {
"description": "If set to `auto`, enables the collection of customer consent for promotional communications. The Checkout\nSession will determine whether to display an option to opt into promotional communication\nfrom the merchant depending on the customer's locale. Only available to US merchants.",
"enum": [
@@ -102608,6 +104472,31 @@
"custom_text": {
"description": "Display additional text for your customers using custom text.",
"properties": {
+ "after_submit": {
+ "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 after the payment confirmation button."
+ },
"shipping_address": {
"anyOf": [
{
@@ -102703,6 +104592,11 @@
},
"type": "array"
},
+ "inactive_message": {
+ "description": "The custom message to be displayed to a customer when a payment link is no longer active.",
+ "maxLength": 500,
+ "type": "string"
+ },
"invoice_creation": {
"description": "Generate a post-purchase Invoice for one-time payments.",
"properties": {
@@ -102897,6 +104791,11 @@
],
"type": "string"
},
+ "description": {
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users.",
+ "maxLength": 1000,
+ "type": "string"
+ },
"metadata": {
"additionalProperties": {
"type": "string"
@@ -102921,6 +104820,11 @@
"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"
+ },
+ "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/connect/separate-charges-and-transfers) for details.",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "payment_intent_data_params",
@@ -102986,6 +104890,30 @@
"title": "phone_number_collection_params",
"type": "object"
},
+ "restrictions": {
+ "description": "Settings that restrict the usage of a payment link.",
+ "properties": {
+ "completed_sessions": {
+ "description": "Configuration for the `completed_sessions` restriction type.",
+ "properties": {
+ "limit": {
+ "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit"
+ ],
+ "title": "completed_sessions_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "completed_sessions"
+ ],
+ "title": "restrictions_params",
+ "type": "object"
+ },
"shipping_address_collection": {
"description": "Configuration for collecting the customer's shipping address.",
"properties": {
@@ -103271,7 +105199,7 @@
"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": {
"description": {
- "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
"type": "string"
},
@@ -103285,6 +105213,35 @@
"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"
+ },
+ "trial_settings": {
+ "description": "Settings related to subscription trials.",
+ "properties": {
+ "end_behavior": {
+ "description": "Defines how the subscription should behave when the user's free trial ends.",
+ "properties": {
+ "missing_payment_method": {
+ "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.",
+ "enum": [
+ "cancel",
+ "create_invoice",
+ "pause"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "missing_payment_method"
+ ],
+ "title": "end_behavior",
+ "type": "object"
+ }
+ },
+ "required": [
+ "end_behavior"
+ ],
+ "title": "trial_settings_config",
+ "type": "object"
}
},
"title": "subscription_data_params",
@@ -103462,6 +105419,10 @@
"explode": true,
"style": "deepObject"
},
+ "inactive_message": {
+ "explode": true,
+ "style": "deepObject"
+ },
"invoice_creation": {
"explode": true,
"style": "deepObject"
@@ -103482,6 +105443,10 @@
"explode": true,
"style": "deepObject"
},
+ "restrictions": {
+ "explode": true,
+ "style": "deepObject"
+ },
"shipping_address_collection": {
"explode": true,
"style": "deepObject"
@@ -103702,6 +105667,31 @@
"custom_text": {
"description": "Display additional text for your customers using custom text.",
"properties": {
+ "after_submit": {
+ "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 after the payment confirmation button."
+ },
"shipping_address": {
"anyOf": [
{
@@ -103797,6 +105787,21 @@
},
"type": "array"
},
+ "inactive_message": {
+ "anyOf": [
+ {
+ "maxLength": 500,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "The custom message to be displayed to a customer when a payment link is no longer active."
+ },
"invoice_creation": {
"description": "Generate a post-purchase Invoice for one-time payments.",
"properties": {
@@ -103977,6 +105982,21 @@
"payment_intent_data": {
"description": "A subset of parameters to be passed to PaymentIntent creation for Checkout Sessions in `payment` mode.",
"properties": {
+ "description": {
+ "anyOf": [
+ {
+ "maxLength": 1000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "An arbitrary string attached to the object. Often useful for displaying to users."
+ },
"metadata": {
"anyOf": [
{
@@ -104023,6 +106043,21 @@
}
],
"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."
+ },
+ "transfer_group": {
+ "anyOf": [
+ {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "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."
}
},
"title": "payment_intent_data_update_params",
@@ -104084,6 +106119,40 @@
],
"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)."
},
+ "restrictions": {
+ "anyOf": [
+ {
+ "properties": {
+ "completed_sessions": {
+ "description": "Configuration for the `completed_sessions` restriction type.",
+ "properties": {
+ "limit": {
+ "description": "The maximum number of checkout sessions that can be completed for the `completed_sessions` restriction to be met.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "limit"
+ ],
+ "title": "completed_sessions_params",
+ "type": "object"
+ }
+ },
+ "required": [
+ "completed_sessions"
+ ],
+ "title": "restrictions_params",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Settings that restrict the usage of a payment link."
+ },
"shipping_address_collection": {
"anyOf": [
{
@@ -104369,6 +106438,45 @@
}
],
"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."
+ },
+ "trial_settings": {
+ "anyOf": [
+ {
+ "properties": {
+ "end_behavior": {
+ "description": "Defines how the subscription should behave when the user's free trial ends.",
+ "properties": {
+ "missing_payment_method": {
+ "description": "Indicates how the subscription should change when the trial ends if the user did not provide a payment method.",
+ "enum": [
+ "cancel",
+ "create_invoice",
+ "pause"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "missing_payment_method"
+ ],
+ "title": "end_behavior",
+ "type": "object"
+ }
+ },
+ "required": [
+ "end_behavior"
+ ],
+ "title": "trial_settings_config",
+ "type": "object"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "Settings related to subscription trials."
}
},
"title": "subscription_data_update_params",
@@ -104782,6 +106890,10 @@
"explode": true,
"style": "deepObject"
},
+ "revolut_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
"sepa_debit": {
"explode": true,
"style": "deepObject"
@@ -105487,6 +107599,29 @@
"title": "payment_method_param",
"type": "object"
},
+ "revolut_pay": {
+ "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
+ "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": {
@@ -105816,6 +107951,10 @@
"explode": true,
"style": "deepObject"
},
+ "revolut_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
"sepa_debit": {
"explode": true,
"style": "deepObject"
@@ -106520,6 +108659,29 @@
"title": "payment_method_param",
"type": "object"
},
+ "revolut_pay": {
+ "description": "Revolut Pay, developed by Revolut, a global finance app, is a digital wallet payment method. Revolut Pay uses the customer’s stored balance or cards to fund the payment, and offers the option for non-Revolut customers to save their details after their first purchase.",
+ "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": {
@@ -107153,6 +109315,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -107368,6 +109531,10 @@
"explode": true,
"style": "deepObject"
},
+ "revolut_pay": {
+ "explode": true,
+ "style": "deepObject"
+ },
"sepa_debit": {
"explode": true,
"style": "deepObject"
@@ -107954,6 +110121,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -108020,6 +110193,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -109889,7 +112063,7 @@
},
"/v1/prices": {
"get": {
- "description": "Returns a list of your prices.
",
+ "description": "Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.
",
"operationId": "GetPrices",
"parameters": [
{
@@ -110407,7 +112581,7 @@
"description": "The recurring components of a price such as `interval` and `usage_type`.",
"properties": {
"aggregate_usage": {
- "description": "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for using the last usage record reported within a period, `last_ever` for using the last usage record ever (across period bounds) or `max` which uses the usage record with the maximum reported usage during a period. Defaults to `sum`.",
+ "description": "Specifies a usage aggregation strategy for prices of `usage_type=metered`. Defaults to `sum`.",
"enum": [
"last_during_period",
"last_ever",
@@ -113183,7 +115357,7 @@
"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.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
"type": "string"
},
@@ -113209,6 +115383,13 @@
],
"description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted."
},
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "type": "object"
+ },
"trial_period_days": {
"anyOf": [
{
@@ -113758,7 +115939,7 @@
"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."
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"effective_date": {
"anyOf": [
@@ -113782,6 +115963,13 @@
],
"description": "When creating a new subscription, the date of which the subscription schedule will start after the quote is accepted. When updating a subscription, the date of which the subscription will be updated using a subscription schedule. The special value `current_period_end` can be provided to update a subscription at the end of its current period. The `effective_date` is ignored if it is in the past when the quote is accepted."
},
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that will set metadata on the subscription or subscription schedule when the quote is accepted. If a recurring price is included in `line_items`, this field will be passed to the resulting subscription's `metadata` field. If `subscription_data.effective_date` is used, this field will be passed to the resulting subscription schedule's `phases.metadata` field. Unlike object-level metadata, this field is declarative. Updates will clear prior values.",
+ "type": "object"
+ },
"trial_period_days": {
"anyOf": [
{
@@ -114425,6 +116613,43 @@
},
"style": "form"
},
+ {
+ "description": "Only return early fraud warnings 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",
@@ -116232,6 +118457,8 @@
"anticipation_repayment",
"charge",
"charge_failure",
+ "climate_order_purchase",
+ "climate_order_refund",
"connect_collection_transfer",
"connect_reserved_funds",
"contribution",
@@ -116261,7 +118488,8 @@
"topup",
"topup_reversal",
"transfer",
- "transfer_reversal"
+ "transfer_reversal",
+ "unreconciled_customer_funds"
],
"maxLength": 5000,
"type": "string",
@@ -118495,6 +120723,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -118560,6 +120794,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -118811,14 +121046,108 @@
"x-stripeBypassValidation": true
},
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "title": "setup_intent_payment_method_options_param",
+ "type": "object"
}
},
"title": "setup_intent_param",
@@ -119689,6 +122018,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -119754,6 +122089,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -120005,14 +122341,108 @@
"x-stripeBypassValidation": true
},
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "title": "setup_intent_payment_method_options_param",
+ "type": "object"
}
},
"title": "setup_intent_param",
@@ -120910,6 +123340,12 @@
"title": "radar_options",
"type": "object"
},
+ "revolut_pay": {
+ "description": "If this is a `Revolut Pay` PaymentMethod, this hash contains details about the Revolut Pay payment method.",
+ "properties": {},
+ "title": "param",
+ "type": "object"
+ },
"sepa_debit": {
"description": "If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.",
"properties": {
@@ -120975,6 +123411,7 @@
"paypal",
"pix",
"promptpay",
+ "revolut_pay",
"sepa_debit",
"sofort",
"us_bank_account",
@@ -121226,14 +123663,108 @@
"x-stripeBypassValidation": true
},
"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.",
+ "description": "We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://stripe.com/docs/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. If not provided, this value defaults to `automatic`. Read our guide on [manually requesting 3D Secure](https://stripe.com/docs/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.",
"enum": [
"any",
"automatic"
],
- "maxLength": 5000,
"type": "string",
"x-stripeBypassValidation": true
+ },
+ "three_d_secure": {
+ "description": "If 3D Secure authentication was performed with a third-party provider,\nthe authentication details to use for this setup.",
+ "properties": {
+ "ares_trans_status": {
+ "description": "The `transStatus` returned from the card Issuer’s ACS in the ARes.",
+ "enum": [
+ "A",
+ "C",
+ "I",
+ "N",
+ "R",
+ "U",
+ "Y"
+ ],
+ "type": "string"
+ },
+ "cryptogram": {
+ "description": "The cryptogram, also known as the \"authentication value\" (AAV, CAVV or\nAEVV). This value is 20 bytes, base64-encoded into a 28-character string.\n(Most 3D Secure providers will return the base64-encoded version, which\nis what you should specify here.)",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "electronic_commerce_indicator": {
+ "description": "The Electronic Commerce Indicator (ECI) is returned by your 3D Secure\nprovider and indicates what degree of authentication was performed.",
+ "enum": [
+ "01",
+ "02",
+ "05",
+ "06",
+ "07"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ },
+ "network_options": {
+ "description": "Network specific 3DS fields. Network specific arguments require an\nexplicit card brand choice. The parameter `payment_method_options.card.network``\nmust be populated accordingly",
+ "properties": {
+ "cartes_bancaires": {
+ "description": "Cartes Bancaires-specific 3DS fields.",
+ "properties": {
+ "cb_avalgo": {
+ "description": "The cryptogram calculation algorithm used by the card Issuer's ACS\nto calculate the Authentication cryptogram. Also known as `cavvAlgorithm`.\nmessageExtension: CB-AVALGO",
+ "enum": [
+ "0",
+ "1",
+ "2",
+ "3",
+ "4",
+ "A"
+ ],
+ "type": "string"
+ },
+ "cb_exemption": {
+ "description": "The exemption indicator returned from Cartes Bancaires in the ARes.\nmessage extension: CB-EXEMPTION; string (4 characters)\nThis is a 3 byte bitmap (low significant byte first and most significant\nbit first) that has been Base64 encoded",
+ "maxLength": 4,
+ "type": "string"
+ },
+ "cb_score": {
+ "description": "The risk score returned from Cartes Bancaires in the ARes.\nmessage extension: CB-SCORE; numeric value 0-99",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "cb_avalgo"
+ ],
+ "title": "cartes_bancaires_network_options_param",
+ "type": "object"
+ }
+ },
+ "title": "network_options_param",
+ "type": "object"
+ },
+ "requestor_challenge_indicator": {
+ "description": "The challenge indicator (`threeDSRequestorChallengeInd`) which was requested in the\nAReq sent to the card Issuer's ACS. A string containing 2 digits from 01-99.",
+ "maxLength": 2,
+ "type": "string"
+ },
+ "transaction_id": {
+ "description": "For 3D Secure 1, the XID. For 3D Secure 2, the Directory Server\nTransaction ID (dsTransID).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "version": {
+ "description": "The version of 3D Secure that was performed.",
+ "enum": [
+ "1.0.2",
+ "2.1.0",
+ "2.2.0"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "title": "setup_intent_payment_method_options_param",
+ "type": "object"
}
},
"title": "setup_intent_param",
@@ -124363,6 +126894,7 @@
"type": "string"
},
{
+ "format": "unix-time",
"type": "integer"
}
],
@@ -124812,7 +127344,7 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -125097,7 +127629,7 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"end_date": {
"description": "The date at which this phase of the subscription schedule ends. If set, `iterations` must not be set.",
@@ -125314,6 +127846,7 @@
"start_date": {
"anyOf": [
{
+ "format": "unix-time",
"type": "integer"
},
{
@@ -125543,7 +128076,7 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"invoice_settings": {
"description": "All invoices will be billed using the specified settings.",
@@ -125823,11 +128356,12 @@
"type": "string"
}
],
- "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription."
+ "description": "Subscription description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"end_date": {
"anyOf": [
{
+ "format": "unix-time",
"type": "integer"
},
{
@@ -126014,6 +128548,7 @@
"start_date": {
"anyOf": [
{
+ "format": "unix-time",
"type": "integer"
},
{
@@ -126051,6 +128586,7 @@
"trial_end": {
"anyOf": [
{
+ "format": "unix-time",
"type": "integer"
},
{
@@ -126851,7 +129387,7 @@
"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."
},
"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.",
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.",
"maxLength": 500,
"type": "string"
},
@@ -128187,7 +130723,7 @@
"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."
+ "description": "The subscription's description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs."
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
@@ -129208,7 +131744,7 @@
"type": "string"
},
"tax_ids": {
- "description": "The customer's tax IDs.",
+ "description": "The customer's tax IDs. Stripe Tax might consider a transaction with applicable tax IDs to be B2B, which might affect the tax calculation result. Stripe Tax doesn't validate tax IDs for correctness.",
"items": {
"properties": {
"type": {
@@ -129567,509 +132103,10 @@
}
}
},
- "/v1/tax/settings": {
+ "/v1/tax/registrations": {
"get": {
- "description": "Retrieves Tax Settings for a merchant.
",
- "operationId": "GetTaxSettings",
- "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"
- }
- ],
- "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/tax.settings"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- },
- "post": {
- "description": "Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
",
- "operationId": "PostTaxSettings",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "defaults": {
- "explode": true,
- "style": "deepObject"
- },
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "head_office": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "defaults": {
- "description": "Default configuration to be used on Stripe Tax calculations.",
- "properties": {
- "tax_behavior": {
- "description": "Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.",
- "enum": [
- "exclusive",
- "inclusive",
- "inferred_by_currency"
- ],
- "type": "string"
- },
- "tax_code": {
- "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
- "type": "string"
- }
- },
- "title": "defaults_param",
- "type": "object"
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "head_office": {
- "description": "The place where your business is located.",
- "properties": {
- "address": {
- "description": "The location of the business for tax purposes.",
- "properties": {
- "city": {
- "description": "City, district, suburb, town, or village.",
- "maxLength": 5000,
- "type": "string"
- },
- "country": {
- "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
- "maxLength": 5000,
- "type": "string"
- },
- "line1": {
- "description": "Address line 1 (e.g., street, PO Box, or company name).",
- "maxLength": 5000,
- "type": "string"
- },
- "line2": {
- "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
- "maxLength": 5000,
- "type": "string"
- },
- "postal_code": {
- "description": "ZIP or postal code.",
- "maxLength": 5000,
- "type": "string"
- },
- "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"
- }
- },
- "title": "validated_country_address",
- "type": "object"
- }
- },
- "required": [
- "address"
- ],
- "title": "head_office_param",
- "type": "object"
- }
- },
- "type": "object"
- }
- }
- },
- "required": false
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/tax.settings"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax/transactions/create_from_calculation": {
- "post": {
- "description": "Creates a Tax Transaction from a calculation.
",
- "operationId": "PostTaxTransactionsCreateFromCalculation",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- }
- },
- "schema": {
- "additionalProperties": false,
- "properties": {
- "calculation": {
- "description": "Tax Calculation ID to be used as input when creating the transaction.",
- "maxLength": 5000,
- "type": "string"
- },
- "expand": {
- "description": "Specifies which fields in the response should be expanded.",
- "items": {
- "maxLength": 5000,
- "type": "string"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "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"
- },
- "reference": {
- "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.",
- "maxLength": 500,
- "type": "string"
- }
- },
- "required": [
- "calculation",
- "reference"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/tax.transaction"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax/transactions/create_reversal": {
- "post": {
- "description": "Partially or fully reverses a previously created Transaction.
",
- "operationId": "PostTaxTransactionsCreateReversal",
- "requestBody": {
- "content": {
- "application/x-www-form-urlencoded": {
- "encoding": {
- "expand": {
- "explode": true,
- "style": "deepObject"
- },
- "line_items": {
- "explode": true,
- "style": "deepObject"
- },
- "metadata": {
- "explode": true,
- "style": "deepObject"
- },
- "shipping_cost": {
- "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"
- },
- "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": {
- "properties": {
- "amount": {
- "description": "The amount to reverse, in negative integer cents.",
- "type": "integer"
- },
- "amount_tax": {
- "description": "The amount of tax to reverse, in negative integer cents.",
- "type": "integer"
- },
- "metadata": {
- "additionalProperties": {
- "type": "string"
- },
- "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
- "type": "object"
- },
- "original_line_item": {
- "description": "The `id` of the line item to reverse in the original transaction.",
- "maxLength": 5000,
- "type": "string"
- },
- "quantity": {
- "description": "The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.",
- "type": "integer"
- },
- "reference": {
- "description": "A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.",
- "maxLength": 500,
- "type": "string"
- }
- },
- "required": [
- "amount",
- "amount_tax",
- "original_line_item",
- "reference"
- ],
- "title": "transaction_line_item_reversal",
- "type": "object"
- },
- "type": "array"
- },
- "metadata": {
- "additionalProperties": {
- "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"
- },
- "mode": {
- "description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.",
- "enum": [
- "full",
- "partial"
- ],
- "type": "string"
- },
- "original_transaction": {
- "description": "The ID of the Transaction to partially or fully reverse.",
- "maxLength": 5000,
- "type": "string"
- },
- "reference": {
- "description": "A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).",
- "maxLength": 500,
- "type": "string"
- },
- "shipping_cost": {
- "description": "The shipping cost to reverse.",
- "properties": {
- "amount": {
- "description": "The amount to reverse, in negative integer cents.",
- "type": "integer"
- },
- "amount_tax": {
- "description": "The amount of tax to reverse, in negative integer cents.",
- "type": "integer"
- }
- },
- "required": [
- "amount",
- "amount_tax"
- ],
- "title": "transaction_shipping_cost_reversal",
- "type": "object"
- }
- },
- "required": [
- "mode",
- "original_transaction",
- "reference"
- ],
- "type": "object"
- }
- }
- },
- "required": true
- },
- "responses": {
- "200": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/tax.transaction"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax/transactions/{transaction}": {
- "get": {
- "description": "Retrieves a Tax Transaction object.
",
- "operationId": "GetTaxTransactionsTransaction",
- "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": "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/tax.transaction"
- }
- }
- },
- "description": "Successful response."
- },
- "default": {
- "content": {
- "application/json": {
- "schema": {
- "$ref": "#/components/schemas/error"
- }
- }
- },
- "description": "Error response."
- }
- }
- }
- },
- "/v1/tax/transactions/{transaction}/line_items": {
- "get": {
- "description": "Retrieves the line items of a committed standalone transaction as a collection.
",
- "operationId": "GetTaxTransactionsTransactionLineItems",
+ "description": "Returns a list of Tax Registration objects.
",
+ "operationId": "GetTaxRegistrations",
"parameters": [
{
"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.",
@@ -130077,7 +132114,2316 @@
"name": "ending_before",
"required": false,
"schema": {
- "maxLength": 500,
+ "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": "The status of the Tax Registration.",
+ "in": "query",
+ "name": "status",
+ "required": false,
+ "schema": {
+ "enum": [
+ "active",
+ "all",
+ "expired",
+ "scheduled"
+ ],
+ "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/tax.registration"
+ },
+ "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/tax/registrations",
+ "type": "string"
+ }
+ },
+ "required": [
+ "data",
+ "has_more",
+ "object",
+ "url"
+ ],
+ "title": "TaxProductRegistrationsResourceTaxRegistrationList",
+ "type": "object",
+ "x-expandableFields": [
+ "data"
+ ]
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Creates a new Tax Registration object.
",
+ "operationId": "PostTaxRegistrations",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "active_from": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "country_options": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "active_from": {
+ "anyOf": [
+ {
+ "enum": [
+ "now"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "format": "unix-time",
+ "type": "integer"
+ }
+ ],
+ "description": "Time at which the Tax Registration becomes active. It can be either `now` to indicate the current time, or a future timestamp measured in seconds since the Unix epoch."
+ },
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country_options": {
+ "description": "Specific options for a registration in the specified `country`.",
+ "properties": {
+ "ae": {
+ "description": "Options for the registration in AE.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "at": {
+ "description": "Options for the registration in AT.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "au": {
+ "description": "Options for the registration in AU.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "be": {
+ "description": "Options for the registration in BE.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "bg": {
+ "description": "Options for the registration in BG.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "ca": {
+ "description": "Options for the registration in CA.",
+ "properties": {
+ "province_standard": {
+ "description": "Options for the provincial tax registration.",
+ "properties": {
+ "province": {
+ "description": "Two-letter CA province code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "province"
+ ],
+ "title": "province_standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in Canada.",
+ "enum": [
+ "province_standard",
+ "simplified",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "canada",
+ "type": "object"
+ },
+ "ch": {
+ "description": "Options for the registration in CH.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "cl": {
+ "description": "Options for the registration in CL.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "co": {
+ "description": "Options for the registration in CO.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "cy": {
+ "description": "Options for the registration in CY.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "cz": {
+ "description": "Options for the registration in CZ.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "de": {
+ "description": "Options for the registration in DE.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "dk": {
+ "description": "Options for the registration in DK.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "ee": {
+ "description": "Options for the registration in EE.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "es": {
+ "description": "Options for the registration in ES.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "fi": {
+ "description": "Options for the registration in FI.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "fr": {
+ "description": "Options for the registration in FR.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "gb": {
+ "description": "Options for the registration in GB.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "gr": {
+ "description": "Options for the registration in GR.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "hr": {
+ "description": "Options for the registration in HR.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "hu": {
+ "description": "Options for the registration in HU.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "id": {
+ "description": "Options for the registration in ID.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "ie": {
+ "description": "Options for the registration in IE.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "is": {
+ "description": "Options for the registration in IS.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "it": {
+ "description": "Options for the registration in IT.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "jp": {
+ "description": "Options for the registration in JP.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "kr": {
+ "description": "Options for the registration in KR.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "lt": {
+ "description": "Options for the registration in LT.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "lu": {
+ "description": "Options for the registration in LU.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "lv": {
+ "description": "Options for the registration in LV.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "mt": {
+ "description": "Options for the registration in MT.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "mx": {
+ "description": "Options for the registration in MX.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "my": {
+ "description": "Options for the registration in MY.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "nl": {
+ "description": "Options for the registration in NL.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "no": {
+ "description": "Options for the registration in NO.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "nz": {
+ "description": "Options for the registration in NZ.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "pl": {
+ "description": "Options for the registration in PL.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "pt": {
+ "description": "Options for the registration in PT.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "ro": {
+ "description": "Options for the registration in RO.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "sa": {
+ "description": "Options for the registration in SA.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "se": {
+ "description": "Options for the registration in SE.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "sg": {
+ "description": "Options for the registration in SG.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ },
+ "si": {
+ "description": "Options for the registration in SI.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "sk": {
+ "description": "Options for the registration in SK.",
+ "properties": {
+ "standard": {
+ "description": "Options for the standard registration.",
+ "properties": {
+ "place_of_supply_scheme": {
+ "description": "Place of supply scheme used in an EU standard registration.",
+ "enum": [
+ "small_seller",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "place_of_supply_scheme"
+ ],
+ "title": "standard",
+ "type": "object"
+ },
+ "type": {
+ "description": "Type of registration to be created in an EU country.",
+ "enum": [
+ "ioss",
+ "oss_non_union",
+ "oss_union",
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "europe",
+ "type": "object"
+ },
+ "th": {
+ "description": "Options for the registration in TH.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "tr": {
+ "description": "Options for the registration in TR.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "us": {
+ "description": "Options for the registration in US.",
+ "properties": {
+ "local_amusement_tax": {
+ "description": "Options for the local amusement tax registration.",
+ "properties": {
+ "jurisdiction": {
+ "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago), `06613` (Bloomington), `21696` (East Dundee), `24582` (Evanston), and `68081` (Schiller Park).",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "jurisdiction"
+ ],
+ "title": "local_amusement_tax",
+ "type": "object"
+ },
+ "local_lease_tax": {
+ "description": "Options for the local lease tax registration.",
+ "properties": {
+ "jurisdiction": {
+ "description": "A [FIPS code](https://www.census.gov/library/reference/code-lists/ansi.html) representing the local jurisdiction. Supported FIPS codes are: `14000` (Chicago).",
+ "maxLength": 5000,
+ "type": "string"
+ }
+ },
+ "required": [
+ "jurisdiction"
+ ],
+ "title": "local_lease_tax",
+ "type": "object"
+ },
+ "state": {
+ "description": "Two-letter US state code ([ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": {
+ "description": "Type of registration to be created in the US.",
+ "enum": [
+ "local_amusement_tax",
+ "local_lease_tax",
+ "state_communications_tax",
+ "state_sales_tax"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "state",
+ "type"
+ ],
+ "title": "united_states",
+ "type": "object"
+ },
+ "vn": {
+ "description": "Options for the registration in VN.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "simplified"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "simplified",
+ "type": "object"
+ },
+ "za": {
+ "description": "Options for the registration in ZA.",
+ "properties": {
+ "type": {
+ "description": "Type of registration to be created in `country`.",
+ "enum": [
+ "standard"
+ ],
+ "type": "string"
+ }
+ },
+ "required": [
+ "type"
+ ],
+ "title": "default",
+ "type": "object"
+ }
+ },
+ "title": "country_options",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expires_at": {
+ "description": "If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.",
+ "format": "unix-time",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "active_from",
+ "country",
+ "country_options"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax.registration"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/registrations/{id}": {
+ "post": {
+ "description": "Updates an existing Tax Registration object.
\n\nA registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.
",
+ "operationId": "PostTaxRegistrationsId",
+ "parameters": [
+ {
+ "in": "path",
+ "name": "id",
+ "required": true,
+ "schema": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "style": "simple"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "active_from": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expires_at": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "active_from": {
+ "anyOf": [
+ {
+ "enum": [
+ "now"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "format": "unix-time",
+ "type": "integer"
+ }
+ ],
+ "description": "Time at which the registration becomes active. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch."
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "expires_at": {
+ "anyOf": [
+ {
+ "enum": [
+ "now"
+ ],
+ "maxLength": 5000,
+ "type": "string"
+ },
+ {
+ "format": "unix-time",
+ "type": "integer"
+ },
+ {
+ "enum": [
+ ""
+ ],
+ "type": "string"
+ }
+ ],
+ "description": "If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either `now` to indicate the current time, or a timestamp measured in seconds since the Unix epoch."
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax.registration"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/settings": {
+ "get": {
+ "description": "Retrieves Tax Settings for a merchant.
",
+ "operationId": "GetTaxSettings",
+ "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"
+ }
+ ],
+ "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/tax.settings"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ },
+ "post": {
+ "description": "Updates Tax Settings parameters used in tax calculations. All parameters are editable but none can be removed once set.
",
+ "operationId": "PostTaxSettings",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "defaults": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "head_office": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "defaults": {
+ "description": "Default configuration to be used on Stripe Tax calculations.",
+ "properties": {
+ "tax_behavior": {
+ "description": "Specifies the default [tax behavior](https://stripe.com/docs/tax/products-prices-tax-categories-tax-behavior#tax-behavior) to be used when the item's price has unspecified tax behavior. One of inclusive, exclusive, or inferred_by_currency. Once specified, it cannot be changed back to null.",
+ "enum": [
+ "exclusive",
+ "inclusive",
+ "inferred_by_currency"
+ ],
+ "type": "string"
+ },
+ "tax_code": {
+ "description": "A [tax code](https://stripe.com/docs/tax/tax-categories) ID.",
+ "type": "string"
+ }
+ },
+ "title": "defaults_param",
+ "type": "object"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "head_office": {
+ "description": "The place where your business is located.",
+ "properties": {
+ "address": {
+ "description": "The location of the business for tax purposes.",
+ "properties": {
+ "city": {
+ "description": "City, district, suburb, town, or village.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "country": {
+ "description": "Two-letter country code ([ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2)).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line1": {
+ "description": "Address line 1 (e.g., street, PO Box, or company name).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "line2": {
+ "description": "Address line 2 (e.g., apartment, suite, unit, or building).",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "postal_code": {
+ "description": "ZIP or postal code.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "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"
+ }
+ },
+ "title": "validated_country_address",
+ "type": "object"
+ }
+ },
+ "required": [
+ "address"
+ ],
+ "title": "head_office_param",
+ "type": "object"
+ }
+ },
+ "type": "object"
+ }
+ }
+ },
+ "required": false
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax.settings"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/transactions/create_from_calculation": {
+ "post": {
+ "description": "Creates a Tax Transaction from a calculation.
",
+ "operationId": "PostTaxTransactionsCreateFromCalculation",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ }
+ },
+ "schema": {
+ "additionalProperties": false,
+ "properties": {
+ "calculation": {
+ "description": "Tax Calculation ID to be used as input when creating the transaction.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "expand": {
+ "description": "Specifies which fields in the response should be expanded.",
+ "items": {
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "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"
+ },
+ "reference": {
+ "description": "A custom order or sale identifier, such as 'myOrder_123'. Must be unique across all transactions, including reversals.",
+ "maxLength": 500,
+ "type": "string"
+ }
+ },
+ "required": [
+ "calculation",
+ "reference"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax.transaction"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/transactions/create_reversal": {
+ "post": {
+ "description": "Partially or fully reverses a previously created Transaction.
",
+ "operationId": "PostTaxTransactionsCreateReversal",
+ "requestBody": {
+ "content": {
+ "application/x-www-form-urlencoded": {
+ "encoding": {
+ "expand": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "line_items": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "metadata": {
+ "explode": true,
+ "style": "deepObject"
+ },
+ "shipping_cost": {
+ "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"
+ },
+ "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": {
+ "properties": {
+ "amount": {
+ "description": "The amount to reverse, in negative integer cents.",
+ "type": "integer"
+ },
+ "amount_tax": {
+ "description": "The amount of tax to reverse, in negative integer cents.",
+ "type": "integer"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "type": "string"
+ },
+ "description": "Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.",
+ "type": "object"
+ },
+ "original_line_item": {
+ "description": "The `id` of the line item to reverse in the original transaction.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "quantity": {
+ "description": "The quantity reversed. Appears in [tax exports](https://stripe.com/docs/tax/reports), but does not affect the amount of tax reversed.",
+ "type": "integer"
+ },
+ "reference": {
+ "description": "A custom identifier for this line item in the reversal transaction, such as 'L1-refund'.",
+ "maxLength": 500,
+ "type": "string"
+ }
+ },
+ "required": [
+ "amount",
+ "amount_tax",
+ "original_line_item",
+ "reference"
+ ],
+ "title": "transaction_line_item_reversal",
+ "type": "object"
+ },
+ "type": "array"
+ },
+ "metadata": {
+ "additionalProperties": {
+ "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"
+ },
+ "mode": {
+ "description": "If `partial`, the provided line item or shipping cost amounts are reversed. If `full`, the original transaction is fully reversed.",
+ "enum": [
+ "full",
+ "partial"
+ ],
+ "type": "string"
+ },
+ "original_transaction": {
+ "description": "The ID of the Transaction to partially or fully reverse.",
+ "maxLength": 5000,
+ "type": "string"
+ },
+ "reference": {
+ "description": "A custom identifier for this reversal, such as `myOrder_123-refund_1`, which must be unique across all transactions. The reference helps identify this reversal transaction in exported [tax reports](https://stripe.com/docs/tax/reports).",
+ "maxLength": 500,
+ "type": "string"
+ },
+ "shipping_cost": {
+ "description": "The shipping cost to reverse.",
+ "properties": {
+ "amount": {
+ "description": "The amount to reverse, in negative integer cents.",
+ "type": "integer"
+ },
+ "amount_tax": {
+ "description": "The amount of tax to reverse, in negative integer cents.",
+ "type": "integer"
+ }
+ },
+ "required": [
+ "amount",
+ "amount_tax"
+ ],
+ "title": "transaction_shipping_cost_reversal",
+ "type": "object"
+ }
+ },
+ "required": [
+ "mode",
+ "original_transaction",
+ "reference"
+ ],
+ "type": "object"
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "200": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/tax.transaction"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/transactions/{transaction}": {
+ "get": {
+ "description": "Retrieves a Tax Transaction object.
",
+ "operationId": "GetTaxTransactionsTransaction",
+ "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": "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/tax.transaction"
+ }
+ }
+ },
+ "description": "Successful response."
+ },
+ "default": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/error"
+ }
+ }
+ },
+ "description": "Error response."
+ }
+ }
+ }
+ },
+ "/v1/tax/transactions/{transaction}/line_items": {
+ "get": {
+ "description": "Retrieves the line items of a committed standalone transaction as a collection.
",
+ "operationId": "GetTaxTransactionsTransactionLineItems",
+ "parameters": [
+ {
+ "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": 500,
"type": "string"
},
"style": "form"
@@ -133930,7 +138276,7 @@
"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).",
+ "description": "The total amount to attempt to authorize. This amount is in the provided currency, or defaults to the card's currency, and in the [smallest currency unit](https://stripe.com/docs/currencies#zero-decimal).",
"type": "integer"
},
"amount_details": {
@@ -134318,6 +138664,11 @@
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
"type": "string"
+ },
+ "url": {
+ "description": "URL provided by the merchant on a 3DS request",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "merchant_data_specs",
@@ -134356,6 +138707,34 @@
],
"type": "string"
},
+ "authentication_exemption": {
+ "description": "The exemption applied to this authorization.",
+ "properties": {
+ "claimed_by": {
+ "description": "The entity that requested the exemption, either the acquiring merchant or the Issuing user.",
+ "enum": [
+ "acquirer",
+ "issuer"
+ ],
+ "type": "string"
+ },
+ "type": {
+ "description": "The specific exemption claimed for this authorization.",
+ "enum": [
+ "low_value_transaction",
+ "transaction_risk_analysis"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "claimed_by",
+ "type"
+ ],
+ "title": "authentication_exemption_specs",
+ "type": "object"
+ },
"cvc_check": {
"description": "Whether the cardholder provided a CVC and if it matched Stripe’s record.",
"enum": [
@@ -134373,6 +138752,27 @@
"not_provided"
],
"type": "string"
+ },
+ "three_d_secure": {
+ "description": "3D Secure details.",
+ "properties": {
+ "result": {
+ "description": "The outcome of the 3D Secure authentication request.",
+ "enum": [
+ "attempt_acknowledged",
+ "authenticated",
+ "failed",
+ "required"
+ ],
+ "type": "string",
+ "x-stripeBypassValidation": true
+ }
+ },
+ "required": [
+ "result"
+ ],
+ "title": "three_d_secure_specs",
+ "type": "object"
}
},
"title": "verification_data_specs",
@@ -135523,6 +139923,11 @@
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
"type": "string"
+ },
+ "url": {
+ "description": "URL provided by the merchant on a 3DS request",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "merchant_data_specs",
@@ -136101,6 +140506,11 @@
"description": "An ID assigned by the seller to the location of the sale.",
"maxLength": 5000,
"type": "string"
+ },
+ "url": {
+ "description": "URL provided by the merchant on a 3DS request",
+ "maxLength": 5000,
+ "type": "string"
}
},
"title": "merchant_data_specs",
@@ -143286,7 +147696,7 @@
"type": "object"
},
"statement_descriptor": {
- "description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `wire` payments, or 500 characters for `stripe` network transfers. The default value is `payment`.",
+ "description": "The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for `ach` payments, 140 characters for `us_domestic_wire` payments, or 500 characters for `stripe` network transfers. The default value is \"payment\".",
"maxLength": 5000,
"type": "string"
}
@@ -143706,7 +148116,7 @@
"type": "object"
},
"statement_descriptor": {
- "description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `wire` transfers. The default value is `transfer`.",
+ "description": "Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for `ach` transfers or 140 characters for `us_domestic_wire` transfers. The default value is \"transfer\".",
"maxLength": 5000,
"type": "string"
}
@@ -145279,6 +149689,13 @@
"checkout.session.async_payment_succeeded",
"checkout.session.completed",
"checkout.session.expired",
+ "climate.order.canceled",
+ "climate.order.created",
+ "climate.order.delayed",
+ "climate.order.delivered",
+ "climate.order.product_substituted",
+ "climate.product.created",
+ "climate.product.pricing_updated",
"coupon.created",
"coupon.deleted",
"coupon.updated",
@@ -145747,6 +150164,13 @@
"checkout.session.async_payment_succeeded",
"checkout.session.completed",
"checkout.session.expired",
+ "climate.order.canceled",
+ "climate.order.created",
+ "climate.order.delayed",
+ "climate.order.delivered",
+ "climate.order.product_substituted",
+ "climate.product.created",
+ "climate.product.pricing_updated",
"coupon.created",
"coupon.deleted",
"coupon.updated",
diff --git a/pkg/cmd/resources_cmds.go b/pkg/cmd/resources_cmds.go
index 61fde6a56..dcb707872 100644
--- a/pkg/cmd/resources_cmds.go
+++ b/pkg/cmd/resources_cmds.go
@@ -16,6 +16,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
nsAppsCmd := resource.NewNamespaceCmd(rootCmd, "apps")
nsBillingPortalCmd := resource.NewNamespaceCmd(rootCmd, "billing_portal")
nsCheckoutCmd := resource.NewNamespaceCmd(rootCmd, "checkout")
+ nsClimateCmd := resource.NewNamespaceCmd(rootCmd, "climate")
nsFinancialConnectionsCmd := resource.NewNamespaceCmd(rootCmd, "financial_connections")
nsIdentityCmd := resource.NewNamespaceCmd(rootCmd, "identity")
nsIssuingCmd := resource.NewNamespaceCmd(rootCmd, "issuing")
@@ -98,6 +99,9 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
rBillingPortalConfigurationsCmd := resource.NewResourceCmd(nsBillingPortalCmd.Cmd, "configurations")
rBillingPortalSessionsCmd := resource.NewResourceCmd(nsBillingPortalCmd.Cmd, "sessions")
rCheckoutSessionsCmd := resource.NewResourceCmd(nsCheckoutCmd.Cmd, "sessions")
+ rClimateOrdersCmd := resource.NewResourceCmd(nsClimateCmd.Cmd, "orders")
+ rClimateProductsCmd := resource.NewResourceCmd(nsClimateCmd.Cmd, "products")
+ rClimateSuppliersCmd := resource.NewResourceCmd(nsClimateCmd.Cmd, "suppliers")
rFinancialConnectionsAccountsCmd := resource.NewResourceCmd(nsFinancialConnectionsCmd.Cmd, "accounts")
rFinancialConnectionsSessionsCmd := resource.NewResourceCmd(nsFinancialConnectionsCmd.Cmd, "sessions")
rIdentityVerificationReportsCmd := resource.NewResourceCmd(nsIdentityCmd.Cmd, "verification_reports")
@@ -117,6 +121,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
rReportingReportRunsCmd := resource.NewResourceCmd(nsReportingCmd.Cmd, "report_runs")
rReportingReportTypesCmd := resource.NewResourceCmd(nsReportingCmd.Cmd, "report_types")
rTaxCalculationsCmd := resource.NewResourceCmd(nsTaxCmd.Cmd, "calculations")
+ rTaxRegistrationsCmd := resource.NewResourceCmd(nsTaxCmd.Cmd, "registrations")
rTaxSettingssCmd := resource.NewResourceCmd(nsTaxCmd.Cmd, "settingss")
rTaxTransactionsCmd := resource.NewResourceCmd(nsTaxCmd.Cmd, "transactions")
rTerminalConfigurationsCmd := resource.NewResourceCmd(nsTerminalCmd.Cmd, "configurations")
@@ -164,8 +169,20 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"type": "string",
}, &Config)
resource.NewOperationCmd(rAccountSessionsCmd.Cmd, "create", "/v1/account_sessions", http.MethodPost, map[string]string{
- "account": "string",
- "components.account_onboarding.enabled": "boolean",
+ "account": "string",
+ "components.account_onboarding.enabled": "boolean",
+ "components.payment_details.enabled": "boolean",
+ "components.payment_details.features.capture_payments": "boolean",
+ "components.payment_details.features.dispute_management": "boolean",
+ "components.payment_details.features.refund_management": "boolean",
+ "components.payments.enabled": "boolean",
+ "components.payments.features.capture_payments": "boolean",
+ "components.payments.features.dispute_management": "boolean",
+ "components.payments.features.refund_management": "boolean",
+ "components.payouts.enabled": "boolean",
+ "components.payouts.features.edit_payout_schedule": "boolean",
+ "components.payouts.features.instant_payouts": "boolean",
+ "components.payouts.features.standard_payouts": "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{
@@ -214,6 +231,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"capabilities.p24_payments.requested": "boolean",
"capabilities.paynow_payments.requested": "boolean",
"capabilities.promptpay_payments.requested": "boolean",
+ "capabilities.revolut_pay_payments.requested": "boolean",
"capabilities.sepa_debit_payments.requested": "boolean",
"capabilities.sofort_payments.requested": "boolean",
"capabilities.tax_reporting_us_1099_k.requested": "boolean",
@@ -317,6 +335,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"individual.verification.additional_document.front": "string",
"individual.verification.document.back": "string",
"individual.verification.document.front": "string",
+ "settings.bacs_debit_payments.display_name": "string",
"settings.branding.icon": "string",
"settings.branding.logo": "string",
"settings.branding.primary_color": "string",
@@ -409,6 +428,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"capabilities.p24_payments.requested": "boolean",
"capabilities.paynow_payments.requested": "boolean",
"capabilities.promptpay_payments.requested": "boolean",
+ "capabilities.revolut_pay_payments.requested": "boolean",
"capabilities.sepa_debit_payments.requested": "boolean",
"capabilities.sofort_payments.requested": "boolean",
"capabilities.tax_reporting_us_1099_k.requested": "boolean",
@@ -511,6 +531,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"individual.verification.additional_document.front": "string",
"individual.verification.document.back": "string",
"individual.verification.document.front": "string",
+ "settings.bacs_debit_payments.display_name": "string",
"settings.branding.icon": "string",
"settings.branding.logo": "string",
"settings.branding.primary_color": "string",
@@ -826,6 +847,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"promotion_code": "string",
"source": "string",
"tax.ip_address": "string",
+ "tax.validate_location": "string",
"tax_exempt": "string",
"test_clock": "string",
"validate": "boolean",
@@ -877,6 +899,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"promotion_code": "string",
"source": "string",
"tax.ip_address": "string",
+ "tax.validate_location": "string",
"tax_exempt": "string",
"validate": "boolean",
}, &Config)
@@ -1209,6 +1232,25 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"limit": "integer",
"starting_after": "string",
}, &Config)
+ resource.NewOperationCmd(rLineItemsCmd.Cmd, "update", "/v1/invoices/{invoice}/lines/{line_item_id}", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "description": "string",
+ "discountable": "boolean",
+ "period.end": "integer",
+ "period.start": "integer",
+ "price": "string",
+ "price_data.currency": "string",
+ "price_data.product": "string",
+ "price_data.product_data.description": "string",
+ "price_data.product_data.images": "array",
+ "price_data.product_data.name": "string",
+ "price_data.product_data.tax_code": "string",
+ "price_data.tax_behavior": "string",
+ "price_data.unit_amount": "integer",
+ "price_data.unit_amount_decimal": "string",
+ "quantity": "integer",
+ "tax_rates": "array",
+ }, &Config)
resource.NewOperationCmd(rLoginLinksCmd.Cmd, "create", "/v1/accounts/{account}/login_links", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rMandatesCmd.Cmd, "retrieve", "/v1/mandates/{mandate}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rPaymentIntentsCmd.Cmd, "apply_customer_balance", "/v1/payment_intents/{intent}/apply_customer_balance", http.MethodPost, map[string]string{
@@ -1405,37 +1447,43 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"descriptor_code": "string",
}, &Config)
resource.NewOperationCmd(rPaymentLinksCmd.Cmd, "create", "/v1/payment_links", http.MethodPost, map[string]string{
- "after_completion.hosted_confirmation.custom_message": "string",
- "after_completion.redirect.url": "string",
- "after_completion.type": "string",
- "allow_promotion_codes": "boolean",
- "application_fee_amount": "integer",
- "application_fee_percent": "number",
- "automatic_tax.enabled": "boolean",
- "billing_address_collection": "string",
- "consent_collection.promotions": "string",
- "consent_collection.terms_of_service": "string",
- "currency": "string",
- "customer_creation": "string",
- "invoice_creation.enabled": "boolean",
- "invoice_creation.invoice_data.account_tax_ids": "array",
- "invoice_creation.invoice_data.description": "string",
- "invoice_creation.invoice_data.footer": "string",
- "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",
- "shipping_address_collection.allowed_countries": "array",
- "submit_type": "string",
- "subscription_data.description": "string",
- "subscription_data.trial_period_days": "integer",
- "tax_id_collection.enabled": "boolean",
- "transfer_data.amount": "integer",
- "transfer_data.destination": "string",
+ "after_completion.hosted_confirmation.custom_message": "string",
+ "after_completion.redirect.url": "string",
+ "after_completion.type": "string",
+ "allow_promotion_codes": "boolean",
+ "application_fee_amount": "integer",
+ "application_fee_percent": "number",
+ "automatic_tax.enabled": "boolean",
+ "billing_address_collection": "string",
+ "consent_collection.payment_method_reuse_agreement.position": "string",
+ "consent_collection.promotions": "string",
+ "consent_collection.terms_of_service": "string",
+ "currency": "string",
+ "customer_creation": "string",
+ "inactive_message": "string",
+ "invoice_creation.enabled": "boolean",
+ "invoice_creation.invoice_data.account_tax_ids": "array",
+ "invoice_creation.invoice_data.description": "string",
+ "invoice_creation.invoice_data.footer": "string",
+ "on_behalf_of": "string",
+ "payment_intent_data.capture_method": "string",
+ "payment_intent_data.description": "string",
+ "payment_intent_data.setup_future_usage": "string",
+ "payment_intent_data.statement_descriptor": "string",
+ "payment_intent_data.statement_descriptor_suffix": "string",
+ "payment_intent_data.transfer_group": "string",
+ "payment_method_collection": "string",
+ "payment_method_types": "array",
+ "phone_number_collection.enabled": "boolean",
+ "restrictions.completed_sessions.limit": "integer",
+ "shipping_address_collection.allowed_countries": "array",
+ "submit_type": "string",
+ "subscription_data.description": "string",
+ "subscription_data.trial_period_days": "integer",
+ "subscription_data.trial_settings.end_behavior.missing_payment_method": "string",
+ "tax_id_collection.enabled": "boolean",
+ "transfer_data.amount": "integer",
+ "transfer_data.destination": "string",
}, &Config)
resource.NewOperationCmd(rPaymentLinksCmd.Cmd, "list", "/v1/payment_links", http.MethodGet, map[string]string{
"active": "boolean",
@@ -1458,12 +1506,15 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"automatic_tax.enabled": "boolean",
"billing_address_collection": "string",
"customer_creation": "string",
+ "inactive_message": "string",
"invoice_creation.enabled": "boolean",
"invoice_creation.invoice_data.account_tax_ids": "array",
"invoice_creation.invoice_data.description": "string",
"invoice_creation.invoice_data.footer": "string",
+ "payment_intent_data.description": "string",
"payment_intent_data.statement_descriptor": "string",
"payment_intent_data.statement_descriptor_suffix": "string",
+ "payment_intent_data.transfer_group": "string",
"payment_method_collection": "string",
"payment_method_types": "array",
}, &Config)
@@ -1499,6 +1550,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"paynow.display_preference.preference": "string",
"paypal.display_preference.preference": "string",
"promptpay.display_preference.preference": "string",
+ "revolut_pay.display_preference.preference": "string",
"sepa_debit.display_preference.preference": "string",
"sofort.display_preference.preference": "string",
"us_bank_account.display_preference.preference": "string",
@@ -1540,6 +1592,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"paynow.display_preference.preference": "string",
"paypal.display_preference.preference": "string",
"promptpay.display_preference.preference": "string",
+ "revolut_pay.display_preference.preference": "string",
"sepa_debit.display_preference.preference": "string",
"sofort.display_preference.preference": "string",
"us_bank_account.display_preference.preference": "string",
@@ -2055,61 +2108,70 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "confirm", "/v1/setup_intents/{intent}/confirm", http.MethodPost, map[string]string{
"payment_method": "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",
- "payment_method_data.au_becs_debit.account_number": "string",
- "payment_method_data.au_becs_debit.bsb_number": "string",
- "payment_method_data.bacs_debit.account_number": "string",
- "payment_method_data.bacs_debit.sort_code": "string",
- "payment_method_data.billing_details.email": "string",
- "payment_method_data.billing_details.name": "string",
- "payment_method_data.billing_details.phone": "string",
- "payment_method_data.boleto.tax_id": "string",
- "payment_method_data.eps.bank": "string",
- "payment_method_data.fpx.account_holder_type": "string",
- "payment_method_data.fpx.bank": "string",
- "payment_method_data.ideal.bank": "string",
- "payment_method_data.klarna.dob.day": "integer",
- "payment_method_data.klarna.dob.month": "integer",
- "payment_method_data.klarna.dob.year": "integer",
- "payment_method_data.p24.bank": "string",
- "payment_method_data.radar_options.session": "string",
- "payment_method_data.sepa_debit.iban": "string",
- "payment_method_data.sofort.country": "string",
- "payment_method_data.type": "string",
- "payment_method_data.us_bank_account.account_holder_type": "string",
- "payment_method_data.us_bank_account.account_number": "string",
- "payment_method_data.us_bank_account.account_type": "string",
- "payment_method_data.us_bank_account.financial_connections_account": "string",
- "payment_method_data.us_bank_account.routing_number": "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",
- "payment_method_options.acss_debit.mandate_options.interval_description": "string",
- "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.card.mandate_options.amount": "integer",
- "payment_method_options.card.mandate_options.amount_type": "string",
- "payment_method_options.card.mandate_options.currency": "string",
- "payment_method_options.card.mandate_options.description": "string",
- "payment_method_options.card.mandate_options.end_date": "integer",
- "payment_method_options.card.mandate_options.interval": "string",
- "payment_method_options.card.mandate_options.interval_count": "integer",
- "payment_method_options.card.mandate_options.reference": "string",
- "payment_method_options.card.mandate_options.start_date": "integer",
- "payment_method_options.card.mandate_options.supported_types": "array",
- "payment_method_options.card.moto": "boolean",
- "payment_method_options.card.network": "string",
- "payment_method_options.card.request_three_d_secure": "string",
- "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",
+ "payment_method_data.acss_debit.account_number": "string",
+ "payment_method_data.acss_debit.institution_number": "string",
+ "payment_method_data.acss_debit.transit_number": "string",
+ "payment_method_data.au_becs_debit.account_number": "string",
+ "payment_method_data.au_becs_debit.bsb_number": "string",
+ "payment_method_data.bacs_debit.account_number": "string",
+ "payment_method_data.bacs_debit.sort_code": "string",
+ "payment_method_data.billing_details.email": "string",
+ "payment_method_data.billing_details.name": "string",
+ "payment_method_data.billing_details.phone": "string",
+ "payment_method_data.boleto.tax_id": "string",
+ "payment_method_data.eps.bank": "string",
+ "payment_method_data.fpx.account_holder_type": "string",
+ "payment_method_data.fpx.bank": "string",
+ "payment_method_data.ideal.bank": "string",
+ "payment_method_data.klarna.dob.day": "integer",
+ "payment_method_data.klarna.dob.month": "integer",
+ "payment_method_data.klarna.dob.year": "integer",
+ "payment_method_data.p24.bank": "string",
+ "payment_method_data.radar_options.session": "string",
+ "payment_method_data.sepa_debit.iban": "string",
+ "payment_method_data.sofort.country": "string",
+ "payment_method_data.type": "string",
+ "payment_method_data.us_bank_account.account_holder_type": "string",
+ "payment_method_data.us_bank_account.account_number": "string",
+ "payment_method_data.us_bank_account.account_type": "string",
+ "payment_method_data.us_bank_account.financial_connections_account": "string",
+ "payment_method_data.us_bank_account.routing_number": "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",
+ "payment_method_options.acss_debit.mandate_options.interval_description": "string",
+ "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.card.mandate_options.amount": "integer",
+ "payment_method_options.card.mandate_options.amount_type": "string",
+ "payment_method_options.card.mandate_options.currency": "string",
+ "payment_method_options.card.mandate_options.description": "string",
+ "payment_method_options.card.mandate_options.end_date": "integer",
+ "payment_method_options.card.mandate_options.interval": "string",
+ "payment_method_options.card.mandate_options.interval_count": "integer",
+ "payment_method_options.card.mandate_options.reference": "string",
+ "payment_method_options.card.mandate_options.start_date": "integer",
+ "payment_method_options.card.mandate_options.supported_types": "array",
+ "payment_method_options.card.moto": "boolean",
+ "payment_method_options.card.network": "string",
+ "payment_method_options.card.request_three_d_secure": "string",
+ "payment_method_options.card.three_d_secure.ares_trans_status": "string",
+ "payment_method_options.card.three_d_secure.cryptogram": "string",
+ "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer",
+ "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string",
+ "payment_method_options.card.three_d_secure.transaction_id": "string",
+ "payment_method_options.card.three_d_secure.version": "string",
+ "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",
"return_url": "string",
"use_stripe_sdk": "boolean",
}, &Config)
@@ -2124,67 +2186,76 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"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",
- "payment_method_data.au_becs_debit.account_number": "string",
- "payment_method_data.au_becs_debit.bsb_number": "string",
- "payment_method_data.bacs_debit.account_number": "string",
- "payment_method_data.bacs_debit.sort_code": "string",
- "payment_method_data.billing_details.email": "string",
- "payment_method_data.billing_details.name": "string",
- "payment_method_data.billing_details.phone": "string",
- "payment_method_data.boleto.tax_id": "string",
- "payment_method_data.eps.bank": "string",
- "payment_method_data.fpx.account_holder_type": "string",
- "payment_method_data.fpx.bank": "string",
- "payment_method_data.ideal.bank": "string",
- "payment_method_data.klarna.dob.day": "integer",
- "payment_method_data.klarna.dob.month": "integer",
- "payment_method_data.klarna.dob.year": "integer",
- "payment_method_data.p24.bank": "string",
- "payment_method_data.radar_options.session": "string",
- "payment_method_data.sepa_debit.iban": "string",
- "payment_method_data.sofort.country": "string",
- "payment_method_data.type": "string",
- "payment_method_data.us_bank_account.account_holder_type": "string",
- "payment_method_data.us_bank_account.account_number": "string",
- "payment_method_data.us_bank_account.account_type": "string",
- "payment_method_data.us_bank_account.financial_connections_account": "string",
- "payment_method_data.us_bank_account.routing_number": "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",
- "payment_method_options.acss_debit.mandate_options.interval_description": "string",
- "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.card.mandate_options.amount": "integer",
- "payment_method_options.card.mandate_options.amount_type": "string",
- "payment_method_options.card.mandate_options.currency": "string",
- "payment_method_options.card.mandate_options.description": "string",
- "payment_method_options.card.mandate_options.end_date": "integer",
- "payment_method_options.card.mandate_options.interval": "string",
- "payment_method_options.card.mandate_options.interval_count": "integer",
- "payment_method_options.card.mandate_options.reference": "string",
- "payment_method_options.card.mandate_options.start_date": "integer",
- "payment_method_options.card.mandate_options.supported_types": "array",
- "payment_method_options.card.moto": "boolean",
- "payment_method_options.card.network": "string",
- "payment_method_options.card.request_three_d_secure": "string",
- "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",
- "payment_method_types": "array",
- "return_url": "string",
- "single_use.amount": "integer",
- "single_use.currency": "string",
- "usage": "string",
- "use_stripe_sdk": "boolean",
+ "payment_method_data.acss_debit.account_number": "string",
+ "payment_method_data.acss_debit.institution_number": "string",
+ "payment_method_data.acss_debit.transit_number": "string",
+ "payment_method_data.au_becs_debit.account_number": "string",
+ "payment_method_data.au_becs_debit.bsb_number": "string",
+ "payment_method_data.bacs_debit.account_number": "string",
+ "payment_method_data.bacs_debit.sort_code": "string",
+ "payment_method_data.billing_details.email": "string",
+ "payment_method_data.billing_details.name": "string",
+ "payment_method_data.billing_details.phone": "string",
+ "payment_method_data.boleto.tax_id": "string",
+ "payment_method_data.eps.bank": "string",
+ "payment_method_data.fpx.account_holder_type": "string",
+ "payment_method_data.fpx.bank": "string",
+ "payment_method_data.ideal.bank": "string",
+ "payment_method_data.klarna.dob.day": "integer",
+ "payment_method_data.klarna.dob.month": "integer",
+ "payment_method_data.klarna.dob.year": "integer",
+ "payment_method_data.p24.bank": "string",
+ "payment_method_data.radar_options.session": "string",
+ "payment_method_data.sepa_debit.iban": "string",
+ "payment_method_data.sofort.country": "string",
+ "payment_method_data.type": "string",
+ "payment_method_data.us_bank_account.account_holder_type": "string",
+ "payment_method_data.us_bank_account.account_number": "string",
+ "payment_method_data.us_bank_account.account_type": "string",
+ "payment_method_data.us_bank_account.financial_connections_account": "string",
+ "payment_method_data.us_bank_account.routing_number": "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",
+ "payment_method_options.acss_debit.mandate_options.interval_description": "string",
+ "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.card.mandate_options.amount": "integer",
+ "payment_method_options.card.mandate_options.amount_type": "string",
+ "payment_method_options.card.mandate_options.currency": "string",
+ "payment_method_options.card.mandate_options.description": "string",
+ "payment_method_options.card.mandate_options.end_date": "integer",
+ "payment_method_options.card.mandate_options.interval": "string",
+ "payment_method_options.card.mandate_options.interval_count": "integer",
+ "payment_method_options.card.mandate_options.reference": "string",
+ "payment_method_options.card.mandate_options.start_date": "integer",
+ "payment_method_options.card.mandate_options.supported_types": "array",
+ "payment_method_options.card.moto": "boolean",
+ "payment_method_options.card.network": "string",
+ "payment_method_options.card.request_three_d_secure": "string",
+ "payment_method_options.card.three_d_secure.ares_trans_status": "string",
+ "payment_method_options.card.three_d_secure.cryptogram": "string",
+ "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer",
+ "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string",
+ "payment_method_options.card.three_d_secure.transaction_id": "string",
+ "payment_method_options.card.three_d_secure.version": "string",
+ "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",
+ "payment_method_types": "array",
+ "return_url": "string",
+ "single_use.amount": "integer",
+ "single_use.currency": "string",
+ "usage": "string",
+ "use_stripe_sdk": "boolean",
}, &Config)
resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "list", "/v1/setup_intents", http.MethodGet, map[string]string{
"attach_to_self": "boolean",
@@ -2205,62 +2276,71 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"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",
- "payment_method_data.au_becs_debit.account_number": "string",
- "payment_method_data.au_becs_debit.bsb_number": "string",
- "payment_method_data.bacs_debit.account_number": "string",
- "payment_method_data.bacs_debit.sort_code": "string",
- "payment_method_data.billing_details.email": "string",
- "payment_method_data.billing_details.name": "string",
- "payment_method_data.billing_details.phone": "string",
- "payment_method_data.boleto.tax_id": "string",
- "payment_method_data.eps.bank": "string",
- "payment_method_data.fpx.account_holder_type": "string",
- "payment_method_data.fpx.bank": "string",
- "payment_method_data.ideal.bank": "string",
- "payment_method_data.klarna.dob.day": "integer",
- "payment_method_data.klarna.dob.month": "integer",
- "payment_method_data.klarna.dob.year": "integer",
- "payment_method_data.p24.bank": "string",
- "payment_method_data.radar_options.session": "string",
- "payment_method_data.sepa_debit.iban": "string",
- "payment_method_data.sofort.country": "string",
- "payment_method_data.type": "string",
- "payment_method_data.us_bank_account.account_holder_type": "string",
- "payment_method_data.us_bank_account.account_number": "string",
- "payment_method_data.us_bank_account.account_type": "string",
- "payment_method_data.us_bank_account.financial_connections_account": "string",
- "payment_method_data.us_bank_account.routing_number": "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",
- "payment_method_options.acss_debit.mandate_options.interval_description": "string",
- "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.card.mandate_options.amount": "integer",
- "payment_method_options.card.mandate_options.amount_type": "string",
- "payment_method_options.card.mandate_options.currency": "string",
- "payment_method_options.card.mandate_options.description": "string",
- "payment_method_options.card.mandate_options.end_date": "integer",
- "payment_method_options.card.mandate_options.interval": "string",
- "payment_method_options.card.mandate_options.interval_count": "integer",
- "payment_method_options.card.mandate_options.reference": "string",
- "payment_method_options.card.mandate_options.start_date": "integer",
- "payment_method_options.card.mandate_options.supported_types": "array",
- "payment_method_options.card.moto": "boolean",
- "payment_method_options.card.network": "string",
- "payment_method_options.card.request_three_d_secure": "string",
- "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",
- "payment_method_types": "array",
+ "payment_method_data.acss_debit.account_number": "string",
+ "payment_method_data.acss_debit.institution_number": "string",
+ "payment_method_data.acss_debit.transit_number": "string",
+ "payment_method_data.au_becs_debit.account_number": "string",
+ "payment_method_data.au_becs_debit.bsb_number": "string",
+ "payment_method_data.bacs_debit.account_number": "string",
+ "payment_method_data.bacs_debit.sort_code": "string",
+ "payment_method_data.billing_details.email": "string",
+ "payment_method_data.billing_details.name": "string",
+ "payment_method_data.billing_details.phone": "string",
+ "payment_method_data.boleto.tax_id": "string",
+ "payment_method_data.eps.bank": "string",
+ "payment_method_data.fpx.account_holder_type": "string",
+ "payment_method_data.fpx.bank": "string",
+ "payment_method_data.ideal.bank": "string",
+ "payment_method_data.klarna.dob.day": "integer",
+ "payment_method_data.klarna.dob.month": "integer",
+ "payment_method_data.klarna.dob.year": "integer",
+ "payment_method_data.p24.bank": "string",
+ "payment_method_data.radar_options.session": "string",
+ "payment_method_data.sepa_debit.iban": "string",
+ "payment_method_data.sofort.country": "string",
+ "payment_method_data.type": "string",
+ "payment_method_data.us_bank_account.account_holder_type": "string",
+ "payment_method_data.us_bank_account.account_number": "string",
+ "payment_method_data.us_bank_account.account_type": "string",
+ "payment_method_data.us_bank_account.financial_connections_account": "string",
+ "payment_method_data.us_bank_account.routing_number": "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",
+ "payment_method_options.acss_debit.mandate_options.interval_description": "string",
+ "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.card.mandate_options.amount": "integer",
+ "payment_method_options.card.mandate_options.amount_type": "string",
+ "payment_method_options.card.mandate_options.currency": "string",
+ "payment_method_options.card.mandate_options.description": "string",
+ "payment_method_options.card.mandate_options.end_date": "integer",
+ "payment_method_options.card.mandate_options.interval": "string",
+ "payment_method_options.card.mandate_options.interval_count": "integer",
+ "payment_method_options.card.mandate_options.reference": "string",
+ "payment_method_options.card.mandate_options.start_date": "integer",
+ "payment_method_options.card.mandate_options.supported_types": "array",
+ "payment_method_options.card.moto": "boolean",
+ "payment_method_options.card.network": "string",
+ "payment_method_options.card.request_three_d_secure": "string",
+ "payment_method_options.card.three_d_secure.ares_trans_status": "string",
+ "payment_method_options.card.three_d_secure.cryptogram": "string",
+ "payment_method_options.card.three_d_secure.electronic_commerce_indicator": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_avalgo": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_exemption": "string",
+ "payment_method_options.card.three_d_secure.network_options.cartes_bancaires.cb_score": "integer",
+ "payment_method_options.card.three_d_secure.requestor_challenge_indicator": "string",
+ "payment_method_options.card.three_d_secure.transaction_id": "string",
+ "payment_method_options.card.three_d_secure.version": "string",
+ "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",
+ "payment_method_types": "array",
}, &Config)
resource.NewOperationCmd(rSetupIntentsCmd.Cmd, "verify_microdeposits", "/v1/setup_intents/{intent}/verify_microdeposits", http.MethodPost, map[string]string{
"amounts": "array",
@@ -2942,6 +3022,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"billing_address_collection": "string",
"cancel_url": "string",
"client_reference_id": "string",
+ "consent_collection.payment_method_reuse_agreement.position": "string",
"consent_collection.promotions": "string",
"consent_collection.terms_of_service": "string",
"currency": "string",
@@ -3027,6 +3108,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"payment_method_options.paypal.risk_correlation_id": "string",
"payment_method_options.paypal.setup_future_usage": "string",
"payment_method_options.pix.expires_after_seconds": "integer",
+ "payment_method_options.revolut_pay.setup_future_usage": "string",
"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",
@@ -3061,12 +3143,14 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &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{
+ "created": "integer",
"customer": "string",
"ending_before": "string",
"limit": "integer",
"payment_intent": "string",
"payment_link": "string",
"starting_after": "string",
+ "status": "string",
"subscription": "string",
}, &Config)
resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "list_line_items", "/v1/checkout/sessions/{session}/line_items", http.MethodGet, map[string]string{
@@ -3075,6 +3159,33 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"starting_after": "string",
}, &Config)
resource.NewOperationCmd(rCheckoutSessionsCmd.Cmd, "retrieve", "/v1/checkout/sessions/{session}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "cancel", "/v1/climate/orders/{order}/cancel", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "create", "/v1/climate/orders", http.MethodPost, map[string]string{
+ "amount": "integer",
+ "beneficiary.public_name": "string",
+ "currency": "string",
+ "metric_tons": "string",
+ "product": "string",
+ }, &Config)
+ resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "list", "/v1/climate/orders", http.MethodGet, map[string]string{
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ }, &Config)
+ resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "retrieve", "/v1/climate/orders/{order}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rClimateOrdersCmd.Cmd, "update", "/v1/climate/orders/{order}", http.MethodPost, map[string]string{}, &Config)
+ resource.NewOperationCmd(rClimateProductsCmd.Cmd, "list", "/v1/climate/products", http.MethodGet, map[string]string{
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ }, &Config)
+ resource.NewOperationCmd(rClimateProductsCmd.Cmd, "retrieve", "/v1/climate/products/{product}", http.MethodGet, map[string]string{}, &Config)
+ resource.NewOperationCmd(rClimateSuppliersCmd.Cmd, "list", "/v1/climate/suppliers", http.MethodGet, map[string]string{
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ }, &Config)
+ resource.NewOperationCmd(rClimateSuppliersCmd.Cmd, "retrieve", "/v1/climate/suppliers/{supplier}", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rFinancialConnectionsAccountsCmd.Cmd, "disconnect", "/v1/financial_connections/accounts/{account}/disconnect", http.MethodPost, map[string]string{}, &Config)
resource.NewOperationCmd(rFinancialConnectionsAccountsCmd.Cmd, "list", "/v1/financial_connections/accounts", http.MethodGet, map[string]string{
"ending_before": "string",
@@ -3174,12 +3285,16 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "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",
+ "verification_data.authentication_exemption.claimed_by": "string",
+ "verification_data.authentication_exemption.type": "string",
+ "verification_data.cvc_check": "string",
+ "verification_data.expiry_check": "string",
+ "verification_data.three_d_secure.result": "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{
@@ -3356,6 +3471,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "string",
"purchase_details.flight.departure_at": "integer",
"purchase_details.flight.passenger_name": "string",
"purchase_details.flight.refundable": "boolean",
@@ -3380,6 +3496,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "string",
"purchase_details.flight.departure_at": "integer",
"purchase_details.flight.passenger_name": "string",
"purchase_details.flight.refundable": "boolean",
@@ -3397,6 +3514,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
}, &Config)
resource.NewOperationCmd(rRadarEarlyFraudWarningsCmd.Cmd, "list", "/v1/radar/early_fraud_warnings", http.MethodGet, map[string]string{
"charge": "string",
+ "created": "integer",
"ending_before": "string",
"limit": "integer",
"payment_intent": "string",
@@ -3479,6 +3597,101 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"limit": "integer",
"starting_after": "string",
}, &Config)
+ resource.NewOperationCmd(rTaxRegistrationsCmd.Cmd, "create", "/v1/tax/registrations", http.MethodPost, map[string]string{
+ "active_from": "string",
+ "country": "string",
+ "country_options.ae.type": "string",
+ "country_options.at.standard.place_of_supply_scheme": "string",
+ "country_options.at.type": "string",
+ "country_options.au.type": "string",
+ "country_options.be.standard.place_of_supply_scheme": "string",
+ "country_options.be.type": "string",
+ "country_options.bg.standard.place_of_supply_scheme": "string",
+ "country_options.bg.type": "string",
+ "country_options.ca.province_standard.province": "string",
+ "country_options.ca.type": "string",
+ "country_options.ch.type": "string",
+ "country_options.cl.type": "string",
+ "country_options.co.type": "string",
+ "country_options.cy.standard.place_of_supply_scheme": "string",
+ "country_options.cy.type": "string",
+ "country_options.cz.standard.place_of_supply_scheme": "string",
+ "country_options.cz.type": "string",
+ "country_options.de.standard.place_of_supply_scheme": "string",
+ "country_options.de.type": "string",
+ "country_options.dk.standard.place_of_supply_scheme": "string",
+ "country_options.dk.type": "string",
+ "country_options.ee.standard.place_of_supply_scheme": "string",
+ "country_options.ee.type": "string",
+ "country_options.es.standard.place_of_supply_scheme": "string",
+ "country_options.es.type": "string",
+ "country_options.fi.standard.place_of_supply_scheme": "string",
+ "country_options.fi.type": "string",
+ "country_options.fr.standard.place_of_supply_scheme": "string",
+ "country_options.fr.type": "string",
+ "country_options.gb.type": "string",
+ "country_options.gr.standard.place_of_supply_scheme": "string",
+ "country_options.gr.type": "string",
+ "country_options.hr.standard.place_of_supply_scheme": "string",
+ "country_options.hr.type": "string",
+ "country_options.hu.standard.place_of_supply_scheme": "string",
+ "country_options.hu.type": "string",
+ "country_options.id.type": "string",
+ "country_options.ie.standard.place_of_supply_scheme": "string",
+ "country_options.ie.type": "string",
+ "country_options.is.type": "string",
+ "country_options.it.standard.place_of_supply_scheme": "string",
+ "country_options.it.type": "string",
+ "country_options.jp.type": "string",
+ "country_options.kr.type": "string",
+ "country_options.lt.standard.place_of_supply_scheme": "string",
+ "country_options.lt.type": "string",
+ "country_options.lu.standard.place_of_supply_scheme": "string",
+ "country_options.lu.type": "string",
+ "country_options.lv.standard.place_of_supply_scheme": "string",
+ "country_options.lv.type": "string",
+ "country_options.mt.standard.place_of_supply_scheme": "string",
+ "country_options.mt.type": "string",
+ "country_options.mx.type": "string",
+ "country_options.my.type": "string",
+ "country_options.nl.standard.place_of_supply_scheme": "string",
+ "country_options.nl.type": "string",
+ "country_options.no.type": "string",
+ "country_options.nz.type": "string",
+ "country_options.pl.standard.place_of_supply_scheme": "string",
+ "country_options.pl.type": "string",
+ "country_options.pt.standard.place_of_supply_scheme": "string",
+ "country_options.pt.type": "string",
+ "country_options.ro.standard.place_of_supply_scheme": "string",
+ "country_options.ro.type": "string",
+ "country_options.sa.type": "string",
+ "country_options.se.standard.place_of_supply_scheme": "string",
+ "country_options.se.type": "string",
+ "country_options.sg.type": "string",
+ "country_options.si.standard.place_of_supply_scheme": "string",
+ "country_options.si.type": "string",
+ "country_options.sk.standard.place_of_supply_scheme": "string",
+ "country_options.sk.type": "string",
+ "country_options.th.type": "string",
+ "country_options.tr.type": "string",
+ "country_options.us.local_amusement_tax.jurisdiction": "string",
+ "country_options.us.local_lease_tax.jurisdiction": "string",
+ "country_options.us.state": "string",
+ "country_options.us.type": "string",
+ "country_options.vn.type": "string",
+ "country_options.za.type": "string",
+ "expires_at": "integer",
+ }, &Config)
+ resource.NewOperationCmd(rTaxRegistrationsCmd.Cmd, "list", "/v1/tax/registrations", http.MethodGet, map[string]string{
+ "ending_before": "string",
+ "limit": "integer",
+ "starting_after": "string",
+ "status": "string",
+ }, &Config)
+ resource.NewOperationCmd(rTaxRegistrationsCmd.Cmd, "update", "/v1/tax/registrations/{id}", http.MethodPost, map[string]string{
+ "active_from": "string",
+ "expires_at": "string",
+ }, &Config)
resource.NewOperationCmd(rTaxSettingssCmd.Cmd, "retrieve", "/v1/tax/settings", http.MethodGet, map[string]string{}, &Config)
resource.NewOperationCmd(rTaxSettingssCmd.Cmd, "update", "/v1/tax/settings", http.MethodPost, map[string]string{
"defaults.tax_behavior": "string",
@@ -3635,12 +3848,16 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "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",
+ "verification_data.authentication_exemption.claimed_by": "string",
+ "verification_data.authentication_exemption.type": "string",
+ "verification_data.cvc_check": "string",
+ "verification_data.expiry_check": "string",
+ "verification_data.three_d_secure.result": "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{
@@ -3666,6 +3883,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "string",
"purchase_details.flight.departure_at": "integer",
"purchase_details.flight.passenger_name": "string",
"purchase_details.flight.refundable": "boolean",
@@ -3690,6 +3908,7 @@ func addAllResourcesCmds(rootCmd *cobra.Command) {
"merchant_data.postal_code": "string",
"merchant_data.state": "string",
"merchant_data.terminal_id": "string",
+ "merchant_data.url": "string",
"purchase_details.flight.departure_at": "integer",
"purchase_details.flight.passenger_name": "string",
"purchase_details.flight.refundable": "boolean",
diff --git a/pkg/proxy/events_list.go b/pkg/proxy/events_list.go
index 4c16334de..74884058b 100644
--- a/pkg/proxy/events_list.go
+++ b/pkg/proxy/events_list.go
@@ -36,6 +36,13 @@ var validEvents = map[string]bool{
"checkout.session.async_payment_succeeded": true,
"checkout.session.completed": true,
"checkout.session.expired": true,
+ "climate.order.canceled": true,
+ "climate.order.created": true,
+ "climate.order.delayed": true,
+ "climate.order.delivered": true,
+ "climate.order.product_substituted": true,
+ "climate.product.created": true,
+ "climate.product.pricing_updated": true,
"coupon.created": true,
"coupon.deleted": true,
"coupon.updated": true,