Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Webhooks

Retrieve an event 

Retrieves the details of an event if it was created in the last 30 days. Supply the unique identifier of the event, which you might have received in a webhook.

Parameters

No parameters.

Returns

Returns an event object if a valid identifier was provided. All events share a common structure, detailed to the right. The only property that will differ is the data property.

In each case, the data dictionary will have an attribute called object and its value will be the same as retrieving the same object directly from the API. For example, a customer.created event will have the same information as retrieving the relevant customer would.

In cases where the attributes of an object have changed, data will also contain a dictionary containing the changes.

GET /v1/events/:id
curl https://api.stripe.com/v1/events/evt_1NG8Du2eZvKYlo2CUI79vXWy \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:"
Response
{
  "id": "evt_1NG8Du2eZvKYlo2CUI79vXWy",
  "object": "event",
  "api_version": "2019-02-19",
  "created": 1686089970,
  "data": {
    "object": {
      "id": "seti_1NG8Du2eZvKYlo2C9XMqbR0x",
      "object": "setup_intent",
      "application": null,
      "automatic_payment_methods": null,
      "cancellation_reason": null,
      "client_secret": "seti_1NG8Du2eZvKYlo2C9XMqbR0x_secret_O2CdhLwGFh2Aej7bCY7qp8jlIuyR8DJ",
      "created": 1686089970,
      "customer": null,
      "description": null,
      "flow_directions": null,
      "last_setup_error": null,
      "latest_attempt": null,
      "livemode": false,
      "mandate": null,
      "metadata": {},
      "next_action": null,
      "on_behalf_of": null,
      "payment_method": "pm_1NG8Du2eZvKYlo2CYzzldNr7",
      "payment_method_options": {
        "acss_debit": {
          "currency": "cad",
          "mandate_options": {
            "interval_description": "First day of every month",
            "payment_schedule": "interval",
            "transaction_type": "personal"
          },
          "verification_method": "automatic"
        }
      },
      "payment_method_types": [
        "acss_debit"
      ],
      "single_use_mandate": null,
      "status": "requires_confirmation",
      "usage": "off_session"
    }
  },
  "livemode": false,
  "pending_webhooks": 0,
  "request": {
    "id": null,
    "idempotency_key": null
  },
  "type": "setup_intent.created"
}

List all events 

List events, going back up to 30 days. Each event data is rendered according to Stripe API version at its creation time, specified in event object api_version attribute (not according to your current Stripe API version or Stripe-Version header).

Parameters

  • typesarray of strings

    An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both.

More parameters

  • createdobject

  • delivery_successboolean

  • ending_beforestring

  • limitinteger

  • starting_afterstring

  • typestring

Returns

A dictionary with a data property that contains an array of up to limit events, starting after event starting_after. Each entry in the array is a separate event object. If no more events are available, the resulting array will be empty.

GET /v1/events
curl -G https://api.stripe.com/v1/events \
  -u "sk_test_4eC39Hq...arjtT1zdp7dcsk_test_4eC39HqLyjWDarjtT1zdp7dc:" \
  -d limit=3
Response
{
  "object": "list",
  "url": "/v1/events",
  "has_more": false,
  "data": [
    {
      "id": "evt_1NG8Du2eZvKYlo2CUI79vXWy",
      "object": "event",
      "api_version": "2019-02-19",
      "created": 1686089970,
      "data": {
        "object": {
          "id": "seti_1NG8Du2eZvKYlo2C9XMqbR0x",
          "object": "setup_intent",
          "application": null,
          "automatic_payment_methods": null,
          "cancellation_reason": null,
          "client_secret": "seti_1NG8Du2eZvKYlo2C9XMqbR0x_secret_O2CdhLwGFh2Aej7bCY7qp8jlIuyR8DJ",
          "created": 1686089970,
          "customer": null,
          "description": null,
          "flow_directions": null,
          "last_setup_error": null,
          "latest_attempt": null,
          "livemode": false,
          "mandate": null,
          "metadata": {},
          "next_action": null,
          "on_behalf_of": null,
          "payment_method": "pm_1NG8Du2eZvKYlo2CYzzldNr7",
          "payment_method_options": {
            "acss_debit": {
              "currency": "cad",
              "mandate_options": {
                "interval_description": "First day of every month",
                "payment_schedule": "interval",
                "transaction_type": "personal"
              },
              "verification_method": "automatic"
            }
          },
          "payment_method_types": [
            "acss_debit"
          ],
          "single_use_mandate": null,
          "status": "requires_confirmation",
          "usage": "off_session"
        }
      },
      "livemode": false,
      "pending_webhooks": 0,
      "request": {
        "id": null,
        "idempotency_key": null
      },
      "type": "setup_intent.created"
    }
  ]
}

Types of events 

This is a list of all the types of events we currently send. We may add more at any time, so in developing and maintaining your code, you should not assume that only these types exist.

You’ll notice that these events follow a pattern: resource.event. Our goal is to design a consistent system that makes things easier to anticipate and code against. Events that occur on subresources like customer.subscription do not trigger the parent’s update event.

Events marked as Selection required are only created when a webhook has been configured to listen for that type of event specifically. A webhook set to listen to all events will not receive an event requiring explicit selection.

