Skip to content

Stripe Documentation

Main Navigation Home Getting Started Payments Billing Connect Quick Ref API Reference

Sidebar Navigation

Core

Api (1)

API Reference

Authentication (1)

Authentication

Errors (2)

Handling errors

Errors

Versioning (1)

Versioning

Metadata (1)

Metadata

Pagination (3)

Auto-pagination

Pagination

Search

Idempotent Requests (1)

Idempotent requests

Request Ids (1)

Request IDs

Expanding Objects (1)

Expanding Responses

Include Dependent Response Values (1)

Include-dependent response values (API v2)

Payments

Charges (8)

Capture a charge

Create a charge

Charges

List all charges

The Charge object

Retrieve a charge

Search charges

Update a charge

Payment Intents (14)

List all PaymentIntent LineItems

Reconcile a customer_balance PaymentIntent

Cancel a PaymentIntent

Capture a PaymentIntent

Confirm a PaymentIntent

Create a PaymentIntent

Increment an authorization

Payment Intents

List all PaymentIntents

The PaymentIntent object

Retrieve a PaymentIntent

Search PaymentIntents

Update a PaymentIntent

Verify microdeposits on a PaymentIntent

Setup Intents (9)

Cancel a SetupIntent

Confirm a SetupIntent

Create a SetupIntent

Setup Intents

List all SetupIntents

The SetupIntent object

Retrieve a SetupIntent

Update a SetupIntent

Verify microdeposits on a SetupIntent

Setup Attempts (3)

Setup Attempts

List all SetupAttempts

The SetupAttempt object

Confirmation Tokens (4)

Confirmation Token

The Confirmation Token object

Retrieve a ConfirmationToken

Create a test Confirmation Token

Payment Methods (10)

Attach a PaymentMethod to a Customer

Create a PaymentMethod

Retrieve a Customer's PaymentMethod

List a Customer's PaymentMethods

Detach a PaymentMethod from a Customer

Payment Methods

List PaymentMethods

The PaymentMethod object

Retrieve a PaymentMethod

Update a PaymentMethod

Payment Method Configurations (6)

Create a payment method configuration

Payment Method Configurations

List payment method configurations

The Payment Method Configuration object

Retrieve payment method configuration

Update payment method configuration

Payment Method Domains (7)

Create a payment method domain

Payment Method Domains

List payment method domains

The PaymentMethodDomain object

Retrieve a payment method domain

Update a payment method domain

Validate an existing payment method domain

Payment Link (7)

Create a payment link

Payment Link

List all payment links

The Payment Link object

Retrieve payment link

Retrieve a payment link's line items

Update a payment link

Payment Record (10)

Payment Records

The Payment Record object

Report a payment

Report payment attempt canceled

Report payment attempt failed

Report payment attempt guaranteed

Report payment attempt informational

Report a payment attempt

Report a refund

Retrieve a Payment Record

Payment Attempt Record (4)

Payment Attempt Records

List Payment Attempt Records

The Payment Attempt Record object

Retrieve a Payment Attempt Record

Shared Payment (10)

Shared Payment Granted Token

Create a test SharedPaymentGrantedToken

The Shared Payment Granted Token object

Retrieve a SharedPaymentGrantedToken

Revoke a test SharedPaymentGrantedToken

Shared Payment Issued Token

Create a SharedPaymentIssuedToken

The Shared Payment Issued Token object

Retrieve a SharedPaymentIssuedToken

Revoke a SharedPaymentIssuedToken

Mandates (3)

Mandates

The Mandate object

Retrieve a Mandate

Sources (7)

Attach a source

Create a source

Detach a source

Sources

The Source object

Retrieve a source

Update a source

Tokens (9)

Create an account token

Create a bank account token

Create a card token

Create a CVC update token

Create a person token

Create a PII token

Tokens

The Token object

Retrieve a token

Cards (7)

Create a card

Delete a card

Cards

List all cards

The Card object

Retrieve a card

Update a card

Checkout

Checkout (8)

Checkout Sessions

Create a Checkout Session

Expire a Checkout Session

Retrieve a Checkout Session's line items

