Immediately invalidate an ephemeral key

Invalidates a short-lived API key for a given resource.

delete/v1/ephemeral_keys/{key}

Path parameters

keystring required

Response

Successful response.

createdinteger required

Time at which the object was created. Measured in seconds since the Unix epoch.

expiresinteger required

Time at which the key will expire. Measured in seconds since the Unix epoch.

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

object'ephemeral_key' required

String representing the object's type. Objects of the same type share the same value.

secretstring

The key's secret. You can use this value to make authorized requests to the Stripe API.

Changes

Changed in 14 of the 51 revisions of this API.194937

Jul 1, 2026e24a26de41883See the full diff
- ▲
  removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status
  response-required-property-removed
- ▲
  removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status
  response-required-property-removed
- ▲
  removed the required property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/payment_method_details/card/network from the response with the default status
  response-required-property-removed
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Dec 11, 2025f83e937202596See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/acss_debit/expected_debit_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/au_becs_debit/expected_debit_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/bacs_debit/expected_debit_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/nz_bank_account/expected_debit_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/sepa_debit/expected_debit_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/us_bank_account/expected_debit_date to the response with the default status
  response-optional-property-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Nov 5, 202562e8dc4ed8691See the full diff
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status
  response-optional-property-added
Oct 22, 20251e483c60b4801See the full diff
- ○
  added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status
  response-optional-property-added
Sep 25, 2025eb1ac21ec19c5See the full diff
- ●
  removed the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypay from the response with the default status
  response-optional-property-removed
- ●
  removed the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/paypay from the response with the default status
  response-optional-property-removed
- ●
  added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default
  response-property-enum-value-added
- ●
  added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default
  response-property-enum-value-added
- ●
  added the new prevented enum value to the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #6: Dispute]/status response property for the response status default
  response-property-enum-value-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Aug 19, 20257b79777e9bbd2See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status
  response-optional-property-added
Jul 22, 2025c4dc6dbe947e1See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status
  response-optional-property-added
May 22, 20252df8ec106d357See the full diff
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/destination_details/paypal/network_decline_code to the response with the default status
  response-optional-property-added
This revision's changelog hit the recording limit, so it may not list every change to this endpoint.
Feb 14, 20251199cc3c557429See the full diff
- ▲
  the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default
  response-property-became-optional
- ▲
  the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default
  response-property-became-optional
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/acss_debit/anyOf[subschema #1: payment_intent_payment_method_options_acss_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/au_becs_debit/anyOf[subschema #1: payment_intent_payment_method_options_au_becs_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/bacs_debit/anyOf[subschema #1: payment_intent_payment_method_options_bacs_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/sepa_debit/anyOf[subschema #1: payment_intent_payment_method_options_sepa_debit]/target_date to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/us_bank_account/anyOf[subschema #1: payment_intent_payment_method_options_us_bank_account]/target_date to the response with the default status
  response-optional-property-added
This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 17, 2025b8a91ebdacb78See the full diff
- ○
  added the optional property error/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status
  response-optional-property-added
- ○
  added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/pay_by_bank to the response with the default status
  response-optional-property-added

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.

Full history (14 revisions)