Event types

  • account.application.authorizeddata.object is an application

    Occurs whenever a user authorizes an application. Sent to the related application only.

  • account.application.deauthorizeddata.object is an application

    Occurs whenever a user deauthorizes an application. Sent to the related application only.

  • account.external_account.createddata.object is an external account (e.g., card or bank account)

    Occurs whenever an external account is created.

  • account.external_account.deleteddata.object is an external account (e.g., card or bank account)

    Occurs whenever an external account is deleted.

  • account.external_account.updateddata.object is an external account (e.g., card or bank account)

    Occurs whenever an external account is updated.

  • account.updateddata.object is an account

    Occurs whenever an account status or property has changed.

  • application_fee.createddata.object is an application fee

    Occurs whenever an application fee is created on a charge.

  • application_fee.refund.updateddata.object is a fee refund

    Occurs whenever an application fee refund is updated.

  • application_fee.refundeddata.object is an application fee

    Occurs whenever an application fee is refunded, whether from refunding a charge or from refunding the application fee directly. This includes partial refunds.

  • balance.availabledata.object is a balance

    Occurs whenever your Stripe balance has been updated (e.g., when a charge is available to be paid out). By default, Stripe automatically transfers funds in your balance to your bank account on a daily basis. This event is not fired for negative transactions.

  • billing_portal.configuration.createddata.object is a billing portal configuration

    Occurs whenever a portal configuration is created.

  • billing_portal.configuration.updateddata.object is a billing portal configuration

    Occurs whenever a portal configuration is updated.

  • billing_portal.session.createddata.object is a billing portal session

    Occurs whenever a portal session is created.

  • billing.alert.triggereddata.object is a billing alert triggered

    Occurs whenever your custom alert threshold is met.

  • capability.updateddata.object is a capability

    Occurs whenever a capability has new requirements or a new status.

  • cash_balance.funds_availabledata.object is a cash balance

    Occurs whenever there is a positive remaining cash balance after Stripe automatically reconciles new funds into the cash balance. If you enabled manual reconciliation, this webhook will fire whenever there are new funds into the cash balance.

  • charge.captureddata.object is a charge

    Occurs whenever a previously uncaptured charge is captured.

  • charge.dispute.closeddata.object is a dispute

    Occurs when a dispute is closed and the dispute status changes to lost, warning_closed, or won.

  • charge.dispute.createddata.object is a dispute

    Occurs whenever a customer disputes a charge with their bank.

  • charge.dispute.funds_reinstateddata.object is a dispute

    Occurs when funds are reinstated to your account after a dispute is closed. This includes partially refunded payments.

  • charge.dispute.funds_withdrawndata.object is a dispute

    Occurs when funds are removed from your account due to a dispute.

  • charge.dispute.updateddata.object is a dispute

    Occurs when the dispute is updated (usually with evidence).

  • charge.expireddata.object is a charge

    Occurs whenever an uncaptured charge expires.

  • charge.faileddata.object is a charge

    Occurs whenever a failed charge attempt occurs.

  • charge.pendingdata.object is a charge

    Occurs whenever a pending charge is created.

  • charge.refund.updateddata.object is a refund

    Occurs whenever a refund is updated, on selected payment methods.

  • charge.refundeddata.object is a charge

    Occurs whenever a charge is refunded, including partial refunds.

  • charge.succeededdata.object is a charge

    Occurs whenever a charge is successful.

  • charge.updateddata.object is a charge

    Occurs whenever a charge description or metadata is updated, or upon an asynchronous capture.

  • checkout.session.async_payment_faileddata.object is a checkout session

    Occurs when a payment intent using a delayed payment method fails.

  • checkout.session.async_payment_succeededdata.object is a checkout session

    Occurs when a payment intent using a delayed payment method finally succeeds.

  • checkout.session.completeddata.object is a checkout session

    Occurs when a Checkout Session has been successfully completed.

  • checkout.session.expireddata.object is a checkout session

    Occurs when a Checkout Session is expired.

  • climate.order.canceleddata.object is a climate order

    Occurs when a Climate order is canceled.

  • climate.order.createddata.object is a climate order

    Occurs when a Climate order is created.

  • climate.order.delayeddata.object is a climate order

    Occurs when a Climate order is delayed.

  • climate.order.delivereddata.object is a climate order

    Occurs when a Climate order is delivered.

  • climate.order.product_substituteddata.object is a climate order

    Occurs when a Climate order’s product is substituted for another.

  • climate.product.createddata.object is a climate product

    Occurs when a Climate product is created.

  • climate.product.pricing_updateddata.object is a climate product

    Occurs when a Climate product is updated.

  • coupon.createddata.object is a coupon

    Occurs whenever a coupon is created.

  • coupon.deleteddata.object is a coupon

    Occurs whenever a coupon is deleted.

  • coupon.updateddata.object is a coupon

    Occurs whenever a coupon is updated.

  • credit_note.createddata.object is a credit note

    Occurs whenever a credit note is created.

  • credit_note.updateddata.object is a credit note

    Occurs whenever a credit note is updated.

  • credit_note.voideddata.object is a credit note

    Occurs whenever a credit note is voided.

  • customer_cash_balance_transaction.createddata.object is a customer cash balance transaction

    Occurs whenever a new customer cash balance transactions is created.

  • customer.createddata.object is a customer

    Occurs whenever a new customer is created.

  • customer.deleteddata.object is a customer

    Occurs whenever a customer is deleted.

  • customer.discount.createddata.object is a discount

    Occurs whenever a coupon is attached to a customer.

  • customer.discount.deleteddata.object is a discount

    Occurs whenever a coupon is removed from a customer.

  • customer.discount.updateddata.object is a discount

    Occurs whenever a customer is switched from one coupon to another.

  • customer.source.createddata.object is a source (e.g., card)

    Occurs whenever a new source is created for a customer.

  • customer.source.deleteddata.object is a source (e.g., card)

    Occurs whenever a source is removed from a customer.

  • customer.source.expiringdata.object is a source (e.g., card)

    Occurs whenever a card or source will expire at the end of the month. This event only works with legacy integrations using Card or Source objects. If you use the PaymentMethod API, this event won’t occur.

  • customer.source.updateddata.object is a source (e.g., card)

    Occurs whenever a source’s details are changed.

  • customer.subscription.createddata.object is a subscription

    Occurs whenever a customer is signed up for a new plan.

  • customer.subscription.deleteddata.object is a subscription

    Occurs whenever a customer’s subscription ends.

  • customer.subscription.pauseddata.object is a subscription

    Occurs whenever a customer’s subscription is paused. Only applies when subscriptions enter status=paused, not when payment collection is paused.

  • customer.subscription.pending_update_applieddata.object is a subscription

    Occurs whenever a customer’s subscription’s pending update is applied, and the subscription is updated.

  • customer.subscription.pending_update_expireddata.object is a subscription

    Occurs whenever a customer’s subscription’s pending update expires before the related invoice is paid.

  • customer.subscription.resumeddata.object is a subscription

    Occurs whenever a customer’s subscription is no longer paused. Only applies when a status=paused subscription is resumed, not when payment collection is resumed.

  • customer.subscription.trial_will_enddata.object is a subscription

    Occurs three days before a subscription’s trial period is scheduled to end, or when a trial is ended immediately (using trial_end=now).

  • customer.subscription.updateddata.object is a subscription

    Occurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).

  • customer.tax_id.createddata.object is a tax id

    Occurs whenever a tax ID is created for a customer.

  • customer.tax_id.deleteddata.object is a tax id

    Occurs whenever a tax ID is deleted from a customer.

  • customer.tax_id.updateddata.object is a tax id

    Occurs whenever a customer’s tax ID is updated.

  • customer.updateddata.object is a customer

    Occurs whenever any property of a customer changes.

  • entitlements.active_entitlement_summary.updateddata.object is an entitlements active entitlement summary

    Occurs whenever a customer’s entitlements change.

  • file.createddata.object is a file

    Occurs whenever a new Stripe-generated file is available for your account.

  • financial_connections.account.createddata.object is a financial connections account

    Occurs when a new Financial Connections account is created.

  • financial_connections.account.deactivateddata.object is a financial connections account

    Occurs when a Financial Connections account’s status is updated from active to inactive.

  • financial_connections.account.disconnecteddata.object is a financial connections account

    Occurs when a Financial Connections account is disconnected.

  • financial_connections.account.reactivateddata.object is a financial connections account

    Occurs when a Financial Connections account’s status is updated from inactive to active.

  • financial_connections.account.refreshed_balancedata.object is a financial connections account

    Occurs when an Account’s balance_refresh status transitions from pending to either succeeded or failed.

  • financial_connections.account.refreshed_ownershipdata.object is a financial connections account

    Occurs when an Account’s ownership_refresh status transitions from pending to either succeeded or failed.

  • financial_connections.account.refreshed_transactionsdata.object is a financial connections account

    Occurs when an Account’s transaction_refresh status transitions from pending to either succeeded or failed.

  • identity.verification_session.canceleddata.object is an identity verification session

    Occurs whenever a VerificationSession is canceled

  • identity.verification_session.createddata.object is an identity verification session

    Occurs whenever a VerificationSession is created

  • identity.verification_session.processingdata.object is an identity verification session

    Occurs whenever a VerificationSession transitions to processing

  • identity.verification_session.redacteddata.object is an identity verification sessionSelection required

    Occurs whenever a VerificationSession is redacted.

  • identity.verification_session.requires_inputdata.object is an identity verification session

    Occurs whenever a VerificationSession transitions to require user input

  • identity.verification_session.verifieddata.object is an identity verification session

    Occurs whenever a VerificationSession transitions to verified

  • invoice.createddata.object is an invoice

    Occurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions.

  • invoice.deleteddata.object is an invoice

    Occurs whenever a draft invoice is deleted. Note: This event is not sent for invoice previews.

  • invoice.finalization_faileddata.object is an invoice

    Occurs whenever a draft invoice cannot be finalized. See the invoice’s last finalization error for details.

  • invoice.finalizeddata.object is an invoice

    Occurs whenever a draft invoice is finalized and updated to be an open invoice.

  • invoice.marked_uncollectibledata.object is an invoice

    Occurs whenever an invoice is marked uncollectible.

  • invoice.overduedata.object is an invoice

    Occurs X number of days after an invoice becomes due—where X is determined by Automations

  • invoice.paiddata.object is an invoice

    Occurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.

  • invoice.payment_action_requireddata.object is an invoice

    Occurs whenever an invoice payment attempt requires further user action to complete.

  • invoice.payment_faileddata.object is an invoice

    Occurs whenever an invoice payment attempt fails, due either to a declined payment or to the lack of a stored payment method.

  • invoice.payment_succeededdata.object is an invoice

    Occurs whenever an invoice payment attempt succeeds.

  • invoice.sentdata.object is an invoice

    Occurs whenever an invoice email is sent out.

  • invoice.upcomingdata.object is an invoice

    Occurs X number of days before a subscription is scheduled to create an invoice that is automatically charged—where X is determined by your subscriptions settings. Note: The received Invoice object will not have an invoice ID.

  • invoice.updateddata.object is an invoice

    Occurs whenever an invoice changes (e.g., the invoice amount).

  • invoice.voideddata.object is an invoice

    Occurs whenever an invoice is voided.

  • invoice.will_be_duedata.object is an invoice

    Occurs X number of days before an invoice becomes due—where X is determined by Automations

  • invoiceitem.createddata.object is an invoiceitem

    Occurs whenever an invoice item is created.

  • invoiceitem.deleteddata.object is an invoiceitem

    Occurs whenever an invoice item is deleted.

  • issuing_authorization.createddata.object is an issuing authorization

    Occurs whenever an authorization is created.

  • issuing_authorization.requestdata.object is an issuing authorizationSelection required

    Represents a synchronous request for authorization, see Using your integration to handle authorization requests.

  • issuing_authorization.updateddata.object is an issuing authorization

    Occurs whenever an authorization is updated.

  • issuing_card.createddata.object is an issuing card

    Occurs whenever a card is created.

  • issuing_card.updateddata.object is an issuing card

    Occurs whenever a card is updated.

  • issuing_cardholder.createddata.object is an issuing cardholder

    Occurs whenever a cardholder is created.

  • issuing_cardholder.updateddata.object is an issuing cardholder

    Occurs whenever a cardholder is updated.

  • issuing_dispute.closeddata.object is an issuing dispute

    Occurs whenever a dispute is won, lost or expired.

  • issuing_dispute.createddata.object is an issuing dispute

    Occurs whenever a dispute is created.

  • issuing_dispute.funds_reinstateddata.object is an issuing dispute

    Occurs whenever funds are reinstated to your account for an Issuing dispute.

  • issuing_dispute.funds_rescindeddata.object is an issuing dispute

    Occurs whenever funds are deducted from your account for an Issuing dispute.

  • issuing_dispute.submitteddata.object is an issuing dispute

    Occurs whenever a dispute is submitted.

  • issuing_dispute.updateddata.object is an issuing dispute

    Occurs whenever a dispute is updated.

  • issuing_personalization_design.activateddata.object is an issuing personalization design

    Occurs whenever a personalization design is activated following the activation of the physical bundle that belongs to it.

  • issuing_personalization_design.deactivateddata.object is an issuing personalization design

    Occurs whenever a personalization design is deactivated following the deactivation of the physical bundle that belongs to it.

  • issuing_personalization_design.rejecteddata.object is an issuing personalization design

    Occurs whenever a personalization design is rejected by design review.

  • issuing_personalization_design.updateddata.object is an issuing personalization design

    Occurs whenever a personalization design is updated.

  • issuing_token.createddata.object is an issuing token

    Occurs whenever an issuing digital wallet token is created.

  • issuing_token.updateddata.object is an issuing token

    Occurs whenever an issuing digital wallet token is updated.

  • issuing_transaction.createddata.object is an issuing transaction

    Occurs whenever an issuing transaction is created.

  • issuing_transaction.purchase_details_receipt_updateddata.object is an issuing transaction

    Occurs whenever an issuing transaction is updated with receipt data.

  • issuing_transaction.updateddata.object is an issuing transaction

    Occurs whenever an issuing transaction is updated.

  • mandate.updateddata.object is a mandate

    Occurs whenever a Mandate is updated.

  • payment_intent.amount_capturable_updateddata.object is a payment intent

    Occurs when a PaymentIntent has funds to be captured. Check the amount_capturable property on the PaymentIntent to determine the amount that can be captured. You may capture the PaymentIntent with an amount_to_capture value up to the specified amount. Learn more about capturing PaymentIntents.

  • payment_intent.canceleddata.object is a payment intent

    Occurs when a PaymentIntent is canceled.

  • payment_intent.createddata.object is a payment intent

    Occurs when a new PaymentIntent is created.

  • payment_intent.partially_fundeddata.object is a payment intent

    Occurs when funds are applied to a customer_balance PaymentIntent and the ‘amount_remaining’ changes.

  • payment_intent.payment_faileddata.object is a payment intent

    Occurs when a PaymentIntent has failed the attempt to create a payment method or a payment.

  • payment_intent.processingdata.object is a payment intent

    Occurs when a PaymentIntent has started processing.

  • payment_intent.requires_actiondata.object is a payment intent

    Occurs when a PaymentIntent transitions to requires_action state

  • payment_intent.succeededdata.object is a payment intent

    Occurs when a PaymentIntent has successfully completed payment.

  • payment_link.createddata.object is a payment link

    Occurs when a payment link is created.

  • payment_link.updateddata.object is a payment link

    Occurs when a payment link is updated.

  • payment_method.attacheddata.object is a payment method

    Occurs whenever a new payment method is attached to a customer.

  • payment_method.automatically_updateddata.object is a payment method

    Occurs whenever a payment method’s details are automatically updated by the network.

  • payment_method.detacheddata.object is a payment method

    Occurs whenever a payment method is detached from a customer.

  • payment_method.updateddata.object is a payment method

    Occurs whenever a payment method is updated via the PaymentMethod update API.

  • payout.canceleddata.object is a payout

    Occurs whenever a payout is canceled.

  • payout.createddata.object is a payout

    Occurs whenever a payout is created.

  • payout.faileddata.object is a payout

    Occurs whenever a payout attempt fails.

  • payout.paiddata.object is a payout

    Occurs whenever a payout is expected to be available in the destination account. If the payout fails, a payout.failed notification is also sent, at a later time.

  • payout.reconciliation_completeddata.object is a payout

    Occurs whenever balance transactions paid out in an automatic payout can be queried.

  • payout.updateddata.object is a payout

    Occurs whenever a payout is updated.

  • person.createddata.object is a person

    Occurs whenever a person associated with an account is created.

  • person.deleteddata.object is a person

    Occurs whenever a person associated with an account is deleted.

  • person.updateddata.object is a person

    Occurs whenever a person associated with an account is updated.

  • plan.createddata.object is a plan

    Occurs whenever a plan is created.

  • plan.deleteddata.object is a plan

    Occurs whenever a plan is deleted.

  • plan.updateddata.object is a plan

    Occurs whenever a plan is updated.

  • price.createddata.object is a price

    Occurs whenever a price is created.

  • price.deleteddata.object is a price

    Occurs whenever a price is deleted.

  • price.updateddata.object is a price

    Occurs whenever a price is updated.

  • product.createddata.object is a product

    Occurs whenever a product is created.

  • product.deleteddata.object is a product

    Occurs whenever a product is deleted.

  • product.updateddata.object is a product

    Occurs whenever a product is updated.

  • promotion_code.createddata.object is a promotion code

    Occurs whenever a promotion code is created.

  • promotion_code.updateddata.object is a promotion code

    Occurs whenever a promotion code is updated.

  • quote.accepteddata.object is a quote

    Occurs whenever a quote is accepted.

  • quote.canceleddata.object is a quote

    Occurs whenever a quote is canceled.

  • quote.createddata.object is a quote

    Occurs whenever a quote is created.

  • quote.finalizeddata.object is a quote

    Occurs whenever a quote is finalized.

  • quote.will_expiredata.object is a quote

    Occurs X number of days before a quote is scheduled to expire—where X is determined by Automations

  • radar.early_fraud_warning.createddata.object is a radar early fraud warning

    Occurs whenever an early fraud warning is created.

  • radar.early_fraud_warning.updateddata.object is a radar early fraud warning

    Occurs whenever an early fraud warning is updated.

  • refund.createddata.object is a refund

    Occurs whenever a refund is created.

  • refund.faileddata.object is a refund

    Occurs whenever a refund has failed.

  • refund.updateddata.object is a refund

    Occurs whenever a refund is updated.

  • reporting.report_run.faileddata.object is a reporting report run

    Occurs whenever a requested ReportRun failed to complete.

  • reporting.report_run.succeededdata.object is a reporting report run

    Occurs whenever a requested ReportRun completed successfully.

  • reporting.report_type.updateddata.object is a reporting report typeSelection required

    Occurs whenever a ReportType is updated (typically to indicate that a new day’s data has come available).

  • review.closeddata.object is a review

    Occurs whenever a review is closed. The review’s reason field indicates why: approved, disputed, refunded, or refunded_as_fraud.

  • review.openeddata.object is a review

    Occurs whenever a review is opened.

  • setup_intent.canceleddata.object is a setup intent

    Occurs when a SetupIntent is canceled.

  • setup_intent.createddata.object is a setup intent

    Occurs when a new SetupIntent is created.

  • setup_intent.requires_actiondata.object is a setup intent

    Occurs when a SetupIntent is in requires_action state.

  • setup_intent.setup_faileddata.object is a setup intent

    Occurs when a SetupIntent has failed the attempt to setup a payment method.

  • setup_intent.succeededdata.object is a setup intent

    Occurs when an SetupIntent has successfully setup a payment method.

  • sigma.scheduled_query_run.createddata.object is a scheduled query run

    Occurs whenever a Sigma scheduled query run finishes.

  • source.canceleddata.object is a source (e.g., card)

    Occurs whenever a source is canceled.

  • source.chargeabledata.object is a source (e.g., card)

    Occurs whenever a source transitions to chargeable.

  • source.faileddata.object is a source (e.g., card)

    Occurs whenever a source fails.

  • source.mandate_notificationdata.object is a source (e.g., card)

    Occurs whenever a source mandate notification method is set to manual.

  • source.refund_attributes_requireddata.object is a source (e.g., card)

    Occurs whenever the refund attributes are required on a receiver source to process a refund or a mispayment.

  • source.transaction.createddata.object is a source transaction

    Occurs whenever a source transaction is created.

  • source.transaction.updateddata.object is a source transaction

    Occurs whenever a source transaction is updated.

  • subscription_schedule.aborteddata.object is a subscription schedule

    Occurs whenever a subscription schedule is canceled due to the underlying subscription being canceled because of delinquency.

  • subscription_schedule.canceleddata.object is a subscription schedule

    Occurs whenever a subscription schedule is canceled.

  • subscription_schedule.completeddata.object is a subscription schedule

    Occurs whenever a new subscription schedule is completed.

  • subscription_schedule.createddata.object is a subscription schedule

    Occurs whenever a new subscription schedule is created.

  • subscription_schedule.expiringdata.object is a subscription schedule

    Occurs 7 days before a subscription schedule will expire.

  • subscription_schedule.releaseddata.object is a subscription schedule

    Occurs whenever a new subscription schedule is released.

  • subscription_schedule.updateddata.object is a subscription schedule

    Occurs whenever a subscription schedule is updated.

  • tax_rate.createddata.object is a tax rate

    Occurs whenever a new tax rate is created.

  • tax_rate.updateddata.object is a tax rate

    Occurs whenever a tax rate is updated.

  • tax.settings.updateddata.object is a tax settings

    Occurs whenever tax settings is updated.

  • terminal.reader.action_faileddata.object is a terminal reader

    Occurs whenever an action sent to a Terminal reader failed.

  • terminal.reader.action_succeededdata.object is a terminal reader

    Occurs whenever an action sent to a Terminal reader was successful.

  • test_helpers.test_clock.advancingdata.object is a test helpers test clock

    Occurs whenever a test clock starts advancing.

  • test_helpers.test_clock.createddata.object is a test helpers test clock

    Occurs whenever a test clock is created.

  • test_helpers.test_clock.deleteddata.object is a test helpers test clock

    Occurs whenever a test clock is deleted.

  • test_helpers.test_clock.internal_failuredata.object is a test helpers test clock

    Occurs whenever a test clock fails to advance its frozen time.

  • test_helpers.test_clock.readydata.object is a test helpers test clock

    Occurs whenever a test clock transitions to a ready status.

  • topup.canceleddata.object is a topup

    Occurs whenever a top-up is canceled.

  • topup.createddata.object is a topup

    Occurs whenever a top-up is created.

  • topup.faileddata.object is a topup

    Occurs whenever a top-up fails.

  • topup.reverseddata.object is a topup

    Occurs whenever a top-up is reversed.

  • topup.succeededdata.object is a topup

    Occurs whenever a top-up succeeds.

  • transfer.createddata.object is a transfer

    Occurs whenever a transfer is created.

  • transfer.reverseddata.object is a transfer

    Occurs whenever a transfer is reversed, including partial reversals.

  • transfer.updateddata.object is a transfer

    Occurs whenever a transfer’s description or metadata is updated.