List all Checkout Sessions

The Checkout Session object

Retrieve a Checkout Session

Update a Checkout Session

Customer Sessions (3)

Create a Customer Session

Customer Session

The Customer Session object

Customer Portal (9)

Customer Portal Configuration

Create a portal configuration

List portal configurations

The Customer portal configuration object

Retrieve a portal configuration

Update a portal configuration

Customer Portal Session

Create a portal session

The Customer Portal Session object

Customers

Customers (8)

Create a customer

Delete a customer

Customers

List all customers

The Customer object

Retrieve a customer

Search customers

Update a customer

Customer Balance Transactions (6)

Create a customer balance transaction

Customer Balance Transaction

List customer balance transactions

The Customer Balance Transaction object

Retrieve a customer balance transaction

Update a customer credit balance transaction

Customer Bank Accounts (8)

Create a bank account

Delete a bank account

Bank Accounts

List all bank accounts

The Bank Account object

Retrieve a bank account

Update a bank account

Verify a bank account

Refunds and Disputes

Refunds (7)

Cancel a refund

Create a refund

Refunds

List all refunds

The Refund object

Retrieve a refund

Update a refund

Disputes (9)

Use the API to respond to disputes

Visa Compelling Evidence 3.0 disputes

Visa compliance disputes

Close a dispute

Disputes

List all disputes

The Dispute object

Retrieve a dispute

Update a dispute

Credit Notes (11)

Create a credit note

Credit Note

The Credit Note Line Item object

Retrieve a credit note's line items

List all credit notes

The Credit Note object

Preview a credit note

Retrieve a credit note preview's line items

Retrieve a credit note

Update a credit note

Void a credit note

Fee Refunds (6)

Create an application fee refund

Application Fee Refunds

List all application fee refunds

The Application Fee Refund object

Retrieve an application fee refund

Update an application fee refund

Subscriptions and Billing

Subscriptions (10)

Cancel a subscription

Create a subscription

Subscriptions

List subscriptions

Migrate a subscription

The Subscription object

Resume a subscription

Retrieve a subscription

Search subscriptions

Update a subscription

Subscription Items (7)

Create a subscription item

Delete a subscription item

Subscription Items

List all subscription items

The Subscription Item object

Retrieve a subscription item

Update a subscription item

Subscription Schedules (8)

Cancel a schedule

Create a schedule

Subscription Schedule

List all schedules

The Subscription Schedule object

Release a schedule

Retrieve a schedule

Update a schedule

Billing (32)

Credit Balance Summary

The Credit Balance Summary object

Retrieve the credit balance summary for a customer

Credit Balance Transaction

List credit balance transactions

The Credit Balance Transaction object

Retrieve a credit balance transaction

Credit Grant

Create a credit grant

Expire a credit grant

List credit grants

The Credit Grant object

Retrieve a credit grant

Update a credit grant

Void a credit grant

Meters

Create a billing meter

Deactivate a billing meter

Meter Events

Meter Event Adjustment

Create a billing meter event adjustment

The Meter Event Adjustment object

Create a billing meter event

The Meter Event object

Meter Event Summary

List billing meter event summaries

The Meter Event Summary object

List billing meters

The Meter object

Reactivate a billing meter

Retrieve a billing meter

Update a billing meter

Plans (7)

Create a plan

Delete a plan

Plans

List all plans

The Plan object

Retrieve a plan

Update a plan

Prices (7)

Create a price

Prices

List all prices

The Price object

Retrieve a price

Search prices

Update a price

Products (8)

Create a product

Delete a product

Products

List all products

The Product object

Retrieve a product

Search products

Update a product

Coupons (7)

Create a coupon

Delete a coupon

Coupons

List all coupons

The Coupon object

Retrieve a coupon

Update a coupon

Discounts (4)

Delete a customer discount

Discounts

The Discount object

Delete a subscription discount

Promotion Codes (6)

Create a promotion code

Promotion Code

List all promotion codes

The Promotion Code object

Retrieve a promotion code

Update a promotion code

Quotes (12)

Accept a quote

Cancel a quote

Create a quote

Finalize a quote

Quote

