Stripe API
Number of APIs: 376
Stripe API Qodex Collection
This is a Qodex collection covering the Stripe API. See https://stripe.com/docs/api for more details.
Prerequisites
Getting Started
To get started fork the collection from [Stripe's public workspace] within Qodex.

Enter a name for your fork and select the workspace where it will be created:

You can also fork the environment template from the Stripe Developers Workspace:

Set your API key
To run requests you'll need to supply your testmode secret API key and set it as an [environment variable] within your workspace.
To set any environment variable, create a new envionment within Qodex:

Add your secret key as a variable to the environment and save:

Set the environment to active:

Now within the collection set it to use the environment you just created:

If your environment is set up correctly, you should see your secret key value if you mouse over the secret_key
variable in the Token field:

Be sure to save the collection after you've configured the set the key:

Make a test call
You should be ready now to make a test call. An easy first call is to create a customer:

Since no parameters are required to create a customer, you can just hit the Send button to run this request:

If your environment is set up you'll get a customer object back as the response to the call:

Add parameters to the call by clicking the body tab, where you'll see a list of available parameters. Select and populate the ones you want to use. Here's an example of adding an email parameter:

You'll see the email address in the reponse:

Passing Metadata In a Request
Right now metadata does not show up as a optional parameter on requests, but it can still be provided to calls that will accept it. Here's an example of adding 2 metadata fields to the customer create call:

Metadata key value pairs can be updated in a similar manner. To remove a metadata key during an update call, supply the metadata[key]
parameter without setting a value. This will pass an empty string as part of the request:

To remove all metadata pass the metadata
parameter without a value set:

Changelog
2022-10-31
- Add support for
tax_behavior
andtax_code
onInvoiceUpcomingLinesParams.invoice_items[]
andInvoiceUpcomingParams.invoice_items[]
- Add support for
on_behalf_of
onCheckoutSessionCreateParams.subscription_data
,SubscriptionCreateParams
,SubscriptionSchedule.default_settings
,SubscriptionSchedule.phases[]
,SubscriptionScheduleCreateParams.default_settings
,SubscriptionScheduleCreateParams.phases[]
,SubscriptionScheduleUpdateParams.default_settings
,SubscriptionScheduleUpdateParams.phases[]
,SubscriptionUpdateParams
, andSubscription
- Add support for
tax_behavior
andtax_code
onInvoiceItemCreateParams
andInvoiceItemUpdateParams
- Add support for
tipping
onTerminal.Reader.action.process_payment_intent.process_config
andTerminalReaderProcessPaymentIntentParams.process_config
- Add support for new values
jp_trn
andke_pin
on enumsCheckout.Session.customer_details.tax_ids[].type
,Invoice.customer_tax_ids[].type
,Order.tax_details.tax_ids[].type
, andTaxId.type
- Add support for new values
jp_trn
andke_pin
on enumsCustomerCreateParams.tax_id_data[].type
,InvoiceUpcomingLinesParams.customer_details.tax_ids[].type
,InvoiceUpcomingParams.customer_details.tax_ids[].type
,OrderCreateParams.tax_details.tax_ids[].type
,OrderUpdateParams.tax_details.tax_ids[].type
, andTaxIdCreateParams.type
- Change
Charge.refunds
andPaymentIntent.charges
to be optional - Add support for new values
invalid_representative_country
andverification_failed_residential_address
on enumsAccount.future_requirements.errors[].code
,Account.requirements.errors[].code
,Capability.future_requirements.errors[].code
,Capability.requirements.errors[].code
,Person.future_requirements.errors[].code
, andPerson.requirements.errors[].code
- Change
Charge.refunds
to be required - Add support for
network_data
onIssuing.Authorization
- Change
PaymentIntent.charges
to be required - Add support for
request_log_url
onInvoice.last_finalization_error
,PaymentIntent.last_payment_error
,SetupAttempt.setup_error
,SetupIntent.last_setup_error
,StripeErrorResponse.error
, andStripeError
- Add support for new value
bank_of_china
on enumsCharge.payment_method_details.fpx.bank
,PaymentIntentConfirmParams.payment_method_data.fpx.bank
,PaymentIntentCreateParams.payment_method_data.fpx.bank
,PaymentIntentUpdateParams.payment_method_data.fpx.bank
,PaymentMethod.fpx.bank
,PaymentMethodCreateParams.fpx.bank
,SetupIntentConfirmParams.payment_method_data.fpx.bank
,SetupIntentCreateParams.payment_method_data.fpx.bank
, andSetupIntentUpdateParams.payment_method_data.fpx.bank
- Remove support for value
mixed
from enumCreditNote.type
- Add support for new value
mixed
on enumCreditNote.type
- Add support for new values
America/Nuuk
,Europe/Kyiv
, andPacific/Kanton
on enumReportingReportRunCreateParams.parameters.timezone
- Add support for
klarna
onSetupAttempt.payment_method_details
2022-09-29
- Add support for
created
onCheckout.Session
- Change type of
Charge.payment_method_details.card_present.incremental_authorization_supported
andCharge.payment_method_details.card_present.overcapture_supported
fromnullable(boolean)
toboolean
- Add support for
setup_future_usage
onPaymentIntent#confirm.payment_method_options.pix
,PaymentIntent#create.payment_method_options.pix
,PaymentIntent#update.payment_method_options.pix
, andPaymentIntent.payment_method_options.pix
- Add support for
statement_descriptor
onPaymentIntent#increment_authorization
- Release specs are identical.
- Add support for
terms_of_service
onCheckout.Session#create.consent_collection
,Checkout.Session.consent_collection
,Checkout.Session.consent
,PaymentLink#create.consent_collection
, andPaymentLink.consent_collection
- Remove support for
plan
onCheckout.Session#create.payment_method_options.card.installments
- Change
SubscriptionSchedule.phases[].currency
to be required - Add support for
amount
onIssuing.Dispute#create
andIssuing.Dispute#update
- Add support for
created
onTreasury.CreditReversal
- Add support for
pix
onCharge.payment_method_details
,Checkout.Session#create.payment_method_options
,Checkout.Session.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod
,SetupIntent#confirm.payment_method_data
,SetupIntent#create.payment_method_data
, andSetupIntent#update.payment_method_data
- Add support for new value
pix
on enumCheckout.Session#create.payment_method_types[]
- Add support for new value
pix
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for
from_invoice
onInvoice#create
andInvoice
- Add support for
latest_revision
onInvoice
- Add support for new value
pix
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,SetupIntent#confirm.payment_method_data.type
,SetupIntent#create.payment_method_data.type
, andSetupIntent#update.payment_method_data.type
- Add support for
pix_display_qr_code
onPaymentIntent.next_action
- Add support for new value
pix
on enumsPaymentLink#create.payment_method_types[]
,PaymentLink#update.payment_method_types[]
, andPaymentLink.payment_method_types[]
- Add support for new value
pix
on enumPaymentMethod#create.type
- Add support for new value
pix
on enumPaymentMethod.type
- Add support for
created
onTreasury.DebitReversal
- Add support for
require_signature
onIssuing.Card#create.shipping
andIssuing.Card.shipping
- Release specs are identical.
- Add support for new value
terminal_reader_splashscreen
on enumsFile#list.purpose
andFile.purpose
- Add support for new values
de-CH
,en-CH
,en-PL
,en-PT
,fr-CH
,it-CH
,pl-PL
, andpt-PT
on enumsOrder#create.payment.settings.payment_method_options.klarna.preferred_locale
,Order#update.payment.settings.payment_method_options.klarna.preferred_locale
,PaymentIntent#confirm.payment_method_options.klarna.preferred_locale
,PaymentIntent#create.payment_method_options.klarna.preferred_locale
, andPaymentIntent#update.payment_method_options.klarna.preferred_locale
- Add support for
description
onPaymentLink#create.subscription_data
andPaymentLink.subscription_data
- Change
Account.company.name
,Charge.refunds
,PaymentIntent.charges
,Product.caption
,Product.statement_descriptor
,Product.unit_label
,Terminal.Configuration.tipping.aud.fixed_amounts
,Terminal.Configuration.tipping.aud.percentages
,Terminal.Configuration.tipping.cad.fixed_amounts
,Terminal.Configuration.tipping.cad.percentages
,Terminal.Configuration.tipping.chf.fixed_amounts
,Terminal.Configuration.tipping.chf.percentages
,Terminal.Configuration.tipping.czk.fixed_amounts
,Terminal.Configuration.tipping.czk.percentages
,Terminal.Configuration.tipping.dkk.fixed_amounts
,Terminal.Configuration.tipping.dkk.percentages
,Terminal.Configuration.tipping.eur.fixed_amounts
,Terminal.Configuration.tipping.eur.percentages
,Terminal.Configuration.tipping.gbp.fixed_amounts
,Terminal.Configuration.tipping.gbp.percentages
,Terminal.Configuration.tipping.hkd.fixed_amounts
,Terminal.Configuration.tipping.hkd.percentages
,Terminal.Configuration.tipping.myr.fixed_amounts
,Terminal.Configuration.tipping.myr.percentages
,Terminal.Configuration.tipping.nok.fixed_amounts
,Terminal.Configuration.tipping.nok.percentages
,Terminal.Configuration.tipping.nzd.fixed_amounts
,Terminal.Configuration.tipping.nzd.percentages
,Terminal.Configuration.tipping.sek.fixed_amounts
,Terminal.Configuration.tipping.sek.percentages
,Terminal.Configuration.tipping.sgd.fixed_amounts
,Terminal.Configuration.tipping.sgd.percentages
,Terminal.Configuration.tipping.usd.fixed_amounts
,Terminal.Configuration.tipping.usd.percentages
,Treasury.FinancialAccount.active_features
,Treasury.FinancialAccount.pending_features
,Treasury.FinancialAccount.platform_restrictions
, andTreasury.FinancialAccount.restricted_features
to be optional - Add support for
description
onSubscriptionSchedule#create.default_settings
,SubscriptionSchedule#create.phases[]
,SubscriptionSchedule#update.default_settings
,SubscriptionSchedule#update.phases[]
,SubscriptionSchedule.default_settings
, andSubscriptionSchedule.phases[]
- Add support for
login_page
onBillingPortal.Configuration#create
,BillingPortal.Configuration#update
, andBillingPortal.Configuration
2022-08-24
- Change
Terminal.Reader.action
to be required - Change type of
Treasury.OutboundTransfer.destination_payment_method
fromstring
tonullable(string)
- Change
Treasury.OutboundTransfer#create.destination_payment_method
to be optional - Remove support for value
paypal
from enumsOrder#create.payment.settings.payment_method_types[]
,Order#update.payment.settings.payment_method_types[]
, andOrder.payment.settings.payment_method_types[]
- Add support for new resource
CustomerCashBalanceTransaction
- Add support for new value
customer_cash_balance_transaction.created
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
network
onSetupIntent#confirm.payment_method_options.card
,SetupIntent#create.payment_method_options.card
,SetupIntent#update.payment_method_options.card
,Subscription#create.payment_settings.payment_method_options.card
,Subscription#update.payment_settings.payment_method_options.card
, andSubscription.payment_settings.payment_method_options.card
- Add support for
currency
onPaymentLink
- Change
Subscription.currency
to be required - Change type of
Topup.source
from$Source
tonullable($Source)
- Add support for
payment_method_collection
onCheckout.Session#create
,Checkout.Session
,PaymentLink#create
,PaymentLink#update
, andPaymentLink
- Add support for
process_config
onTerminal.Reader.action.process_payment_intent
- Add support for
expires_at
onApps.Secret#create
andApps.Secret
2022-08-04
- Remove support for resources
AlipayAccount
,BitcoinReceiver
,BitcoinTransaction
,IssuerFraudRecord
,Recipient
, andThreeDSecure
- Add support for
list_line_items
method on resourceCheckout.Session
- Remove support for
list
method on resourceLineItem
- Add support for new value
invalid_tos_acceptance
on enumsAccount.future_requirements.errors[].code
,Account.requirements.errors[].code
,Capability.future_requirements.errors[].code
,Capability.requirements.errors[].code
,Person.future_requirements.errors[].code
, andPerson.requirements.errors[].code
- Remove support for
recipient
onCard
- Add support for
shipping_cost
andshipping_details
onCheckout.Session
- Remove support for
shipping_rate
andshipping
onCheckout.Session
- Add support for
validate
onCustomer#create
,Customer#update
, andPaymentSource#create
- Remove support for
trial_end
onCustomer#update
- Remove support for
default_currency
onCustomer
- Add support for new value
design_rejected
on enumIssuing.Card.cancellation_reason
- Remove support for
redirect_url
onLoginLink#create
- Add support for new value
2022-08-01
on enumWebhookEndpoint#create.api_version
- Remove support for values
order.payment_failed
,order.payment_succeeded
,order.updated
,order_return.created
,transfer.failed
, andtransfer.paid
from enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
customer_balance
onCheckout.Session#create.payment_method_options
andCheckout.Session.payment_method_options
- Add support for new value
customer_balance
on enumCheckout.Session#create.payment_method_types[]
- Add support for new values
en-CA
andfr-CA
on enumsOrder#create.payment.settings.payment_method_options.klarna.preferred_locale
,Order#update.payment.settings.payment_method_options.klarna.preferred_locale
,PaymentIntent#confirm.payment_method_options.klarna.preferred_locale
,PaymentIntent#create.payment_method_options.klarna.preferred_locale
, andPaymentIntent#update.payment_method_options.klarna.preferred_locale
- Add support for new value
exempted
on enumsCharge.payment_method_details.card.three_d_secure.result
andSetupAttempt.payment_method_details.card.three_d_secure.result
- Remove support for resource
InstallmentsOptions
- Add support for
installments
onInvoice.payment_settings.payment_method_options.card
- Add support for new resource
InstallmentsOptions
- Add support for
installments
onCheckout.Session#create.payment_method_options.card
,Checkout.Session.payment_method_options.card
,Invoice#create.payment_settings.payment_method_options.card
,Invoice#update.payment_settings.payment_method_options.card
, andPaymentIntentTypeSpecificPaymentMethodOptionsClient
- Add support for
default_mandate
onInvoice#create.payment_settings
,Invoice#update.payment_settings
, andInvoice.payment_settings
- Add support for
mandate
onInvoice#pay
- Add support for
product_data
onOrder#create.line_items[]
andOrder#update.line_items[]
- Add support for
default_currency
andinvoice_credit_balance
onCustomer
- Add support for
currency
onInvoice#create
- Add support for
blik_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
blik
onCharge.payment_method_details
,Mandate.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod#update
,PaymentMethod
,SetupAttempt.payment_method_details
,SetupIntent#confirm.payment_method_data
,SetupIntent#confirm.payment_method_options
,SetupIntent#create.payment_method_data
,SetupIntent#create.payment_method_options
,SetupIntent#update.payment_method_data
,SetupIntent#update.payment_method_options
, andSetupIntent.payment_method_options
- Add support for new value
blik
on enumCheckout.Session#create.payment_method_types[]
- Add support for new value
blik
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new value
blik
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,SetupIntent#confirm.payment_method_data.type
,SetupIntent#create.payment_method_data.type
, andSetupIntent#update.payment_method_data.type
- Add support for new value
blik
on enumsPaymentLink#create.payment_method_types[]
,PaymentLink#update.payment_method_types[]
, andPaymentLink.payment_method_types[]
- Add support for new value
blik
on enumPaymentMethod#create.type
- Add support for new value
blik
on enumPaymentMethod.type
- Change type of
Checkout.Session#create.consent_collection.promotions
,Checkout.Session.consent_collection.promotions
,PaymentLink#create.consent_collection.promotions
, andPaymentLink.consent_collection.promotions
fromliteral('auto')
toenum('auto'|'none')
- Change type of
Transfer.source_type
fromnullable(string)
tostring
- Change
Transfer.source_type
to be optional - Add support for
customer_details
onCheckout.Session#list
- Add support for
currency
onCheckout.Session#create
,Invoice#upcomingLines
,Invoice#upcoming
,PaymentLink#create
,Subscription#create
,SubscriptionSchedule#create.phases[]
,SubscriptionSchedule#update.phases[]
,SubscriptionSchedule.phases[]
, andSubscription
- Add support for
currency_options
onCheckout.Session#create.shipping_options[].shipping_rate_data.fixed_amount
,Coupon#create
,Coupon#update
,Coupon
,Order#create.shipping_cost.shipping_rate_data.fixed_amount
,Order#update.shipping_cost.shipping_rate_data.fixed_amount
,Price#create
,Price#update
,Price
,Product#create.default_price_data
,PromotionCode#create.restrictions
,PromotionCode.restrictions
,ShippingRate#create.fixed_amount
, andShippingRate.fixed_amount
- Change
LineItem.amount_discount
andLineItem.amount_tax
to be required - Add support for
restrictions
onPromotionCode#update
- Add support for
fixed_amount
andtax_behavior
onShippingRate#update
- Add support for
currency
,customer
, andorigin
onRefund#create
- Add support for
customer
onCheckout.Session#list
- Add support for new values
financial_connections.account.created
,financial_connections.account.deactivated
,financial_connections.account.disconnected
,financial_connections.account.reactivated
, andfinancial_connections.account.refreshed_balance
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
deliver_card
,fail_card
,return_card
, andship_card
test helper methods on resourceIssuing.Card
- Change type of
PaymentLink#create.payment_method_types[]
,PaymentLink#update.payment_method_types[]
, andPaymentLink.payment_method_types[]
fromliteral('card')
toenum
2022-06-26
- Add support for
hosted_regulatory_receipt_url
onTreasury.ReceivedCredit
andTreasury.ReceivedDebit
- Remove support for value
treasury.received_credit.reversed
from enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
capture_method
onPaymentIntent#confirm
andPaymentIntent#update
- Change
Price.custom_unit_amount
to be required - Add support for
reversal_details
onTreasury.ReceivedCredit
andTreasury.ReceivedDebit
- Add support for
debit_reversal
onTreasury.ReceivedDebit.linked_flows
- Add support for
promptpay_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
promptpay
onCharge.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod
,SetupIntent#confirm.payment_method_data
,SetupIntent#create.payment_method_data
, andSetupIntent#update.payment_method_data
- Add support for new value
promptpay
on enumCheckout.Session#create.payment_method_types[]
- Add support for
subtotal_excluding_tax
onCreditNote
andInvoice
- Add support for
amount_excluding_tax
andunit_amount_excluding_tax
onCreditNoteLineItem
andInvoiceLineItem
- Add support for new value
promptpay
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for
rendering_options
onInvoice#create
andInvoice#update
- Add support for new value
promptpay
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for
total_excluding_tax
onInvoice
- Add support for
automatic_payment_methods
onOrder.payment.settings
- Add support for new value
promptpay
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,SetupIntent#confirm.payment_method_data.type
,SetupIntent#create.payment_method_data.type
, andSetupIntent#update.payment_method_data.type
- Add support for
promptpay_display_qr_code
onPaymentIntent.next_action
- Add support for new value
promptpay
on enumPaymentMethod#create.type
- Add support for new value
promptpay
on enumPaymentMethod.type
- Add support for
fund_cash_balance
test helper method on resourceCustomer
- Remove support for
fund_cash_balance
test helper method on resourceCustomerBalanceTransaction
- Remove support for
list_funding_instructions
method on resourceCustomer
- Add support for
fund_cash_balance
test helper method on resourceCustomerBalanceTransaction
- Remove support for
subtotal_excluding_tax
onCreditNote
andInvoice
- Remove support for
amount_excluding_tax
andunit_amount_excluding_tax
onCreditNoteLineItem
andInvoiceLineItem
- Remove support for
rendering_options
onInvoice#create
andInvoice#update
- Remove support for
total_excluding_tax
onInvoice
- Add support for
list_funding_instructions
method on resourceCustomer
- Add support for
statement_descriptor_prefix_kana
andstatement_descriptor_prefix_kanji
onAccount#create.settings.card_payments
,Account#update.settings.card_payments
,Account.settings.card_payments
, andAccount.settings.payments
- Add support for
statement_descriptor_suffix_kana
andstatement_descriptor_suffix_kanji
onCheckout.Session#create.payment_method_options.card
,Checkout.Session.payment_method_options.card
,PaymentIntent#confirm.payment_method_options.card
,PaymentIntent#create.payment_method_options.card
,PaymentIntent#update.payment_method_options.card
, andPaymentIntent.payment_method_options.card
- Add support for
subtotal_excluding_tax
andtotal_excluding_tax
onCreditNote
andInvoice
- Add support for
amount_excluding_tax
andunit_amount_excluding_tax
onCreditNoteLineItem
andInvoiceLineItem
- Add support for
rendering_options
onCustomer.invoice_settings
,Invoice#create
,Invoice#update
, andInvoice
- No differences
- Change type of
Customer#create.invoice_settings.rendering_options
andCustomer#update.invoice_settings.rendering_options
fromrendering_options_param
toemptyStringable(rendering_options_param)
- Add support for
treasury
onAccount#create.settings
,Account#update.settings
, andAccount.settings
- Add support for
rendering_options
onCustomer#create.invoice_settings
andCustomer#update.invoice_settings
- Add support for
custom_unit_amount
onPrice#create
andPrice
- Remove support for
installments
onCheckout.Session.payment_method_options.card
- Add support for
eu_bank_transfer
onCustomer#create_funding_instructions.bank_transfer
,Invoice#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice#update.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer
,PaymentIntent.payment_method_options.customer_balance.bank_transfer
,Subscription#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Subscription#update.payment_settings.payment_method_options.customer_balance.bank_transfer
, andSubscription.payment_settings.payment_method_options.customer_balance.bank_transfer
- Change type of
Customer#create_funding_instructions.bank_transfer.requested_address_types[]
fromliteral('zengin')
toenum('iban'|'sort_code'|'spei'|'zengin')
- Change type of
Customer#create_funding_instructions.bank_transfer.type
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent.next_action.display_bank_transfer_instructions.type
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.type
fromliteral('jp_bank_transfer')
toenum('eu_bank_transfer'|'gb_bank_transfer'|'jp_bank_transfer'|'mx_bank_transfer')
- Add support for
iban
,sort_code
, andspei
onFundingInstructions.bank_transfer.financial_addresses[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[]
- Add support for new values
bacs
,fps
, andspei
on enumsFundingInstructions.bank_transfer.financial_addresses[].supported_networks[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].supported_networks[]
- Add support for new values
sort_code
andspei
on enumsFundingInstructions.bank_transfer.financial_addresses[].type
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].type
- Change type of
Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
fromliteral('zengin')
toenum
- Add support for
attach_to_self
onSetupAttempt
,SetupIntent#create
,SetupIntent#list
, andSetupIntent#update
- Add support for
flow_directions
onSetupAttempt
,SetupIntent#create
, andSetupIntent#update
- Add support for
affirm
,afterpay_clearpay
,au_becs_debit
,bacs_debit
,bancontact
,eps
,fpx
,giropay
,grabpay
,ideal
,klarna
,p24
,paynow
,sepa_debit
, andsofort
onCheckout.Session#create.payment_method_options
- Add support for
card
onCheckout.Session#create.payment_method_options
andCheckout.Session.payment_method_options
- Add support for
setup_future_usage
onCheckout.Session#create.payment_method_options.acss_debit
,Checkout.Session#create.payment_method_options.alipay
,Checkout.Session#create.payment_method_options.boleto
,Checkout.Session#create.payment_method_options.konbini
,Checkout.Session#create.payment_method_options.oxxo
,Checkout.Session#create.payment_method_options.us_bank_account
,Checkout.Session#create.payment_method_options.wechat_pay
,Checkout.Session.payment_method_options.acss_debit
,Checkout.Session.payment_method_options.affirm
,Checkout.Session.payment_method_options.afterpay_clearpay
,Checkout.Session.payment_method_options.alipay
,Checkout.Session.payment_method_options.au_becs_debit
,Checkout.Session.payment_method_options.bacs_debit
,Checkout.Session.payment_method_options.bancontact
,Checkout.Session.payment_method_options.boleto
,Checkout.Session.payment_method_options.eps
,Checkout.Session.payment_method_options.fpx
,Checkout.Session.payment_method_options.giropay
,Checkout.Session.payment_method_options.grabpay
,Checkout.Session.payment_method_options.ideal
,Checkout.Session.payment_method_options.klarna
,Checkout.Session.payment_method_options.konbini
,Checkout.Session.payment_method_options.oxxo
,Checkout.Session.payment_method_options.p24
,Checkout.Session.payment_method_options.paynow
,Checkout.Session.payment_method_options.sepa_debit
,Checkout.Session.payment_method_options.sofort
, andCheckout.Session.payment_method_options.us_bank_account
- Remove support for
eu_bank_transfer
onCustomer#create_funding_instructions.bank_transfer
,Invoice#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice#update.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer
,PaymentIntent.payment_method_options.customer_balance.bank_transfer
,Subscription#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Subscription#update.payment_settings.payment_method_options.customer_balance.bank_transfer
, andSubscription.payment_settings.payment_method_options.customer_balance.bank_transfer
- Change type of
Customer#create_funding_instructions.bank_transfer.requested_address_types[]
fromenum('iban'|'sort_code'|'spei'|'zengin')
toliteral('zengin')
- Change type of
Customer#create_funding_instructions.bank_transfer.type
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent.next_action.display_bank_transfer_instructions.type
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.type
fromenum('eu_bank_transfer'|'gb_bank_transfer'|'jp_bank_transfer'|'mx_bank_transfer')
toliteral('jp_bank_transfer')
- Remove support for
iban
,sort_code
, andspei
onFundingInstructions.bank_transfer.financial_addresses[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[]
- Remove support for values
bacs
,fps
, andspei
from enumsFundingInstructions.bank_transfer.financial_addresses[].supported_networks[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].supported_networks[]
- Remove support for values
sort_code
andspei
from enumsFundingInstructions.bank_transfer.financial_addresses[].type
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].type
- Change type of
Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
fromenum
toliteral('zengin')
- Change
PaymentMethod.us_bank_account.networks
andSetupIntent.flow_directions
to be required - Add support for
affirm
onCheckout.Session.payment_method_options
- Add support for
bancontact
,ideal
,p24
, andsofort
onCheckout.Session.payment_method_options
- Add support for
eu_bank_transfer
onCustomer#create_funding_instructions.bank_transfer
,Invoice#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice#update.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer
,PaymentIntent.payment_method_options.customer_balance.bank_transfer
,Subscription#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Subscription#update.payment_settings.payment_method_options.customer_balance.bank_transfer
, andSubscription.payment_settings.payment_method_options.customer_balance.bank_transfer
- Change type of
Customer#create_funding_instructions.bank_transfer.requested_address_types[]
fromliteral('zengin')
toenum('iban'|'sort_code'|'spei'|'zengin')
- Change type of
Customer#create_funding_instructions.bank_transfer.type
,Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.type
,PaymentIntent.next_action.display_bank_transfer_instructions.type
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.type
fromliteral('jp_bank_transfer')
toenum('eu_bank_transfer'|'gb_bank_transfer'|'jp_bank_transfer'|'mx_bank_transfer')
- Add support for
iban
,sort_code
, andspei
onFundingInstructions.bank_transfer.financial_addresses[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[]
- Add support for new values
bacs
,fps
, andspei
on enumsFundingInstructions.bank_transfer.financial_addresses[].supported_networks[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].supported_networks[]
- Add support for new values
sort_code
andspei
on enumsFundingInstructions.bank_transfer.financial_addresses[].type
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].type
- Change type of
Order#create.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order#update.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,Order.payment.settings.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#confirm.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#create.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
,PaymentIntent#update.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
, andPaymentIntent.payment_method_options.customer_balance.bank_transfer.requested_address_types[]
fromliteral('zengin')
toenum
- Add support for
radar_options
onCharge#create
,Charge
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm
,PaymentIntent#create.payment_method_data
,PaymentIntent#create
,PaymentIntent#update.payment_method_data
,PaymentMethod#create
,PaymentMethod
,SetupIntent#confirm.payment_method_data
,SetupIntent#create.payment_method_data
, andSetupIntent#update.payment_method_data
2022-05-31
- Add support for
account_holder_name
,account_number
,account_type
,bank_code
,bank_name
,branch_code
, andbranch_name
onFundingInstructions.bank_transfer.financial_addresses[].zengin
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].zengin
- Add support for
network
onSetupIntent.payment_method_options.card
- Change type of
Order.payment.settings.payment_method_options.customer_balance.bank_transfer.type
andPaymentIntent.payment_method_options.customer_balance.bank_transfer.type
fromenum
toliteral('jp_bank_transfer')
- Add support for new values
en-AU
anden-NZ
on enumsOrder#create.payment.settings.payment_method_options.klarna.preferred_locale
,Order#update.payment.settings.payment_method_options.klarna.preferred_locale
,PaymentIntent#confirm.payment_method_options.klarna.preferred_locale
,PaymentIntent#create.payment_method_options.klarna.preferred_locale
, andPaymentIntent#update.payment_method_options.klarna.preferred_locale
- Add support for
affirm_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for new value
affirm
on enumCheckout.Session#create.payment_method_types[]
- Change
PaymentIntent.next_action.display_bank_transfer_instructions.hosted_instructions_url
to be required - Add support for new value
simulated_wisepos_e
on enumsTerminal.Reader#list.device_type
andTerminal.Reader.device_type
- Add support for
card_issuing
onTreasury.FinancialAccount#create.features
,Treasury.FinancialAccount#update.features
, andTreasury.FinancialAccount#update_features
- Add support for
id_number_secondary
onAccount#create.individual
,Account#update.individual
,Person#create
,Person#update
,Token#create.account.individual
, andToken#create.person
- Add support for
hosted_instructions_url
onPaymentIntent.next_action.display_bank_transfer_instructions
- Add support for
id_number_secondary_provided
onPerson
- Add support for
persons
method on resourceAccount
- Add support for
balance_transactions
method on resourceCustomer
- Add support for
link_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for new resource
Apps.Secret
- Add support for
treasury
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
link
onCharge.payment_method_details
,Mandate.payment_method_details
,Order#create.payment.settings.payment_method_options
,Order#update.payment.settings.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod#update
,PaymentMethod
,SetupAttempt.payment_method_details
,SetupIntent#confirm.payment_method_data
,SetupIntent#confirm.payment_method_options
,SetupIntent#create.payment_method_data
,SetupIntent#create.payment_method_options
,SetupIntent#update.payment_method_data
,SetupIntent#update.payment_method_options
, andSetupIntent.payment_method_options
- Add support for new value
link
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new value
link
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for new value
link
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,SetupIntent#confirm.payment_method_data.type
,SetupIntent#create.payment_method_data.type
, andSetupIntent#update.payment_method_data.type
- Add support for new value
link
on enumPaymentMethod#create.type
- Add support for new value
link
on enumPaymentMethod.type
- Add support for
affirm
onCharge.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod#update
,PaymentMethod
,SetupIntent#confirm.payment_method_data
,SetupIntent#create.payment_method_data
, andSetupIntent#update.payment_method_data
- Add support for new value
affirm
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new value
affirm
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,SetupIntent#confirm.payment_method_data.type
,SetupIntent#create.payment_method_data.type
, andSetupIntent#update.payment_method_data.type
- Add support for new value
affirm
on enumPaymentMethod#create.type
- Add support for new value
affirm
on enumPaymentMethod.type
- Remove support for resources
Treasury.BillingDetails
andTreasury.InitiatingPaymentMethodDetails
- Change
BillingPortal.Configuration#create.features.customer_update.allowed_updates
to be optional - Add support for
financial_account
onIssuing.Card
- Add support for new values
treasury.credit_reversal.created
,treasury.credit_reversal.posted
,treasury.debit_reversal.completed
,treasury.debit_reversal.created
,treasury.debit_reversal.initial_credit_granted
,treasury.financial_account.closed
,treasury.financial_account.created
,treasury.financial_account.features_status_updated
,treasury.inbound_transfer.canceled
,treasury.inbound_transfer.created
,treasury.inbound_transfer.failed
,treasury.inbound_transfer.succeeded
,treasury.outbound_payment.canceled
,treasury.outbound_payment.created
,treasury.outbound_payment.expected_arrival_date_updated
,treasury.outbound_payment.failed
,treasury.outbound_payment.posted
,treasury.outbound_payment.returned
,treasury.outbound_transfer.canceled
,treasury.outbound_transfer.created
,treasury.outbound_transfer.expected_arrival_date_updated
,treasury.outbound_transfer.failed
,treasury.outbound_transfer.posted
,treasury.outbound_transfer.returned
,treasury.received_credit.created
,treasury.received_credit.failed
,treasury.received_credit.returned
,treasury.received_credit.succeeded
, andtreasury.received_debit.created
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
czk
onTerminal.Configuration#create.tipping
,Terminal.Configuration#update.tipping
, andTerminal.Configuration.tipping
- Change type of
Treasury.FinancialAccountFeatures.object
fromliteral('treasury.financial_account.features')
toliteral('treasury.financial_account_features')
- Add support for new resource
Treasury.FinancialAccountFeatures
- Add support for
retrieve_payment_method
method on resourceCustomer
- Change type of
BillingPortal.Session.return_url
fromstring
tonullable(string)
- Add support for
save_default_payment_method
onSubscription#create.payment_settings
,Subscription#update.payment_settings
, andSubscription.payment_settings
- Change type of
Treasury.FinancialAccount.features
from$Features
to$Treasury.FinancialAccountFeatures
- Add support for new value
issuing_authorization
on enumTreasury.TransactionEntry.flow_type
- Add support for new values
issuing_authorization_hold
andissuing_authorization_release
on enumTreasury.TransactionEntry.type
- Remove support for values
received_hold_release
andreceived_hold
from enumTreasury.TransactionEntry.type
- Add support for
afterpay_clearpay
,au_becs_debit
,bacs_debit
,eps
,fpx
,giropay
,grabpay
,klarna
,paynow
, andsepa_debit
onCheckout.Session.payment_method_options
- Add support for
client_secret
onOrder
- Add support for new resources
Treasury.BillingDetails
,Treasury.CreditReversal
,Treasury.DebitReversal
,Treasury.FinancialAccount
,Treasury.FlowDetails
,Treasury.InboundTransfer
,Treasury.InitiatingPaymentMethodDetails
,Treasury.OutboundPayment
,Treasury.OutboundTransfer
,Treasury.ReceivedCredit
,Treasury.ReceivedDebit
,Treasury.TransactionEntry
, andTreasury.Transaction
- Add support for
list_owners
andlist
methods on resourceFinancialConnections.Account
- Add support for
treasury
onIssuing.Authorization
,Issuing.Dispute#create
,Issuing.Dispute
, andIssuing.Transaction
- Add support for
financial_account
onIssuing.Card#create
- Add support for
networks
onPaymentIntent#confirm.payment_method_options.us_bank_account
,PaymentIntent#create.payment_method_options.us_bank_account
,PaymentIntent#update.payment_method_options.us_bank_account
,PaymentMethod.us_bank_account
,SetupIntent#confirm.payment_method_options.us_bank_account
,SetupIntent#create.payment_method_options.us_bank_account
, andSetupIntent#update.payment_method_options.us_bank_account
- Add support for
attach_to_self
andflow_directions
onSetupIntent
- Add support for
consent_collection
,payment_intent_data
,shipping_options
,submit_type
, andtax_id_collection
onPaymentLink#create
andPaymentLink
- Add support for
customer_creation
onPaymentLink#create
,PaymentLink#update
, andPaymentLink
- Add support for
metadata
onSubscriptionSchedule#create.phases[]
,SubscriptionSchedule#update.phases[]
, andSubscriptionSchedule.phases[]
- Add support for new value
billing_portal.session.created
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
2022-05-06
- Add support for
description
onCheckout.Session#create.subscription_data
,Subscription#create
,Subscription#update
, andSubscription
- Add support for new resource
FinancialConnections.AccountOwnership
- Remove support for resources
OrderItem
andOrderReturn
- Add support for
cancel
,list_line_items
,reopen
, andsubmit
methods on resourceOrder
- Remove support for
pay
andreturn_order
methods on resourceOrder
- Remove support for
order
onCharge
- Change type of
Charge.shipping.name
,Checkout.Session.shipping.name
,Customer.shipping.name
,Invoice.customer_shipping.name
,PaymentIntent.shipping.name
,ShippingDetails.name
, andSource.source_order.shipping.name
fromnullable(string)
tostring
- Change type of
FinancialConnections.Account.ownership
from$Ownership
to$FinancialConnections.AccountOwnership
- Add support for
id
andobject
onFinancialConnections.AccountOwner
- Add support for
amount_discount
,amount_tax
, andproduct
onLineItem
- Add support for
automatic_tax
,billing_details
,description
,discounts
,ip_address
,line_items
,payment
,shipping_cost
,shipping_details
, andtax_details
onOrder#create
,Order#update
, andOrder
- Remove support for
coupon
onOrder#create
andOrder#update
- Remove support for
email
anditems
onOrder#create
andOrder
- Remove support for
shipping
onOrder#create
,Order#update
, andOrder
- Remove support for
created
,ids
, andupstream_ids
onOrder#list
- Remove support for
status
onOrder#list
andOrder#update
- Remove support for
status_transitions
onOrder#list
andOrder
- Add support for
currency
andcustomer
onOrder#update
- Remove support for
selected_shipping_method
onOrder#update
andOrder
- Add support for
amount_subtotal
,amount_total
, andtotal_details
onOrder
- Remove support for
amount_returned
,amount
,application_fee
,charge
,external_coupon_code
,returns
,shipping_methods
,updated
, andupstream_id
onOrder
- Change type of
Order.application
fromstring
toexpandable($Application)
- Change type of
Order.status
fromstring
toenum
- Add support for
instructions_email
onRefund#create
andRefund
- Add support for new resources
FinancialConnections.AccountOwner
,FinancialConnections.Account
, andFinancialConnections.Session
- Add support for
registered_address
onAccount#create.individual
,Account#update.individual
,Person#create
,Person#update
,Person
,Token#create.account.individual
, andToken#create.person
- Add support for
financial_connections
onCheckout.Session#create.payment_method_options.us_bank_account
,Checkout.Session.payment_method_options.us_bank_account
,Invoice#create.payment_settings.payment_method_options.us_bank_account
,Invoice#update.payment_settings.payment_method_options.us_bank_account
,Invoice.payment_settings.payment_method_options.us_bank_account
,PaymentIntent#confirm.payment_method_options.us_bank_account
,PaymentIntent#create.payment_method_options.us_bank_account
,PaymentIntent#update.payment_method_options.us_bank_account
,PaymentIntent.payment_method_options.us_bank_account
,SetupIntent#confirm.payment_method_options.us_bank_account
,SetupIntent#create.payment_method_options.us_bank_account
,SetupIntent#update.payment_method_options.us_bank_account
,SetupIntent.payment_method_options.us_bank_account
,Subscription#create.payment_settings.payment_method_options.us_bank_account
,Subscription#update.payment_settings.payment_method_options.us_bank_account
, andSubscription.payment_settings.payment_method_options.us_bank_account
- Add support for
financial_connections_account
onPaymentIntent#confirm.payment_method_data.us_bank_account
,PaymentIntent#create.payment_method_data.us_bank_account
,PaymentIntent#update.payment_method_data.us_bank_account
,PaymentMethod#create.us_bank_account
,PaymentMethod.us_bank_account
,SetupIntent#confirm.payment_method_data.us_bank_account
,SetupIntent#create.payment_method_data.us_bank_account
, andSetupIntent#update.payment_method_data.us_bank_account
- Add support for
default_price_data
onProduct#create
- Add support for
default_price
onProduct#update
andProduct
- Change type of
PaymentIntent.amount_details.tip.amount
fromnullable(integer)
tointeger
- Change
PaymentIntent.amount_details.tip.amount
to be optional - Add support for
payment_method_data
onSetupIntent#confirm
,SetupIntent#create
, andSetupIntent#update
- Add support for new resource
CashBalance
- Add support for
cash_balance
onCustomer
- Add support for new value
eu_oss_vat
on enumsCheckout.Session.customer_details.tax_ids[].type
,Invoice.customer_tax_ids[].type
, andTaxId.type
- Add support for new value
eu_oss_vat
on enumsCustomer#create.tax_id_data[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
, andTaxId#create.type
- Add support for
application
onInvoice
,Quote
,SubscriptionSchedule
, andSubscription
- Change type of
Checkout.Session#create.payment_method_options.konbini.expires_after_days
fromemptyStringable(integer)
tointeger
- Change type of
BillingPortal.Configuration.application
from$Application
todeletable($Application)
- Add support for
alipay
onCheckout.Session#create.payment_method_options
andCheckout.Session.payment_method_options
- Add support for
expire
test helper method on resourceRefund
- Change
Issuing.Dispute#create.transaction
to be optional - Add support for
create_funding_instructions
method on resourceCustomer
- Remove support for
create
method on resourceFundingInstructions
- Change type of
BillingPortal.Configuration.application
fromstring
toexpandable($Application)
- Remove support for
list
method on resourceFundingInstructions
- Add support for
amount_details
onPaymentIntent
- Add support for
verifone_p400
onTerminal.Configuration#create
,Terminal.Configuration#update
, andTerminal.Configuration
- Remove support for
verifone_P400
onTerminal.Configuration#create
,Terminal.Configuration#update
, andTerminal.Configuration
- Add support for new resource
Terminal.Configuration
- Change type of
FundingInstructions.bank_transfer.financial_addresses[].supported_networks[]
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].supported_networks[]
fromliteral('zengin')
toenum('sepa'|'zengin')
- Change type of
FundingInstructions.bank_transfer.financial_addresses[].type
andPaymentIntent.next_action.display_bank_transfer_instructions.financial_addresses[].type
fromliteral('zengin')
toenum('iban'|'zengin')
- Change type of
FundingInstructions.bank_transfer.type
fromliteral('jp_bank_transfer')
toenum('eu_bank_transfer'|'jp_bank_transfer')
- Add support for
configuration_overrides
onTerminal.Location#create
,Terminal.Location#update
, andTerminal.Location
- Add support for new resource
FundingInstructions
- Add support for
increment_authorization
method on resourcePaymentIntent
- Add support for
customer_balance
onCharge.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
, andPaymentMethod
- Add support for
incremental_authorization_supported
onCharge.payment_method_details.card_present
- Add support for
cash_balance
onCustomer#create
andCustomer#update
- Add support for new value
customer_balance
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new value
customer_balance
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
, andPaymentIntent#update.payment_method_data.type
- Add support for
request_incremental_authorization_support
onPaymentIntent#confirm.payment_method_options.card_present
,PaymentIntent#create.payment_method_options.card_present
,PaymentIntent#update.payment_method_options.card_present
, andPaymentIntent.payment_method_options.card_present
- Add support for
display_bank_transfer_instructions
onPaymentIntent.next_action
- Add support for new value
customer_balance
on enumPaymentMethod#create.type
- Add support for new value
customer_balance
on enumPaymentMethod.type
- Add support for new value
cash_balance.funds_available
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
2022-04-06
- Add support for
apply_customer_balance
method on resourcePaymentIntent
- Add support for
capture_before
onCharge.payment_method_details.card_present
- Remove support for
eu_bank_transfer
onInvoice#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice#update.payment_settings.payment_method_options.customer_balance.bank_transfer
,Invoice.payment_settings.payment_method_options.customer_balance.bank_transfer
,Subscription#create.payment_settings.payment_method_options.customer_balance.bank_transfer
,Subscription#update.payment_settings.payment_method_options.customer_balance.bank_transfer
, andSubscription.payment_settings.payment_method_options.customer_balance.bank_transfer
- Add support for
request_extended_authorization
onPaymentIntent#confirm.payment_method_options.card_present
,PaymentIntent#create.payment_method_options.card_present
,PaymentIntent#update.payment_method_options.card_present
, andPaymentIntent.payment_method_options.card_present
- Add support for
bank_transfer_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
address
andname
onCheckout.Session.customer_details
- Add support for
customer_balance
onInvoice#create.payment_settings.payment_method_options
,Invoice#update.payment_settings.payment_method_options
,Invoice.payment_settings.payment_method_options
,Subscription#create.payment_settings.payment_method_options
,Subscription#update.payment_settings.payment_method_options
, andSubscription.payment_settings.payment_method_options
- Add support for new value
customer_balance
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for new values
payment_intent.partially_funded
,terminal.reader.action_failed
, andterminal.reader.action_succeeded
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Change
Charge.failure_balance_transaction
,Invoice.payment_settings.payment_method_options.us_bank_account
,PaymentIntent.next_action.verify_with_microdeposits.microdeposit_type
,SetupIntent.next_action.verify_with_microdeposits.microdeposit_type
, andSubscription.payment_settings.payment_method_options.us_bank_account
to be required - Add support for
search
method on resourcesCharge
,Customer
,Invoice
,PaymentIntent
,Price
,Product
, andSubscription
- Add support for
cancel_action
,process_payment_intent
,process_setup_intent
, andset_reader_display
methods on resourceTerminal.Reader
- Add support for
us_bank_account_ach_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
action
onTerminal.Reader
- Add support for
paynow_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
failure_balance_transaction
onCharge
- Add support for
paynow
onCharge.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
, andPaymentMethod
- Add support for
us_bank_account
onCharge.payment_method_details
,Checkout.Session#create.payment_method_options
,Checkout.Session.payment_method_options
,Invoice#create.payment_settings.payment_method_options
,Invoice#update.payment_settings.payment_method_options
,Invoice.payment_settings.payment_method_options
,Mandate.payment_method_details
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod#update
,PaymentMethod
,SetupAttempt.payment_method_details
,SetupIntent#confirm.payment_method_options
,SetupIntent#create.payment_method_options
,SetupIntent#update.payment_method_options
,SetupIntent.payment_method_options
,Subscription#create.payment_settings.payment_method_options
,Subscription#update.payment_settings.payment_method_options
, andSubscription.payment_settings.payment_method_options
- Add support for new values
paynow
andus_bank_account
on enumsCheckout.Session#create.payment_method_types[]
andPaymentMethod#create.type
- Add support for new values
paynow
andus_bank_account
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new values
paynow
andus_bank_account
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for new values
paynow
andus_bank_account
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
, andPaymentIntent#update.payment_method_data.type
- Add support for
descriptor_code
onPaymentIntent#verify_microdeposits
andSetupIntent#verify_microdeposits
- Add support for
paynow_display_qr_code
onPaymentIntent.next_action
- Add support for
microdeposit_type
onPaymentIntent.next_action.verify_with_microdeposits
andSetupIntent.next_action.verify_with_microdeposits
- Add support for
verification_method
onPaymentIntentTypeSpecificPaymentMethodOptionsClient
andSetupIntentTypeSpecificPaymentMethodOptionsClient
- Add support for new values
paynow
andus_bank_account
on enumPaymentMethod.type
- Add support for
test_clock
onSubscription#list
- Add support for new values
bg_uic
,hu_tin
, andsi_tin
on enumsCheckout.Session.customer_details.tax_ids[].type
,Invoice.customer_tax_ids[].type
, andTaxId.type
- Add support for new values
bg_uic
,hu_tin
, andsi_tin
on enumsCustomer#create.tax_id_data[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
, andTaxId#create.type
- Add support for
capture_method
onPaymentIntent#confirm.payment_method_options.afterpay_clearpay
,PaymentIntent#confirm.payment_method_options.card
,PaymentIntent#confirm.payment_method_options.klarna
,PaymentIntent#create.payment_method_options.afterpay_clearpay
,PaymentIntent#create.payment_method_options.card
,PaymentIntent#create.payment_method_options.klarna
,PaymentIntent#update.payment_method_options.afterpay_clearpay
,PaymentIntent#update.payment_method_options.card
,PaymentIntent#update.payment_method_options.klarna
,PaymentIntent.payment_method_options.afterpay_clearpay
,PaymentIntent.payment_method_options.card
,PaymentIntent.payment_method_options.klarna
, andPaymentIntentTypeSpecificPaymentMethodOptionsClient
- Add support for
test_clock
onQuote#list
- Change
Invoice#create.customer
to be optional - Add support for new values
test_helpers.test_clock.advancing
,test_helpers.test_clock.created
,test_helpers.test_clock.deleted
,test_helpers.test_clock.internal_failure
, andtest_helpers.test_clock.ready
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
cancel
method on resourceRefund
- Add support for
status
onCard
- Add support for
mandate
onCharge.payment_method_details.card
- Add support for
mandate_options
onPaymentIntent#confirm.payment_method_options.card
,PaymentIntent#create.payment_method_options.card
,PaymentIntent#update.payment_method_options.card
,PaymentIntent.payment_method_options.card
,SetupIntent#confirm.payment_method_options.card
,SetupIntent#create.payment_method_options.card
,SetupIntent#update.payment_method_options.card
, andSetupIntent.payment_method_options.card
- Add support for
card_await_notification
onPaymentIntent.next_action
- Add support for
customer_notification
onPaymentIntent.processing.card
- Change
PaymentLink#create.line_items
to be required - Add support for
test_clock
onCustomer#list
- Change
Invoice.test_clock
,InvoiceItem.test_clock
,Quote.test_clock
,Subscription.test_clock
, andSubscriptionSchedule.test_clock
to be required - Add support for new resources
CreditedItems
andProrationDetails
- Add support for
proration_details
onInvoiceLineItem
- Add support for
next_action
onRefund
- Add support for
deletes_after
onTestHelpers.TestClock
- Add support for new resource
TestHelpers.TestClock
- Add support for
test_clock
onCustomer#create
,Customer
,InvoiceItem
,Invoice
,Quote#create
,Quote
,SubscriptionSchedule
, andSubscription
- Add support for
pending_invoice_items_behavior
onInvoice#create
- Change type of
Product#update.url
fromstring
toemptyStringable(string)
- Add support for
konbini_payments
onAccount#create.capabilities
,Account#update.capabilities
, andAccount.capabilities
- Add support for
konbini
onCharge.payment_method_details
,Checkout.Session#create.payment_method_options
,Checkout.Session.payment_method_options
,Invoice#create.payment_settings.payment_method_options
,Invoice#update.payment_settings.payment_method_options
,Invoice.payment_settings.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
,PaymentMethod
,Subscription#create.payment_settings.payment_method_options
,Subscription#update.payment_settings.payment_method_options
, andSubscription.payment_settings.payment_method_options
- Add support for new value
konbini
on enumsCheckout.Session#create.payment_method_types[]
andPaymentMethod#create.type
- Add support for new value
konbini
on enumsCustomer#list_payment_methods.type
andPaymentMethod#list.type
- Add support for new value
konbini
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for new value
konbini
on enumsPaymentIntent#confirm.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
, andPaymentIntent#update.payment_method_data.type
- Add support for
konbini_display_details
onPaymentIntent.next_action
- Add support for new value
konbini
on enumPaymentMethod.type
- Add support for new resource
SetupIntentTypeSpecificPaymentMethodOptionsClient
- Change
BillingPortal.Configuration#create.business_profile.privacy_policy_url
andBillingPortal.Configuration#create.business_profile.terms_of_service_url
to be optional - Change type of
BillingPortal.Configuration#update.business_profile.privacy_policy_url
andBillingPortal.Configuration#update.business_profile.terms_of_service_url
fromstring
toemptyStringable(string)
- Change type of
BillingPortal.Configuration.business_profile.privacy_policy_url
andBillingPortal.Configuration.business_profile.terms_of_service_url
fromstring
tonullable(string)
- Add support for
setup_future_usage
onPaymentIntent#confirm.payment_method_options.acss_debit
,PaymentIntent#confirm.payment_method_options.afterpay_clearpay
,PaymentIntent#confirm.payment_method_options.alipay
,PaymentIntent#confirm.payment_method_options.au_becs_debit
,PaymentIntent#confirm.payment_method_options.bacs_debit
,PaymentIntent#confirm.payment_method_options.bancontact
,PaymentIntent#confirm.payment_method_options.boleto
,PaymentIntent#confirm.payment_method_options.eps
,PaymentIntent#confirm.payment_method_options.fpx
,PaymentIntent#confirm.payment_method_options.giropay
,PaymentIntent#confirm.payment_method_options.grabpay
,PaymentIntent#confirm.payment_method_options.ideal
,PaymentIntent#confirm.payment_method_options.klarna
,PaymentIntent#confirm.payment_method_options.oxxo
,PaymentIntent#confirm.payment_method_options.p24
,PaymentIntent#confirm.payment_method_options.sepa_debit
,PaymentIntent#confirm.payment_method_options.sofort
,PaymentIntent#confirm.payment_method_options.wechat_pay
,PaymentIntent#create.payment_method_options.acss_debit
,PaymentIntent#create.payment_method_options.afterpay_clearpay
,PaymentIntent#create.payment_method_options.alipay
,PaymentIntent#create.payment_method_options.au_becs_debit
,PaymentIntent#create.payment_method_options.bacs_debit
,PaymentIntent#create.payment_method_options.bancontact
,PaymentIntent#create.payment_method_options.boleto
,PaymentIntent#create.payment_method_options.eps
,PaymentIntent#create.payment_method_options.fpx
,PaymentIntent#create.payment_method_options.giropay
,PaymentIntent#create.payment_method_options.grabpay
,PaymentIntent#create.payment_method_options.ideal
,PaymentIntent#create.payment_method_options.klarna
,PaymentIntent#create.payment_method_options.oxxo
,PaymentIntent#create.payment_method_options.p24
,PaymentIntent#create.payment_method_options.sepa_debit
,PaymentIntent#create.payment_method_options.sofort
,PaymentIntent#create.payment_method_options.wechat_pay
,PaymentIntent#update.payment_method_options.acss_debit
,PaymentIntent#update.payment_method_options.afterpay_clearpay
,PaymentIntent#update.payment_method_options.alipay
,PaymentIntent#update.payment_method_options.au_becs_debit
,PaymentIntent#update.payment_method_options.bacs_debit
,PaymentIntent#update.payment_method_options.bancontact
,PaymentIntent#update.payment_method_options.boleto
,PaymentIntent#update.payment_method_options.eps
,PaymentIntent#update.payment_method_options.fpx
,PaymentIntent#update.payment_method_options.giropay
,PaymentIntent#update.payment_method_options.grabpay
,PaymentIntent#update.payment_method_options.ideal
,PaymentIntent#update.payment_method_options.klarna
,PaymentIntent#update.payment_method_options.oxxo
,PaymentIntent#update.payment_method_options.p24
,PaymentIntent#update.payment_method_options.sepa_debit
,PaymentIntent#update.payment_method_options.sofort
,PaymentIntent#update.payment_method_options.wechat_pay
,PaymentIntent.payment_method_options.acss_debit
,PaymentIntent.payment_method_options.afterpay_clearpay
,PaymentIntent.payment_method_options.alipay
,PaymentIntent.payment_method_options.au_becs_debit
,PaymentIntent.payment_method_options.bacs_debit
,PaymentIntent.payment_method_options.bancontact
,PaymentIntent.payment_method_options.boleto
,PaymentIntent.payment_method_options.eps
,PaymentIntent.payment_method_options.fpx
,PaymentIntent.payment_method_options.giropay
,PaymentIntent.payment_method_options.grabpay
,PaymentIntent.payment_method_options.ideal
,PaymentIntent.payment_method_options.klarna
,PaymentIntent.payment_method_options.oxxo
,PaymentIntent.payment_method_options.p24
,PaymentIntent.payment_method_options.sepa_debit
,PaymentIntent.payment_method_options.sofort
, andPaymentIntent.payment_method_options.wechat_pay
- Add support for new values
bbpos_wisepad3
andstripe_m2
on enumsTerminal.Reader#list.device_type
andTerminal.Reader.device_type
- Add support for
verify_microdeposits
method on resourcesPaymentIntent
andSetupIntent
- Add support for new value
grabpay
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for
pin
onIssuing.Card#update
- Change type of
Refund.reason
fromstring
toenum('duplicate'|'expired_uncaptured_charge'|'fraudulent'|'requested_by_customer')
2022-01-26
- Add support for new value
au_becs_debit
on enumCheckout.Session#create.payment_method_types[]
- Add support for new value
is_vat
on enumsCheckout.Session.customer_details.tax_ids[].type
,Invoice.customer_tax_ids[].type
, andTaxId.type
- Change
Checkout.Session.payment_link
to be required - Add support for new value
is_vat
on enumsCustomer#create.tax_id_data[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
, andTaxId#create.type
- Add support for
phone_number_collection
onPaymentLink#create
andPaymentLink
- Add support for new values
payment_link.created
andpayment_link.updated
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for new resource
PaymentLink
- Add support for
payment_link
onCheckout.Session
- Add support for
image_url_png
andimage_url_svg
onPaymentIntent.next_action.wechat_pay_display_qr_code
- Change type of
Charge.status
fromstring
toenum('failed'|'pending'|'succeeded')
- Add support for
bacs_debit
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for
eps
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for
customer_creation
onCheckout.Session#create
andCheckout.Session
- Add support for
paid_out_of_band
onInvoice
- Add support for
fpx
andgrabpay
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for
mandate_options
onSubscription#create.payment_settings.payment_method_options.card
,Subscription#update.payment_settings.payment_method_options.card
, andSubscription.payment_settings.payment_method_options.card
- Change type of
PaymentIntent.processing.type
fromstring
toliteral('card')
- Add support for
au_becs_debit
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for new values
en-FR
,es-US
, andfr-FR
on enumsPaymentIntent#create.payment_method_options.klarna.preferred_locale
,PaymentIntent#update.payment_method_options.klarna.preferred_locale
, andPaymentIntent#confirm.payment_method_options.klarna.preferred_locale
- Add support for
boleto
onSetupAttempt.payment_method_details
- Add support for
processing
onPaymentIntent
2021-12-15
- Add support for new resource
PaymentIntentTypeSpecificPaymentMethodOptionsClient
- Add support for
setup_future_usage
onPaymentIntent#create.payment_method_options.card
,PaymentIntent#update.payment_method_options.card
,PaymentIntent#confirm.payment_method_options.card
, andPaymentIntent.payment_method_options.card
- Add support for
metadata
onBillingPortal.Configuration#create
,BillingPortal.Configuration#update
, andBillingPortal.Configuration
- Add support for new values
ge_vat
andua_vat
on enumsCheckout.Session.customer_details.tax_ids[].type
,Invoice.customer_tax_ids[].type
, andTaxId.type
- Add support for new values
ge_vat
andua_vat
on enumsCustomer#create.tax_id_data[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
, andTaxId#create.type
- Add support for new value
en-IE
on enumsPaymentIntent#create.payment_method_options.klarna.preferred_locale
,PaymentIntent#update.payment_method_options.klarna.preferred_locale
, andPaymentIntent#confirm.payment_method_options.klarna.preferred_locale
- Change type of
PaymentIntent#create.payment_method_data.billing_details.email
,PaymentIntent#update.payment_method_data.billing_details.email
,PaymentIntent#confirm.payment_method_data.billing_details.email
,PaymentMethod#create.billing_details.email
, andPaymentMethod#update.billing_details.email
fromstring
toemptyStringable(string)
- Add support for
giropay
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for
wallets
onIssuing.Card
- Add support for new value
jct
on enumsTaxRate#create.tax_type
,TaxRate#update.tax_type
, andTaxRate.tax_type
- Add support for new resource
AutomaticPaymentMethodsPaymentIntent
- Add support for
automatic_payment_methods
onPaymentIntent#create
andPaymentIntent
- Add support for new resource
ShippingRate
- Add support for
shipping_options
onCheckout.Session#create
andCheckout.Session
- Add support for
shipping_rate
onCheckout.Session
- Add support for
interac_present
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Add support for new value
agrobank
on enumsCharge.payment_method_details.fpx.bank
,PaymentIntent#create.payment_method_data.fpx.bank
,PaymentIntent#update.payment_method_data.fpx.bank
,PaymentIntent#confirm.payment_method_data.fpx.bank
,PaymentMethod#create.fpx.bank
, andPaymentMethod.fpx.bank
- Add support for
expire
method on resourceCheckout.Session
- Add support for
status
onCheckout.Session
- Remove support for
ownership_declaration_shown_and_signed
onToken#create.account
- Add support for
ownership_declaration_shown_and_signed
onToken#create.account.company
2021-11-01
- Add support for
ownership_declaration
onAccount#update.company
,Account#create.company
,Account.company
, andToken#create.account.company
- Add support for
proof_of_registration
onAccount#update.documents
andAccount#create.documents
- Change type of
Account#update.individual.full_name_aliases
,Account#create.individual.full_name_aliases
,Person#create.full_name_aliases
,Person#update.full_name_aliases
,Token#create.account.individual.full_name_aliases
, andToken#create.person.full_name_aliases
fromarray(string)
toemptyStringable(array(string))
- Add support for
ownership_declaration_shown_and_signed
onToken#create.account
- Add support for new values
en-BE
,en-ES
, anden-IT
on enumsPaymentIntent#create.payment_method_options.klarna.preferred_locale
,PaymentIntent#update.payment_method_options.klarna.preferred_locale
, andPaymentIntent#confirm.payment_method_options.klarna.preferred_locale
- Add support for
buyer_id
onCharge.payment_method_details.alipay
- Change
Account.controller.type
to be required - Change type of
UsageRecord#create.timestamp
frominteger
toliteral('now') | integer
- Change
UsageRecord#create.timestamp
to be optional - Change
Checkout.Session.customer_details.phone
to be required - Add support for new value
klarna
on enumCheckout.Session#create.payment_method_types[]
- Change
Checkout.Session.customer_details.phone
to be optional - Change
Charge.payment_method_details.klarna.payment_method_category
,Charge.payment_method_details.klarna.preferred_locale
,Checkout.Session.customer_details.phone
, andPaymentMethod.klarna.dob
to be required - Add support for
list_payment_methods
method on resourceCustomer
- Add support for
payment_method_category
andpreferred_locale
onCharge.payment_method_details.klarna
- Add support for
klarna
onPaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
, andPaymentMethod
- Add support for new value
klarna
on enumsPaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
, andPaymentIntent#confirm.payment_method_data.type
- Add support for new value
klarna
on enumPaymentMethod#create.type
- Add support for new value
klarna
on enumPaymentMethod#list.type
- Add support for new value
klarna
on enumPaymentMethod.type
- Add support for
phone_number_collection
onCheckout.Session#create
andCheckout.Session
- Add support for
phone
onCheckout.Session.customer_details
- Add support for new value
customer_id
on enumsRadar.ValueList#create.item_type
andRadar.ValueList.item_type
- Add support for new value
bbpos_wisepos_e
on enumsTerminal.Reader#list.device_type
andTerminal.Reader.device_type
- Change
PaymentMethod#list.customer
to be optional - Add support for
klarna_payments
onAccount#update.capabilities
,Account#create.capabilities
, andAccount.capabilities
- Add support for
amount_authorized
andovercapture_supported
onCharge.payment_method_details.card_present
2021-09-20
- Add support for
full_name_aliases
onAccount#update.individual
,Account#create.individual
,Person#create
,Person#update
,Person
,Token#create.account.individual
, andToken#create.person
- Change
BillingPortal.Configuration.features.subscription_cancel.cancellation_reason
to be required - Add support for
default_for
onCheckout.Session#create.payment_method_options.acss_debit.mandate_options
,Checkout.Session.payment_method_options.acss_debit.mandate_options
,Mandate.payment_method_details.acss_debit
,SetupIntent#create.payment_method_options.acss_debit.mandate_options
,SetupIntent#update.payment_method_options.acss_debit.mandate_options
,SetupIntent#confirm.payment_method_options.acss_debit.mandate_options
, andSetupIntent.payment_method_options.acss_debit.mandate_options
- Add support for
acss_debit
onInvoice#create.payment_settings.payment_method_options
,Invoice#update.payment_settings.payment_method_options
,Invoice.payment_settings.payment_method_options
,Subscription#create.payment_settings.payment_method_options
,Subscription#update.payment_settings.payment_method_options
, andSubscription.payment_settings.payment_method_options
- Add support for new value
acss_debit
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
,Invoice.payment_settings.payment_method_types[]
,Subscription#create.payment_settings.payment_method_types[]
,Subscription#update.payment_settings.payment_method_types[]
, andSubscription.payment_settings.payment_method_types[]
- Add support for
livemode
onReporting.ReportType
- Add support for new value
rst
on enumsTaxRate#create.tax_type
,TaxRate#update.tax_type
, andTaxRate.tax_type
- Change
Checkout.Session.after_expiration
,Checkout.Session.consent
,Checkout.Session.consent_collection
,Checkout.Session.expires_at
, andCheckout.Session.recovered_from
to be required - Add support for new value
checkout.session.expired
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Change
Account.future_requirements.alternatives
,Account.requirements.alternatives
,Capability.future_requirements.alternatives
,Capability.requirements.alternatives
,Person.future_requirements.alternatives
, andPerson.requirements.alternatives
to be required - Change type of
Capability.future_requirements.alternatives
,Capability.requirements.alternatives
,Person.future_requirements.alternatives
, andPerson.requirements.alternatives
fromarray(AccountRequirementsAlternative)
tonullable(array(AccountRequirementsAlternative))
- Add support for
future_requirements
onAccount
,Capability
, andPerson
- Add support for
alternatives
onAccount.requirements
,Capability.requirements
, andPerson.requirements
- Change type of
Checkout.Session.after_expiration.recovery.allow_promotion_codes
andCheckout.Session.after_expiration.recovery.enabled
fromnullable(boolean)
toboolean
- Add support for
after_expiration
,consent_collection
, andexpires_at
onCheckout.Session#create
andCheckout.Session
- Add support for
consent
andrecovered_from
onCheckout.Session
- Change type of
BillingPortal.Configuration#create.features.subscription_cancel.cancellation_reason.options[]
,BillingPortal.Configuration#update.features.subscription_cancel.cancellation_reason.options[]
, andBillingPortal.Configuration.features.subscription_cancel.cancellation_reason.options[]
fromstring
toenum
- Add support for
cancellation_reason
onBillingPortal.Configuration.features.subscription_cancel
- Add support for
cancellation_reason
onBillingPortal.Configuration#create.features.subscription_cancel
andBillingPortal.Configuration#update.features.subscription_cancel
2021-08-26
- Add support for
category_code
onIssuing.Authorization.merchant_data
andIssuing.Transaction.merchant_data
- Add support for new value
redacted
on enumReview.closed_reason
- Add support for new values
hr
,ko
, andvi
on enumsCheckout.Session#create.locale
andCheckout.Session.locale
2021-07-20
- Add support for
ideal
onPaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_options
, andPaymentIntent.payment_method_options
- Remove support for values
api_connection_error
,authentication_error
, andrate_limit_error
from enumsStripeError.type
,StripeErrorResponse.error.type
,Invoice.last_finalization_error.type
,PaymentIntent.last_payment_error.type
,SetupAttempt.setup_error.type
, andSetupIntent.last_setup_error.type
- Add support for new values
quote.accepted
,quote.canceled
,quote.created
, andquote.finalized
on enumsWebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
- Add support for
list_computed_upfront_line_items
method on resourceQuote
- Add support for
finalize_quote
method on resourceQuote
- Remove support for
finalize
method on resourceQuote
- Add support for new resource
Quote
- Add support for
quote
onInvoice
- Add support for new value
quote_accept
on enumInvoice.billing_reason
- Changed type of
Charge.payment_method_details.card.three_d_secure.result
andSetupAttempt.payment_method_details.card.three_d_secure.result
fromenum
tonullable(enum)
- Changed type of
Charge.payment_method_details.card.three_d_secure.version
andSetupAttempt.payment_method_details.card.three_d_secure.version
fromenum('1.0.2'|'2.1.0'|'2.2.0')
tonullable(enum('1.0.2'|'2.1.0'|'2.2.0'))
- Add support for new value
boleto
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
, andInvoice.payment_settings.payment_method_types[]
- Add support for
boleto_payments
onAccount#update.capabilities
,Account#create.capabilities
, andAccount.capabilities
- Add support for
wechat_pay
onCharge.payment_method_details
,Checkout.Session#create.payment_method_options
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
, andPaymentMethod
- Add support for
boleto
andoxxo
onCheckout.Session#create.payment_method_options
andCheckout.Session.payment_method_options
- Add support for new values
boleto
,oxxo
, andwechat_pay
on enumCheckout.Session#create.payment_method_types[]
- Add support for new value
wechat_pay
on enumsInvoice#create.payment_settings.payment_method_types[]
,Invoice#update.payment_settings.payment_method_types[]
, andInvoice.payment_settings.payment_method_types[]
- Add support for new value
wechat_pay
on enumsPaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
, andPaymentIntent#confirm.payment_method_data.type
- Add support for
wechat_pay_display_qr_code
,wechat_pay_redirect_to_android_app
, andwechat_pay_redirect_to_ios_app
onPaymentIntent.next_action
- Add support for new value
wechat_pay
on enumPaymentMethod#create.type
- Add support for new value
wechat_pay
on enumPaymentMethod#list.type
- Add support for new value
wechat_pay
on enumPaymentMethod.type
- Add support for
boleto
onCharge.payment_method_details
,PaymentIntent#create.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#confirm.payment_method_options
,PaymentIntent.payment_method_options
,PaymentMethod#create
, andPaymentMethod
- Add support for new value
boleto
on enumsPaymentIntent#create.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
, andPaymentIntent#confirm.payment_method_data.type
- Add support for
boleto_display_details
onPaymentIntent.next_action
- Add support for new value
boleto
on enumPaymentMethod#create.type
- Add support for new value
boleto
on enumPaymentMethod#list.type
- Add support for new value
boleto
on enumPaymentMethod.type
- Collection updates:
- Fixed issue where nested dictionary child parameters weren't being populated
2021-06-22
TaxId#create.type
,Invoice.customer_tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Customer#create.tax_id_data[].type
,Checkout.Session.customer_details.tax_ids[].type
andTaxId.type
added new enum members:il_vat
(breaking change)TaxId#create.type
,Invoice.customer_tax_ids[].type
,Invoice#upcomingLines.customer_details.tax_ids[].type
,Invoice#upcoming.customer_details.tax_ids[].type
,Customer#create.tax_id_data[].type
,Checkout.Session.customer_details.tax_ids[].type
andTaxId.type
added new enum members:ca_pst_mb, ca_pst_bc, ca_gst_hst and ca_pst_sk
(breaking change)- Added support for
url
onCheckout.Session
- Added support for
tax_id_collection
onSession#create
andCheckout.Session
Terminal.Reader.location
changed fromstring
toexpandable($Terminal.Location)
(breaking change)- Added support for
controller
onAccount
- Added support for new resource
TaxCode
- Added support for
automatic_tax
onSubscriptionSchedule.default_settings
,SubscriptionSchedule#update.phases[]
,SubscriptionSchedule#update.default_settings
,SubscriptionSchedule#create.phases[]
,SubscriptionSchedule#create.default_settings
,Subscription
,Subscription#update
,Subscription#create
,Invoice
,Invoice#upcomingLines
,Invoice#update
,Invoice#upcoming
,Invoice#create
,Checkout.Session
,Session#create
andSubscriptionSchedule.phases[]
- Added support for
customer_update
onSession#create
- Added support for
tax_behavior
onSubscriptionSchedule#update.phases[].add_invoice_items[].price_data
,SubscriptionSchedule#create.phases[].items[].price_data
,SubscriptionSchedule#create.phases[].add_invoice_items[].price_data
,SubscriptionItem#update.price_data
,SubscriptionItem#create.price_data
,Subscription#update.items[].price_data
,Subscription#update.add_invoice_items[].price_data
,Subscription#create.items[].price_data
,Subscription#create.add_invoice_items[].price_data
,Price
,Price#update
,Price#create
,InvoiceItem#update.price_data
,InvoiceItem#create.price_data
,Invoice#upcomingLines.subscription_items[].price_data
,Invoice#upcomingLines.invoice_items[].price_data
,Invoice#upcoming.subscription_items[].price_data
,Invoice#upcoming.invoice_items[].price_data
,Session#create.line_items[].price_data
andSubscriptionSchedule#update.phases[].items[].price_data
- Added support for
tax_code
onProduct#update
,Product#create
,Price#create.product_data
,Plan#create.product[0]
,Session#create.line_items[].price_data.product_data
andProduct
- Added support for
tax
onCustomer#update
,Customer#create
andCustomer
- Added support for
customer_details
onInvoice#upcoming
andInvoice#upcomingLines
- Added support for
tax_type
onTaxRate#update
,TaxRate#create
andTaxRate
- Collection updates:
- Fixed issue where some required parameters weren't being selected by default in the request
- Fixed typos in request names
2021-06-02
Account.company.structure
,Account#create.company.structure
,Account#update.company.structure
andToken#create.account.company.structure
added new enum members:llc, free_zone_llc, free_zone_establishment and sole_establishment
(breaking change)- Added support for
documents
onPerson#update
,Person#create
andToken#create.person
WebhookEndpoint#create.enabled_events[]
andWebhookEndpoint#update.enabled_events[]
added new enum members:identity.verification_session.requires_input, identity.verification_session.redacted, identity.verification_session.processing, identity.verification_session.created, identity.verification_session.canceled and identity.verification_session.verified
- Added support for
acss_debit
onPaymentMethod#update
Identity.VerificationReport.created
changed frominteger
toDateTime
(breaking change)Identity.VerificationSession.client_secret
changed fromstring
tonullable(string)
(breaking change)- Added support for new resource
Identity.VerificationReport
- Added support for new resource
Identity.VerificationSession
File#list.purpose
andFile.purpose
added new enum members:identity_document_downloadable and selfie
(breaking change)- Removed support for method:
PaymentIntent#verify_microdeposits
(breaking change) - Removed support for method:
SetupIntent#verify_microdeposits
(breaking change) - New method:
PaymentIntent#verify_microdeposits
- New method:
SetupIntent#verify_microdeposits
Account#update.business_profile.support_url
andAccount#create.business_profile.support_url
changed fromstring
toemptyStringable(string)
2021-05-19
- Added support for
reference
onCharge.payment_method_details.afterpay_clearpay
- Added support for
afterpay_clearpay
onPaymentIntent#confirm.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#create.payment_method_options
andPaymentIntent.payment_method_options
File.purpose
added new enum members:finance_report_run, document_provider_identity_document and sigma_scheduled_query
(breaking change)- Added support for
payment_intent
onEarlyFraudWarning#list
andRadar.EarlyFraudWarning
SubscriptionItem#create.payment_behavior
,Subscription#update.payment_behavior
,Subscription#create.payment_behavior
andSubscriptionItem#update.payment_behavior
added new enum members:default_incomplete
- Added support for
card_present
onPaymentIntent#confirm.payment_method_options
,PaymentIntent#update.payment_method_options
,PaymentIntent#create.payment_method_options
andPaymentIntent.payment_method_options
- Added support for
currency
onCheckout.Session.payment_method_options.acss_debit
Account.company.structure
,Account#create.company.structure
,Account#update.company.structure
andToken#create.account.company.structure
added new enum members:single_member_llc
(breaking change)Issuing.Card.shipping.carrier
added new enum members:dhl and royal_mail
(breaking change)- Removed support for the
PaymentPagesCheckoutSessionCheckoutSessionResourcePaymentMethodOptions
resource. (breaking change) - Added support for
acss_debit_payments
onAccount#create.capabilities
,Account#update.capabilities
andAccount.capabilities
- Added support for
acss_debit
onSetupIntent#confirm.payment_method_options
,SetupIntent#update.payment_method_options
,SetupIntent#create.payment_method_options
,SetupAttempt.payment_method_details
,PaymentMethod
,PaymentMethod#create
,PaymentIntent.payment_method_options
,PaymentIntent#confirm.payment_method_options
,PaymentIntent#confirm.payment_method_data
,PaymentIntent#update.payment_method_options
,PaymentIntent#update.payment_method_data
,PaymentIntent#create.payment_method_options
,PaymentIntent#create.payment_method_data
,Mandate.payment_method_details
,Session#create.payment_method_options
andSetupIntent.payment_method_options
- Added support for
verify_with_microdeposits
onPaymentIntent.next_action
andSetupIntent.next_action
PaymentMethod#list.type
,PaymentMethod#create.type
,PaymentIntent#confirm.payment_method_data.type
,PaymentIntent#update.payment_method_data.type
,PaymentIntent#create.payment_method_data.type
,Session#create.payment_method_types[]
andPaymentMethod.type
added new enum members:acss_debit
(breaking change)Checkout.Session.payment_method_options
changed fromCheckoutSessionPaymentMethodOptionsForPayment | CheckoutSessionPaymentMethodOptionsForSetup
toCheckoutSessionPaymentMethodOptionsForPayment
(breaking change)- Added support for new resource
PaymentPagesCheckoutSessionCheckoutSessionResourcePaymentMethodOptions
- Added support for
subscription_pause
onConfiguration#update.features
,Configuration#create.features
andBillingPortal.Configuration.features
- Added support for
payment_method_options
onSession#create
andCheckout.Session
- Added support for
transfer_data
onSession#create.subscription_data
- Added support for
card_issuing
onAccount#create.settings
,Account#update.settings
andAccount.settings
Capability.requirements.errors[].code
,Account.requirements.errors[].code
andPerson.requirements.errors[].code
added new enum members:verification_missing_owners, verification_missing_executives and verification_requires_additional_memorandum_of_associations
(breaking change)Session#create.locale
andCheckout.Session.locale
added new enum members:th
(breaking change) ### 03-17-21 Initial collection ## Get support
If you found a bug or want to suggest a new feature, please file an issue.
-
Balance Transactions - Retrieve a balance transaction GET {{baseUrl}}/v1/balance_transactions/:id
-
Charges - Update a charge POST {{baseUrl}}/v1/charges/:charge
-
Checkout - List all Checkout Sessions GET {{baseUrl}}/v1/checkout/sessions
-
Checkout - Retrieve a Session GET {{baseUrl}}/v1/checkout/sessions/:session
-
Financial Connections Sessions - Create a Session POST {{baseUrl}}/v1/financial_connections/sessions
-
Invoice Items - Update an invoice item POST {{baseUrl}}/v1/invoiceitems/:invoiceitem
-
Issuing Transactions - List all transactions GET {{baseUrl}}/v1/issuing/transactions
-
Payment Intents - Create a PaymentIntent POST {{baseUrl}}/v1/payment_intents
-
Payment Intents - Verify microdeposits on a PaymentIntent POST {{baseUrl}}/v1/payment_intents/:intent/verify_microdeposits
-
Quotes - Update a quote POST {{baseUrl}}/v1/quotes/:quote