Events v2

Learn more about calling API v2 endpoints.

Events are generated to keep you informed of activity in your business account. APIs in the /v2 namespace generate thin events which have small, unversioned payloads that include a reference to the ID of the object that has changed. The Events v2 API returns these new thin events. Retrieve the event object for additional data about the event. Use the related object ID in the event payload to fetch the API resource of the object associated with the event. Comparatively, events generated by most API v1 include a versioned snapshot of an API object in their payload.

Endpoints

Event Destinations v2

Learn more about calling API v2 endpoints.

Set up an event destination to receive events from Stripe across multiple destination types, including webhook endpoints and Amazon EventBridge. Event destinations support receiving thin events and snapshot events.

Endpoints

Files 

This object represents files hosted on Stripe’s servers. You can upload files with the create file request (for example, when uploading dispute evidence). Stripe also creates files independently (for example, the results of a Sigma scheduled query).

Related guide: File upload guide

Endpoints

File Links 

To share the contents of a File object with non-Stripe users, you can create a FileLink. FileLinks contain a URL that you can use to retrieve the contents of the file without authentication.

Endpoints

Mandates 

A Mandate is a record of the permission that your customer gives you to debit their payment method.

Endpoints

Payment Intents 

A PaymentIntent guides you through the process of collecting a payment from your customer. We recommend that you create exactly one PaymentIntent for each order or customer session in your system. You can reference the PaymentIntent later to see the history of payment attempts for a particular session.