Retrieve a quote's line items

Retrieve a quote's upfront line items

List all quotes

The Quote object

Download quote PDF

Retrieve a quote

Update a quote

Tax (24)

Tax Association

Find a Tax Association

The Tax Association object

Tax Calculations

Create a Calculation

Retrieve a Calculation's line items

The Tax Calculation object

Retrieve a Calculation

Tax Registrations

List registrations

Create a registration

The Tax Registration object

Retrieve a registration

Update a registration

Tax Settings

The Tax Setting object

Retrieve settings

Update settings

Tax Transactions

Create a Transaction from a Calculation

Create a reversal Transaction

Retrieve a Transaction's line items

The Tax Transaction object

Retrieve a Transaction

Tax Codes (4)

Tax Code

List all tax codes

The Tax Code object

Retrieve a tax code

Tax Ids (10)

Create a tax ID

Create a Customer tax ID

Delete a Customer tax ID

List all Customer tax IDs

Retrieve a Customer tax ID

Delete a tax ID

Tax IDs

List all tax IDs

The Tax ID object

Retrieve a tax ID

Tax Rates (6)

Create a tax rate

Tax Rate

List all tax rates

The Tax Rate object

Retrieve a tax rate

Update a tax rate

Shipping Rates (6)

Create a shipping rate

Shipping Rates

List all shipping rates

The Shipping Rate object

Retrieve a shipping rate

Update a shipping rate

Product Feature (5)

Attach a feature to a product

Product Feature

List all features attached to a product

The ProductFeature object

Remove a feature from a product

Entitlements (9)

Active Entitlement

List all active entitlements

The Active Entitlement object

Retrieve an active entitlement

Feature

Create a feature

List all features

The Feature object

Updates a feature

Invoicing

Invoices (15)

Attach a payment to an Invoice

Create an invoice

Create a preview invoice

Delete a draft invoice

Finalize an invoice

Invoices

List all invoices

Mark an invoice as uncollectible

The Invoice object

Pay an invoice

Retrieve an invoice

Search invoices

Send an invoice for manual payment

Update an invoice

Void an invoice

Invoiceitems (7)

Create an invoice item

Delete an invoice item

Invoice Items

List all invoice items

The Invoice Item object

Retrieve an invoice item

Update an invoice item

Invoice Line Item (7)

Bulk add invoice line items

Invoice Line Item

Bulk remove invoice line items

Bulk update invoice line items

The Invoice Line Item object

Retrieve an invoice's line items

Update an invoice's line item

Invoice Payment (4)

Invoice Payment

List all payments for an invoice

The Invoice Payment object

Retrieve an InvoicePayment

Invoice Rendering Template (6)

Archive an invoice rendering template

Invoice Rendering Templates

List all invoice rendering templates

The Invoice Rendering Template object

Retrieve an invoice rendering template

Unarchive an invoice rendering template

Connect (Multiparty)

Accounts (10)

Create an account

Delete an account

Accounts

List all connected accounts

Login Links

Create a login link

The Login Link object

The Account object

Retrieve account

Update an account

Account (1)

Reject an account

Account Links (3)

Create an account link

Account Links

The Account Link object

Account Sessions (3)

Create an Account Session

Account Session

The Account Session object

Connected Accounts (1)

Connected Accounts

Capabilities (5)

Capabilities

List all account capabilities

The Capability object

Retrieve an Account Capability

Update an Account Capability

Persons (7)

Create a person

Delete a person

Person

List all persons

The Person object

Retrieve a person

Update a person

External Accounts (1)

External Bank Accounts

External Account Bank Accounts (6)

Create a bank account

Delete a bank account

List all bank accounts

The External Bank Account object

Retrieve a bank account

Update a bank account

External Account Cards (7)

Create a card

Delete a card

External Account Cards

List all cards

The External Account Card object

Retrieve a card

Update a card

Application Fees (4)

Application Fees

List all application fees

The Application Fee object

Retrieve an application fee

Transfers (6)

Create a transfer

Transfers

List all transfers

The Transfer object

Retrieve a transfer

Update a transfer

Transfer Reversals (6)