A PaymentIntent transitions through multiple statuses throughout its lifetime as it interfaces with Stripe.js to perform authentication flows and ultimately creates at most one successful charge.

Related guide: Payment Intents API

Endpoints

Setup Intents 

A SetupIntent guides you through the process of setting up and saving a customer’s payment credentials for future payments. For example, you can use a SetupIntent to set up and save your customer’s card without immediately collecting a payment. Later, you can use PaymentIntents to drive the payment flow.

Create a SetupIntent when you’re ready to collect your customer’s payment credentials. Don’t maintain long-lived, unconfirmed SetupIntents because they might not be valid. The SetupIntent transitions through multiple statuses as it guides you through the setup process.

Successful SetupIntents result in payment credentials that are optimized for future payments. For example, cardholders in certain regions might need to be run through Strong Customer Authentication during payment method collection to streamline later off-session payments. If you use the SetupIntent with a Customer, it automatically attaches the resulting payment method to that Customer after successful setup. We recommend using SetupIntents or setup_future_usage on PaymentIntents to save payment methods to prevent saving invalid or unoptimized payment methods.

By using SetupIntents, you can reduce friction for your customers, even as regulations change over time.

Related guide: Setup Intents API

Endpoints

Setup Attempts 

A SetupAttempt describes one attempted confirmation of a SetupIntent, whether that confirmation is successful or unsuccessful. You can use SetupAttempts to inspect details of a specific attempt at setting up a payment method using a SetupIntent.

Endpoints

Payouts 

A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.

Related guide: Receiving payouts

Endpoints

Refunds 

Refund objects allow you to refund a previously created charge that isn’t refunded yet. Funds are refunded to the credit or debit card that’s initially charged.

Related guide: Refunds

Endpoints

Confirmation Token 

ConfirmationTokens help transport client side data collected by Stripe JS over to your server for confirming a PaymentIntent or SetupIntent. If the confirmation is successful, values present on the ConfirmationToken are written onto the Intent.

To learn more about how to use ConfirmationToken, visit the related guides:

Endpoints

Tokens 

Tokenization is the process Stripe uses to collect sensitive card or bank account details, or personally identifiable information (PII), directly from your customers in a secure manner. A token representing this information is returned to your server to use. Use our recommended payments integrations to perform this process on the client-side. This guarantees that no sensitive card data touches your server, and allows your integration to operate in a PCI-compliant way.

If you can’t use client-side tokenization, you can also create tokens using the API with either your publishable or secret API key. If your integration uses this method, you’re responsible for any PCI compliance that it might require, and you must keep your secret API key safe. Unlike with client-side tokenization, your customer’s information isn’t sent directly to Stripe, so we can’t determine how it’s handled or stored.

You can’t store or use tokens more than once. To store card or bank account information for later use, create Customer objects or External accounts. Radar, our integrated solution for automatic fraud protection, performs best with integrations that use client-side tokenization.

Endpoints

Payment Methods 

PaymentMethod objects represent your customer’s payment instruments. You can use them with PaymentIntents to collect payments or save them to Customer objects to store instrument details for future payments.

Related guides: Payment Methods and More Payment Scenarios.

Endpoints

Payment Method Configurations 

PaymentMethodConfigurations control which payment methods are displayed to your customers when you don’t explicitly specify payment method types. You can have multiple configurations with different sets of payment methods for different scenarios.

There are two types of PaymentMethodConfigurations. Which is used depends on the charge type:

Direct configurations apply to payments created on your account, including Connect destination charges, Connect separate charges and transfers, and payments not involving Connect.

Child configurations apply to payments created on your connected accounts using direct charges, and charges with the on_behalf_of parameter.

Child configurations have a parent that sets default values and controls which settings connected accounts may override. You can specify a parent ID at payment time, and Stripe will automatically resolve the connected account’s associated child configuration. Parent configurations are managed in the dashboard and are not available in this API.

Related guides:

Endpoints

Payment Method Domains 

A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.

Related guide: Payment method domains.

Endpoints

Bank Accounts 

These bank accounts are payment methods on Customer objects.

On the other hand External Accounts are transfer destinations on Account objects for connected accounts. They can be bank accounts or debit cards as well, and are documented in the links above.

Related guide: Bank debits and transfers

Endpoints

Cash Balance 

A customer’s Cash balance represents real funds. Customers can add funds to their cash balance by sending a bank transfer. These funds can be used for payment and can eventually be paid out to your bank account.

Endpoints

Cash Balance Transaction 

Customers with certain payments enabled have a cash balance, representing funds that were paid by the customer to a merchant, but have not yet been allocated to a payment. Cash Balance Transactions represent when funds are moved into or out of this balance. This includes funding by the customer, allocation to payments, and refunds to the customer.

Endpoints

Cards 

You can store multiple cards on a customer in order to charge the customer later. You can also store multiple debit cards on a recipient in order to transfer to those cards later.

Related guide: Card payments with Sources

Endpoints

Sources Deprecated

Source objects allow you to accept a variety of payment methods. They represent a customer’s payment instrument, and can be used with the Stripe API just like a Card object: once chargeable, they can be charged, or can be attached to customers.

Stripe doesn’t recommend using the deprecated Sources API. We recommend that you adopt the PaymentMethods API. This newer API provides access to our latest features and payment method types.

Related guides: Sources API and Sources & Customers.

Endpoints

Products 

Products describe the specific goods or services you offer to your customers. For example, you might offer a Standard and Premium version of your goods or service; each version would be a separate Product. They can be used in conjunction with Prices to configure pricing in Payment Links, Checkout, and Subscriptions.

Related guides: Set up a subscription, share a Payment Link, accept payments with Checkout, and more about Products and Prices

Endpoints

Prices 

Prices define the unit cost, currency, and (optional) billing cycle for both recurring and one-time purchases of products. Products help you track inventory or provisioning, and prices help you track payment terms. Different physical goods or levels of service should be represented by products, and pricing options should be represented by prices. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has prices for $10/month, $100/year, and €9 once.

Related guides: Set up a subscription, create an invoice, and more about products and prices.

Endpoints

Coupons 

A coupon contains information about a percent-off or amount-off discount you might want to apply to a customer. Coupons may be applied to subscriptions, invoices, checkout sessions, quotes, and more. Coupons do not work with conventional one-off charges or payment intents.

Endpoints

Promotion Code 

A Promotion Code represents a customer-redeemable code for a coupon. It can be used to create multiple codes for a single coupon.

Endpoints

Discounts 

A discount represents the actual application of a coupon or promotion code. It contains information about when the discount began, when it will end, and what it is applied to.

Related guide: Applying discounts to subscriptions

Endpoints

Tax Code 

Tax codes classify goods and services for tax purposes.

Endpoints

Tax Rate 

Tax rates can be applied to invoices, subscriptions and Checkout Sessions to collect tax.

Related guide: Tax rates

Endpoints

Shipping Rates 

Shipping rates describe the price of shipping presented to your customers and applied to a purchase. For more information, see Charge for shipping.

Endpoints

Sessions 

A Checkout Session represents your customer’s session as they pay for one-time purchases or subscriptions through Checkout or Payment Links. We recommend creating a new Session each time your customer attempts to pay.