Create a transfer reversal

Transfer Reversals

List all reversals

The Transfer Reversal object

Retrieve a reversal

Update a reversal

Payouts (8)

Cancel a payout

Create a payout

Payouts

List all payouts

The Payout object

Retrieve a payout

Reverse a payout

Update a payout

Issuing (Cards)

Issuing (69)

Authorizations

Approve an authorization

Decline an authorization

List all authorizations

The Authorization object

Respond to fraud challenge

Retrieve an authorization

Capture a test-mode authorization

Create a test-mode authorization

Expire a test-mode authorization

Finalize a test-mode authorization's amount

Increment a test-mode authorization

Reverse a test-mode authorization

Update an authorization

Cardholders

Create a cardholder

List all cardholders

The Cardholder object

Retrieve a cardholder

Update a cardholder

Cards

Create a card

List all cards

The Card object

Retrieve a card

Deliver a testmode card

Fail a testmode card

Return a testmode card

Ship a testmode card

Submit a testmode card

Update a card

Submit a dispute

Disputes

Create a dispute

List all disputes

The Dispute object

Retrieve a dispute

Update a dispute

Funding Instructions

Create funding instructions

Simulate a top up

List all funding instructions

The Funding Instruction object

Personalization Designs

Activate a testmode personalization design

Create a personalization design

Deactivate a testmode personalization design

List all personalization designs

The Personalization Design object

Reject a testmode personalization design

Retrieve a personalization design

Update a personalization design

Physical Bundles

List all physical bundles

The Physical Bundle object

Retrieve a physical bundle

Tokens

List all issuing tokens for card

The Token object

Retrieve an issuing token

Update a token status

Transactions

List all transactions

The Transaction object

Retrieve a transaction

Create a test-mode force capture

Create a test-mode unlinked refund

Refund a test-mode transaction

Update a transaction

Topups (7)

Cancel a top-up

Create a top-up

Top-ups

List all top-ups

The Top-up object

Retrieve a top-up

Update a top-up

Terminal (In-Person)

Terminal (62)

Configuration

Create a Configuration

Delete a Configuration

List all Configurations

The Configuration object

Retrieve a Configuration

Update a Configuration

Connection Token

Create a Connection Token

The Connection Token object

Terminal Hardware Order

Cancel a Terminal Hardware Order

Create a Terminal Hardware Order

List all Terminal Hardware Orders

The TerminalHardwareOrder object

Preview a Terminal Hardware Order

Retrieve a Terminal Hardware Order

Test mode: Mark a Terminal Hardware Order as Delivered

Test mode: Mark a Terminal Hardware Order as Ready To Ship

Test mode: Mark a Terminal Hardware Order as Undeliverable

Test mode: Mark a Terminal Hardware Order as Shipped

Terminal Hardware Product

List all Terminal Hardware Products

The TerminalHardwareProduct object

Retrieve a Terminal Hardware Product

Terminal Hardware Shipping Method

List all Terminal Hardware Shipping Methods

The Terminal Hardware Shipping Method object

Retrieve a Terminal Hardware Shipping Method

Terminal Hardware SKU

List all Terminal Hardware SKUs

The TerminalHardwareSKU object

Retrieve an available Terminal Hardware SKU

Location

Create a Location

Delete a Location

List all Locations

The Location object

Retrieve a Location

Update a Location

Onboarding Link

Create an Onboarding Link

The Onboarding Link object

Reader

Cancel the current reader action

Collect inputs using a Reader

Hand off a PaymentIntent to a Reader and collect card details

Confirm a PaymentIntent on the Reader

Create a Reader

Delete a Reader

List all Readers

The Reader object

Simulate presenting a payment method

Hand-off a PaymentIntent to a Reader

Hand-off a SetupIntent to a Reader

Refund a Charge or a PaymentIntent in-person

Retrieve a Reader

Set reader display

Simulate a successful input collection

Simulate an input collection timeout

Update a Reader

JavaScript API reference

Treasury (Banking)

Treasury (67)

Credit Reversals

Create a CreditReversal

List all CreditReversals

The CreditReversal object

Retrieve a CreditReversal