Once payment is successful, the Checkout Session will contain a reference to the Customer, and either the successful PaymentIntent or an active Subscription.

You can create a Checkout Session on your server and redirect to its URL to begin Checkout.

Related guide: Checkout quickstart

Endpoints

Payment Link 

A payment link is a shareable URL that will take your customers to a hosted payment page. A payment link can be shared and used multiple times.

When a customer opens a payment link it will open a new checkout session to render the payment page. You can use checkout session events to track payments through payment links.

Related guide: Payment Links API

Endpoints

Credit Note 

Issue a credit note to adjust an invoice’s amount after the invoice is finalized.

Related guide: Credit notes

Endpoints

Customer Balance Transaction 

Each customer has a Balance value, which denotes a debit or credit that’s automatically applied to their next invoice upon finalization. You may modify the value directly by using the update customer API, or by creating a Customer Balance Transaction, which increments or decrements the customer’s balance by the specified amount.

Related guide: Customer balance

Endpoints

Customer Portal Session 

The Billing customer portal is a Stripe-hosted UI for subscription and billing management.

A portal configuration describes the functionality and features that you want to provide to your customers through the portal.

A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session’s URL, the customer can manage their subscriptions and billing details. For security reasons, sessions are short-lived and will expire if the customer does not visit the URL. Create sessions on-demand when customers intend to manage their subscriptions and billing details.

Related guide: Customer management

Endpoints

Customer Portal Configuration 

A portal configuration describes the functionality and behavior of a portal session.

Endpoints

Invoices 

Invoices are statements of amounts owed by a customer, and are either generated one-off, or generated periodically from a subscription.

They contain invoice items, and proration adjustments that may be caused by subscription upgrades/downgrades (if necessary).

If your invoice is configured to be billed through automatic charges, Stripe automatically finalizes your invoice and attempts payment. Note that finalizing the invoice, when automatic, does not happen immediately as the invoice is created. Stripe waits until one hour after the last webhook was successfully sent (or the last webhook timed out after failing). If you (and the platforms you may have connected to) have no webhooks configured, Stripe waits one hour after creation to finalize the invoice.

If your invoice is configured to be billed by sending an email, then based on your email settings, Stripe will email the invoice to your customer and await payment. These emails can contain a link to a hosted page to pay the invoice.

Stripe applies any customer credit on the account before determining the amount due for the invoice (i.e., the amount that will be actually charged). If the amount due for the invoice is less than Stripe’s minimum allowed charge per currency, the invoice is automatically marked paid, and we add the amount due to the customer’s credit balance which is applied to the next invoice.

More details on the customer’s credit balance are here.

Related guide: Send invoices to customers

Endpoints

Invoice Items 

Invoice Items represent the component lines of an invoice. An invoice item is added to an invoice by creating or updating it with an invoice field, at which point it will be included as an invoice line item within invoice.lines.

Invoice Items can be created before you are ready to actually send the invoice. This can be particularly useful when combined with a subscription. Sometimes you want to add a charge or credit to a customer, but actually charge or credit the customer’s card only at the end of a regular billing cycle. This is useful for combining several charges (to minimize per-transaction fees), or for having Stripe tabulate your usage-based billing totals.

Related guides: Integrate with the Invoicing API, Subscription Invoices.

Endpoints

Invoice Line Item 

Invoice Line Items represent the individual lines within an invoice and only exist within the context of an invoice.

Each line item is backed by either an invoice item or a subscription item.

Endpoints

Invoice Rendering Templates 

Invoice Rendering Templates are used to configure how invoices are rendered on surfaces like the PDF. Invoice Rendering Templates can be created from within the Dashboard, and they can be used over the API when creating invoices.

Endpoints

Alerts 

A billing alert is a resource that notifies you when a certain usage threshold on a meter is crossed. For example, you might create a billing alert to notify you when a certain user made 100 API requests.

Endpoints

Meters 

Meters specify how to aggregate meter events over a billing period. Meter events represent the actions that customers take in your system. Meters attach to prices and form the basis of the bill.

Related guide: Usage based billing

Endpoints

Meter Events 

Meter events represent actions that customers take in your system. You can use meter events to bill a customer based on their usage. Meter events are associated with billing meters, which define both the contents of the event’s payload and how to aggregate those events.

Endpoints

Meter Events v2

Learn more about calling API v2 endpoints.

Meter events are used to report customer usage of your product or service. Meter events are associated with billing meters, which define the shape of the event’s payload and how those events are aggregated. Meter events are processed asynchronously, so they may not be immediately reflected in aggregates or on upcoming invoices.

Endpoints

Meter Event Adjustment 

A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.

Endpoints

Meter Event Adjustment v2

Learn more about calling API v2 endpoints.

A billing meter event adjustment is a resource that allows you to cancel a meter event. For example, you might create a billing meter event adjustment to cancel a meter event that was created in error or attached to the wrong customer.

Endpoints

Meter Event Stream v2

Learn more about calling API v2 endpoints.

You can send a higher-throughput of meter events using meter event streams. For this flow, you must first create a meter event session, which will provide you with a session token. You can then create meter events through the meter event stream endpoint, using the session token for authentication. The session tokens are short-lived and you will need to create a new meter event session when the token expires.

Endpoints

Meter Event Summary 

A billing meter event summary represents an aggregated view of a customer’s billing meter events within a specified timeframe. It indicates how much usage was accrued by a customer for that period.

Endpoints

Credit Grant 

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

Related guide: Billing credits

Endpoints

Credit Balance Summary 

Indicates the billing credit balance for billing credits granted to a customer.

Endpoints

Credit Balance Transaction 

A credit balance transaction is a resource representing a transaction (either a credit or a debit) against an existing credit grant.

Endpoints

Plans 

You can now model subscriptions more flexibly using the Prices API. It replaces the Plans API and is backwards compatible to simplify your migration.

Plans define the base price, currency, and billing cycle for recurring purchases of products. Products help you track inventory or provisioning, and plans help you track pricing. Different physical goods or levels of service should be represented by products, and pricing options should be represented by plans. This approach lets you change prices without having to change your provisioning scheme.

For example, you might have a single “gold” product that has plans for $10/month, $100/year, €9/month, and €90/year.

Related guides: Set up a subscription and more about products and prices.

Endpoints

Quote 

A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

Endpoints

Subscriptions 

Subscriptions allow you to charge a customer on a recurring basis.

Related guide: Creating subscriptions

Endpoints

Subscription Items 

Subscription items allow you to create customer subscriptions with more than one plan, making it easy to represent complex billing relationships.

Endpoints

Subscription Schedule 

A subscription schedule allows you to create and manage the lifecycle of a subscription by predefining expected changes.

Related guide: Subscription schedules

Endpoints

Tax IDs 

You can add one or multiple tax IDs to a customer or account. Customer and account tax IDs get displayed on related invoices and credit notes.

Related guides: Customer tax identification numbers, Account tax IDs

Endpoints

Test Clocks Test helper

A test clock enables deterministic control over objects in testmode. With a test clock, you can create objects at a frozen time in the past or future, and advance to a specific future time to observe webhooks and state changes. After the clock advances, you can either validate the current state of your scenario (and test your assumptions), change the current state of your scenario (and test more complex scenarios), or keep advancing forward in time.

Endpoints

Usage Records 

Usage records allow you to report customer usage and metrics to Stripe for metered billing of subscription prices.

Related guide: Metered billing

This is our legacy usage-based billing API. See the updated usage-based billing docs.

Endpoints

Usage Record Summary 