Debit Reversals

Create a DebitReversal

List all DebitReversals

The DebitReversal object

Retrieve a DebitReversal

Financial Account Features

The FinancialAccount Feature object

Retrieve FinancialAccount Features

Update FinancialAccount Features

Financial Accounts

Create a FinancialAccount

List all FinancialAccounts

The FinancialAccount object

Retrieve a FinancialAccount

Update a FinancialAccount

Inbound Transfers

Cancel an InboundTransfer

Create an InboundTransfer

List all InboundTransfers

The InboundTransfer object

Retrieve an InboundTransfer

Test mode: Fail an InboundTransfer

Test mode: Return an InboundTransfer

Test mode: Succeed an InboundTransfer

Outbound Payments

Cancel an OutboundPayment

Create an OutboundPayment

List all OutboundPayments

The Outbound Payment object

Retrieve an OutboundPayment

Test mode: Fail an OutboundPayment

Test mode: Post an OutboundPayment

Test mode: Return an OutboundPayment

Test mode: Update an OutboundPayment

Outbound Transfers

Cancel an OutboundTransfer

Create an OutboundTransfer

List all OutboundTransfers

The OutboundTransfer object

Retrieve an OutboundTransfer

Test mode: Fail an OutboundTransfer

Test mode: Post an OutboundTransfer

Test mode: Return an OutboundTransfer

Test mode: Update an OutboundTransfer

Received Credits

List all ReceivedCredits

The ReceivedCredit object

Retrieve a ReceivedCredit

Test mode: Create a ReceivedCredit

Received Debits

List all ReceivedDebits

The ReceivedDebit object

Retrieve a ReceivedDebit

Test mode: Create a ReceivedDebit

Transaction Entries

List all TransactionEntries

The TransactionEntry object

Retrieve a TransactionEntry

Transactions

List all Transactions

The Transaction object

Retrieve a Transaction

Balance (3)

The Balance object

Retrieve balance

Balance

Balance Settings (4)

Balance Settings

The Balance Setting object

Retrieve balance settings

Update balance settings

Balance Transactions (4)

Balance Transactions

List all balance transactions

The Balance Transaction object

Retrieve a balance transaction

Cash Balance (4)

Cash Balance

The Cash balance object

Retrieve a cash balance

Update a cash balance's settings

Cash Balance Transactions (6)

Create or retrieve funding instructions for a customer cash balance

Fund a test mode cash balance

Cash Balance Transaction

List cash balance transactions

The Cash Balance Transaction object

Retrieve a cash balance transaction

Reserves (1)

Reserves

Reserve (19)

Reserve Holds

Create a ReserveHold

List ReserveHolds

The ReserveHold object

Retrieve a ReserveHold

Update a ReserveHold

Reserve Plans

Create a ReservePlan

Disable a ReservePlan

List ReservePlans

The ReservePlan object

Retrieve a ReservePlan

Update a ReservePlan

Reserve Releases

Create a ReserveRelease

List ReserveReleases

The ReserveRelease object

Retrieve a ReserveRelease

Update a ReserveRelease

Financial Connections

Financial Connections (4)

Use the Financial Connections API to relink an account

Relink Financial Connections accounts used for data products.

Relink Financial Connections accounts used for payments or payouts.

Retrieve a Transaction

Financial Connections (19)

Accounts

Disconnect an Account

List Accounts

The Account object

Refresh Account data

Retrieve an Account

Subscribe to data refreshes for an Account

Unsubscribe from data refreshes for an Account

Account Owner

List Account Owners

The Account Ownership object

The Account Owner object

Session

Create a Session

The Session object

Retrieve a Session

Transactions

List Transactions

The Transaction object

Identity and KYC

Identity (12)

Verification Report

List VerificationReports

The VerificationReport object

Retrieve a VerificationReport

Verification Session

Cancel a VerificationSession

Create a VerificationSession

List VerificationSessions

The VerificationSession object

Redact a VerificationSession

Retrieve a VerificationSession

Update a VerificationSession

Country Specs (4)

Country Specs

List Country Specs

The Country Spec object

Retrieve a Country Spec

Privacy (12)