A usage record summary represents an aggregated view of how much usage was accrued for a subscription item within a subscription billing period.

Endpoints

Financing Offer Preview feature

This is an object representing an offer of financing from Stripe Capital to a Connect subaccount.

Endpoints

Financing Summary Preview feature

A financing object describes an account’s current financing state. Used by Connect platforms to read the state of Capital offered to their connected accounts.

Endpoints

Accounts 

This is an object representing a Stripe account. You can retrieve it to see properties on the account like its current requirements or if the account is enabled to make live charges or receive payouts.

For accounts where controller.requirement_collection is application, which includes Custom accounts, the properties below are always returned.

For accounts where controller.requirement_collection is stripe, which includes Standard and Express accounts, some properties are only returned until you create an Account Link or Account Session to start Connect Onboarding. Learn about the differences between accounts.

Endpoints

Login Links 

Login Links are single-use URLs for a connected account to access the Express Dashboard. The connected account’s account.controller.stripe_dashboard.type must be express to have access to the Express Dashboard.

Endpoints

Account Links 

Account Links are the means by which a Connect platform grants a connected account permission to access Stripe-hosted applications, such as Connect Onboarding.

Related guide: Connect Onboarding

Endpoints

Account Session 

An AccountSession allows a Connect platform to grant access to a connected account in Connect embedded components.

We recommend that you create an AccountSession each time you need to display an embedded component to your user. Do not save AccountSessions to your database as they expire relatively quickly, and cannot be used more than once.

Related guide: Connect embedded components

Endpoints

Application Fees 

When you collect a transaction fee on top of a charge made for your user (using Connect), an Application Fee object is created in your account. You can list, retrieve, and refund application fees.

Related guide: Collecting application fees

Endpoints

Application Fee Refunds 

Application Fee Refund objects allow you to refund an application fee that has previously been created but not yet refunded. Funds will be refunded to the Stripe account from which the fee was originally collected.

Related guide: Refunding application fees

Endpoints

Capabilities 

This is an object representing a capability for a Stripe account.

Related guide: Account capabilities

Endpoints

Country Specs 

Stripe needs to collect certain pieces of information about each account created. These requirements can differ depending on the account’s country. The Country Specs API makes these rules available to your integration.

You can also view the information from this API call as an online guide.

Endpoints

External Bank Accounts 

External bank accounts are financial accounts associated with a Stripe platform’s connected accounts for the purpose of transferring funds to or from the connected account’s Stripe balance.

Endpoints

External Account Cards 

External account cards are debit cards associated with a Stripe platform’s connected accounts for the purpose of transferring funds to or from the connected accounts Stripe balance.

Endpoints

Person 

This is an object representing a person associated with a Stripe account.

A platform cannot access a person for an account where account.controller.requirement_collection is stripe, which includes Standard and Express accounts, after creating an Account Link or Account Session to start Connect onboarding.

See the Standard onboarding or Express onboarding documentation for information about prefilling information and account onboarding steps. Learn more about handling identity verification with the API.

Endpoints

Top-ups 

To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

Related guide: Topping up your platform account

Endpoints

Transfers 

A Transfer object is created when you move funds between Stripe accounts as part of Connect.

Before April 6, 2017, transfers also represented movement of funds from a Stripe account to a card or bank account. This behavior has since been split out into a Payout object, with corresponding payout endpoints. For more information, read about the transfer/payout split.

Related guide: Creating separate charges and transfers

Endpoints

Transfer Reversals 

Stripe Connect platforms can reverse transfers made to a connected account, either entirely or partially, and can also specify whether to refund any related application fees. Transfer reversals add to the platform’s balance and subtract from the destination account’s balance.

Reversing a transfer that was made for a destination charge is allowed only up to the amount of the charge. It is possible to reverse a transfer_group transfer only if the destination account has enough balance to cover the reversal.

Related guide: Reverse transfers

Endpoints

Secrets 

Secret Store is an API that allows Stripe Apps developers to securely persist secrets for use by UI Extensions and app backends.

The primary resource in Secret Store is a secret. Other apps can’t view secrets created by an app. Additionally, secrets are scoped to provide further permission control.

All Dashboard users and the app backend share account scoped secrets. Use the account scope for secrets that don’t change per-user, like a third-party API key.

A user scoped secret is accessible by the app backend and one specific Dashboard user. Use the user scope for per-user secrets like per-user OAuth tokens, where different users might have different permissions.

Related guide: Store data between page reloads

Endpoints

Early Fraud Warning 

An early fraud warning indicates that the card issuer has notified us that a charge may be fraudulent.

Related guide: Early fraud warnings

Endpoints

Reviews 

Reviews can be used to supplement automated fraud detection with human expertise.

Learn more about Radar and reviewing payments here.

Endpoints

Value Lists 

Value lists allow you to group values together which can then be referenced in rules.

Related guide: Default Stripe lists

Endpoints

Value List Items 

Value list items allow you to add specific values to a given Radar value list, which can then be used in rules.

Related guide: Managing list items

Endpoints

Authorizations 

When an issued card is used to make a purchase, an Issuing Authorization object is created. Authorizations must be approved for the purchase to be completed successfully.

Related guide: Issued card authorizations

Endpoints

Cardholders 

An Issuing Cardholder object represents an individual or business entity who is issued cards.

Related guide: How to create a cardholder

Endpoints

Cards 

You can create physical or virtual cards that are issued to cardholders.

Endpoints

Disputes 

As a card issuer, you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with.

Related guide: Issuing disputes

Endpoints

Funding Instructions 

Funding Instructions contain reusable bank account and routing information. Push funds to these addresses via bank transfer to top up Issuing Balances.

Endpoints

Personalization Designs 

A Personalization Design is a logical grouping of a Physical Bundle, card logo, and carrier text that represents a product line.

Endpoints

Physical Bundles 

A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.

Endpoints

Tokens Preview feature

An issuing token object is created when an issued card is added to a digital wallet. As a card issuer, you can view and manage these tokens through Stripe.

Endpoints

Transactions 

Any use of an issued card that results in funds entering or leaving your Stripe account, such as a completed purchase or refund, is represented by an Issuing Transaction object.

Related guide: Issued card transactions

Endpoints

Connection Token 

A Connection Token is used by the Stripe Terminal SDK to connect to a reader.

Related guide: Fleet management

Endpoints

Location 

A Location represents a grouping of readers.

Related guide: Fleet management

Endpoints

Reader 

A Reader represents a physical device for accepting payment details.

Related guide: Connecting to a reader

Endpoints

Terminal Hardware Order Preview feature

A TerminalHardwareOrder represents an order for Terminal hardware, containing information such as the price, shipping information and the items ordered.

Endpoints

Terminal Hardware Product Preview feature

A TerminalHardwareProduct is a category of hardware devices that are generally similar, but may have variations depending on the country it’s shipped to.

TerminalHardwareSKUs represent variations within the same Product (for example, a country specific device). For example, WisePOS E is a TerminalHardwareProduct and a WisePOS E - US and WisePOS E - UK are TerminalHardwareSKUs.

Endpoints

Terminal Hardware SKU Preview feature

A TerminalHardwareSKU represents a SKU for Terminal hardware. A SKU is a representation of a product available for purchase, containing information such as the name, price, and images.

Endpoints

Terminal Hardware Shipping Method Preview feature

A TerminalHardwareShipping represents a Shipping Method for Terminal hardware. A Shipping Method is a country-specific representation of a way to ship hardware, containing information such as the country, name, and expected delivery date.

Endpoints

Configuration 

A Configurations object represents how features should be configured for terminal readers.

Endpoints

Financial Accounts 

Stripe Treasury provides users with a container for money called a FinancialAccount that is separate from their Payments balance. FinancialAccounts serve as the source and destination of Treasury’s money movement APIs.

Endpoints

Financial Account Features 

Encodes whether a FinancialAccount has access to a particular Feature, with a status enum and associated status_details. Stripe or the platform can control Features via the requested field.

Endpoints

Transactions 

Transactions represent changes to a FinancialAccount’s balance.

Endpoints

Transaction Entries 

TransactionEntries represent individual units of money movements within a single Transaction.

Endpoints

Outbound Transfers 

Use OutboundTransfers to transfer funds from a FinancialAccount to a PaymentMethod belonging to the same entity. To send funds to a different party, use OutboundPayments instead. You can send funds over ACH rails or through a domestic wire transfer to a user’s own external bank account.

Simulate OutboundTransfer state changes with the /v1/test_helpers/treasury/outbound_transfers endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundTransfer objects

Endpoints

Outbound Payments 

Use OutboundPayments to send funds to another party’s external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

Simulate OutboundPayment state changes with the /v1/test_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects.

Related guide: Moving money with Treasury using OutboundPayment objects

Endpoints

Inbound Transfers 

Use InboundTransfers to add funds to your FinancialAccount via a PaymentMethod that is owned by you. The funds will be transferred via an ACH debit.

Related guide: Moving money with Treasury using InboundTransfer objects

Endpoints

Received Credits 

ReceivedCredits represent funds sent to a FinancialAccount (for example, via ACH or wire). These money movements are not initiated from the FinancialAccount.

Endpoints

Received Debits 

ReceivedDebits represent funds pulled from a FinancialAccount. These are not initiated from the FinancialAccount.

Endpoints

Credit Reversals 

You can reverse some ReceivedCredits depending on their network and source flow. Reversing a ReceivedCredit leads to the creation of a new object known as a CreditReversal.

Endpoints

Debit Reversals 

You can reverse some ReceivedDebits depending on their network and source flow. Reversing a ReceivedDebit leads to the creation of a new object known as a DebitReversal.

Endpoints

Feature 

A feature represents a monetizable ability or functionality in your system. Features can be assigned to products, and when those products are purchased, Stripe will create an entitlement to the feature for the purchasing customer.

Endpoints

Product Feature 

A product_feature represents an attachment between a feature and a product. When a product is purchased that has a feature attached, Stripe will create an entitlement to the feature for the purchasing customer.

Endpoints

Active Entitlement 

An active entitlement describes access to a feature for a customer.

Endpoints

Scheduled Queries 

If you have scheduled a Sigma query, you’ll receive a sigma.scheduled_query_run.created webhook each time the query runs. The webhook contains a ScheduledQueryRun object, which you can use to retrieve the query results.

Endpoints

Report Runs 

The Report Run object represents an instance of a report type generated with specific run parameters. Once the object is created, Stripe begins processing the report. When the report has finished running, it will give you a reference to a file where you can retrieve your results. For an overview, see API Access to Reports.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Endpoints

Report Types 

The Report Type resource corresponds to a particular type of report, such as the “Activity summary” or “Itemized payouts” reports. These objects are identified by an ID belonging to a set of enumerated values. See API Access to Reports documentation for those Report Type IDs, along with required and optional parameters.

Note that certain report types can only be run based on your live-mode data (not test-mode data), and will error when queried without a live-mode API key.

Endpoints

Accounts 

A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access.

Endpoints

Account Owner 

Describes an owner of an account.

Endpoints

Session 

A Financial Connections Session is the secure way to programmatically launch the client-side Stripe.js modal that lets your users link their accounts.

Endpoints

Transactions 

A Transaction represents a real transaction that affects a Financial Connections Account balance.

Endpoints

Tax Calculations 

A Tax Calculation allows you to calculate the tax to collect from your customer.

Related guide: Calculate tax in your custom payment flow

Endpoints

Tax Registrations 

A Tax Registration lets us know that your business is registered to collect tax on payments within a region, enabling you to automatically collect tax.

Stripe doesn’t register on your behalf with the relevant authorities when you create a Tax Registration object. For more information on how to register to collect tax, see our guide.

Related guide: Using the Registrations API

Endpoints

Tax Transactions 

A Tax Transaction records the tax collected from or refunded to your customer.

Related guide: Calculate tax in your custom payment flow

Endpoints

Tax Settings 

You can use Tax Settings to manage configurations used by Stripe Tax calculations.

Related guide: Using the Settings API

Endpoints

Verification Session 

A VerificationSession guides you through the process of collecting and verifying the identities of your users. It contains details about the type of verification, such as what verification check to perform. Only create one VerificationSession for each verification in your system.

A VerificationSession transitions through multiple statuses throughout its lifetime as it progresses through the verification flow. The VerificationSession contains the user’s verified data after verification checks are complete.

Related guide: The Verification Sessions API

Endpoints

Verification Report 

A VerificationReport is the result of an attempt to collect and verify data from a user. The collection of verification checks performed is determined from the type and options parameters used. You can find the result of each verification check performed in the appropriate sub-resource: document, id_number, selfie.

Each VerificationReport contains a copy of any data collected by the user as well as reference IDs which can be used to access collected images through the FileUpload API. To configure and create VerificationReports, use the VerificationSession API.

Related guide: Accessing verification results.

Endpoints

Crypto Onramp Session 

A Crypto Onramp Session represents your customer’s session as they purchase cryptocurrency through Stripe. Once payment is successful, Stripe will fulfill the delivery of cryptocurrency to your user’s wallet and contain a reference to the crypto transaction ID.

You can create an onramp session on your server and embed the widget on your frontend. Alternatively, you can redirect your users to the standalone hosted onramp.

Related guide: Integrate the onramp

Endpoints

Crypto Onramp Quotes 

Crypto Onramp Quotes are estimated quotes for onramp conversions into all the different cryptocurrencies on different networks. The Quotes API allows you to display quotes in your product UI before directing the user to the onramp widget.

Related guide: Quotes API

Endpoints

Climate Order 

Orders represent your intent to purchase a particular Climate product. When you create an order, the payment is deducted from your merchant balance.

Endpoints

Climate Product 

A Climate product represents a type of carbon removal unit available for reservation. You can retrieve it to see the current price and availability.

Endpoints

Climate Supplier 

A supplier of carbon removal.

Endpoints

Forwarding Request 

Instructs Stripe to make a request on your behalf using the destination URL. The destination URL is activated by Stripe at the time of onboarding. Stripe verifies requests with your credentials provided during onboarding, and injects card details from the payment_method into the request.

Stripe redacts all sensitive fields and headers, including authentication credentials and card numbers, before storing the request and response data in the forwarding Request object, which are subject to a 30-day retention period.

You can provide a Stripe idempotency key to make sure that requests with the same key result in only one outbound request. The Stripe idempotency key provided should be unique and different from any idempotency keys provided on the underlying third-party request.

Forwarding Requests are synchronous requests that return a response or time out according to Stripe’s limits.

Related guide: Forward card details to third-party API endpoints.

Endpoints

Webhook Endpoints 

You can configure webhook endpoints via the API to be notified about events that happen in your Stripe account or connected accounts.

Most users configure webhooks from the dashboard, which provides a user interface for registering and testing your webhook endpoints.

Related guide: Setting up webhooks

Endpoints