Redaction Job

Cancel a redaction job

Create a redaction job

List all redaction jobs

The Redaction Job object

Retrieve a redaction job

Run a redaction job

Update a redaction job

Validate a redaction job

Redaction Job Validation Error

List all validation errors

The Redaction Job Validation Error object

Radar (Fraud)

Radar (26)

Customer Evaluation

Create a customer evaluation

The Customer Evaluation object

Report an event on a customer evaluation

Early Fraud Warning

List all early fraud warnings

The Early Fraud Warning object

Retrieve an early fraud warning

Reviews

Approve a review

List all open reviews

The Review object

Retrieve a review

Value List Items

Create a value list item

Delete a value list item

List all value list items

The Value List Item object

Retrieve a value list item

Value Lists

Create a value list

Delete a value list

List all value lists

The Value List object

Retrieve a value list

Update a value list

Forwarding (5)

Create a ForwardingRequest

List all ForwardingRequests

Retrieve a ForwardingRequest

Forwarding Request

The ForwardingRequest object

Apps and Tools

Apps (5)

Delete a Secret

Find a Secret

List secrets

The Secret object

Set a Secret

Sigma (4)

Scheduled Queries

List all scheduled query runs

The Scheduled Query object

Retrieve a scheduled query run

Reporting (9)

Report Runs

Create a Report Run

List all Report Runs

The Report Run object

Retrieve a Report Run

Report Types

List all Report Types

The Report Type object

Retrieve a Report Type

File Links (6)

Create a file link

File Links

List all file links

The File Link object

Retrieve a file link

Update a file link

Files (5)

Create a file

Files

List all files

The File object

Retrieve a file

Webhook Endpoints (7)

Create a webhook endpoint

Delete a webhook endpoint

Webhook Endpoints

List all webhook endpoints

The Webhook Endpoint object

Retrieve a webhook endpoint

Update a webhook endpoint

Events (5)

Events

List all events

The Event object

Retrieve an event

Types of events

Test Clocks (7)

Advance a test clock

Create a test clock

Delete a test clock

Test Clocks

List all test clocks

The Test Clock object

Retrieve a test clock

Secret Management (1)

Secrets

Climate

Climate (15)

Climate Order

Cancel an order

Create an order

List orders

The Climate order object

Retrieve an order

Update an order

Climate Product

List products

The Climate product object

Retrieve a product

Climate Supplier

List suppliers

The Climate supplier object

Retrieve a supplier

Capital

Capital (8)

The Financing offer object

Financing Offer

List financing offers

Mark that a financing offer has been delivered

Retrieve a given financing offer

Financing Summary

Retrieve financing summary

The Financing Summary object

Reports

Reports (1)

How the Reports API works

Revenue Recognition (1)

Revenue Recognition API

v2 API

V2 (53)

Meter Event Adjustments

Create a Meter Event Adjustment

The Meter Event Adjustment object

Create a Meter Event with asynchronous validation

Create a Meter Event with synchronous validation

The Meter Event object

Account Links

Create an account link

The Account Link object

Account Tokens

Create an account token

The Account Token object

Retrieve an account token

Accounts

Close an account

Create an account

Account event types

List accounts

The Account object

Retrieve an account

Update an account

Event Destinations

Create an Event Destination

Delete an Event Destination

Disable an Event Destination

Enable an Event Destination

Event Destination event types

List Event Destinations

The Event Destination object

Retrieve an Event Destination

Update an Event Destination

Events

Types of events

List Events

The Event object

Ping an Event Destination

Retrieve an Event

Person Tokens

Create a person token

The Person Token object

Retrieve a person token

Persons

Create a person

Delete a person

Person event types

List persons

The Person object

Retrieve a person

Update a person

Meter Event Streams

Create a Meter Event Stream Authentication Session

The Meter Event Session object

Meter Events

On this page

Mandates

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

Endpoints

Retrieve a Mandate

GET /v1/mandates/:id

Events

mandate.updated Occurs whenever a Mandate is updated.

Pager

Next pageAPI Reference

Stripe API Reference - Self-contained docs reference, refreshed 2026-05-18