Skip to content

The Stripe REST API. Please see https://stripe.com/docs/api for more details.

Contact​

Servers​

https://api.stripe.com/

Default​

Operations​

GET/v1/accountPOST/v1/account_linksPOST/v1/account_sessionsGET/v1/accountsPOST/v1/accountsGET/v1/accounts/{account}POST/v1/accounts/{account}DELETE/v1/accounts/{account}POST/v1/accounts/{account}/bank_accountsGET/v1/accounts/{account}/bank_accounts/{id}POST/v1/accounts/{account}/bank_accounts/{id}DELETE/v1/accounts/{account}/bank_accounts/{id}GET/v1/accounts/{account}/capabilitiesGET/v1/accounts/{account}/capabilities/{capability}POST/v1/accounts/{account}/capabilities/{capability}GET/v1/accounts/{account}/external_accountsPOST/v1/accounts/{account}/external_accountsGET/v1/accounts/{account}/external_accounts/{id}POST/v1/accounts/{account}/external_accounts/{id}DELETE/v1/accounts/{account}/external_accounts/{id}POST/v1/accounts/{account}/login_linksGET/v1/accounts/{account}/peoplePOST/v1/accounts/{account}/peopleGET/v1/accounts/{account}/people/{person}POST/v1/accounts/{account}/people/{person}DELETE/v1/accounts/{account}/people/{person}GET/v1/accounts/{account}/personsPOST/v1/accounts/{account}/personsGET/v1/accounts/{account}/persons/{person}POST/v1/accounts/{account}/persons/{person}DELETE/v1/accounts/{account}/persons/{person}POST/v1/accounts/{account}/rejectPOST/v1/accounts/{account}/unrejectGET/v1/apple_pay/domainsPOST/v1/apple_pay/domainsGET/v1/apple_pay/domains/{domain}DELETE/v1/apple_pay/domains/{domain}GET/v1/application_feesGET/v1/application_fees/{fee}/refunds/{id}POST/v1/application_fees/{fee}/refunds/{id}GET/v1/application_fees/{id}POST/v1/application_fees/{id}/refundGET/v1/application_fees/{id}/refundsPOST/v1/application_fees/{id}/refundsGET/v1/apps/installsPOST/v1/apps/installsGET/v1/apps/installs/{id}POST/v1/apps/installs/{id}POST/v1/apps/installs/{id}/uninstallGET/v1/apps/secretsPOST/v1/apps/secretsPOST/v1/apps/secrets/deleteGET/v1/apps/secrets/findGET/v1/balanceGET/v1/balance/historyGET/v1/balance/history/{id}GET/v1/balance_settingsPOST/v1/balance_settingsGET/v1/balance_transactionsGET/v1/balance_transactions/{id}GET/v1/billing/alertsPOST/v1/billing/alertsGET/v1/billing/alerts/{id}POST/v1/billing/alerts/{id}/activatePOST/v1/billing/alerts/{id}/archivePOST/v1/billing/alerts/{id}/deactivateGET/v1/billing/credit_balance_summaryGET/v1/billing/credit_balance_transactionsGET/v1/billing/credit_balance_transactions/{id}GET/v1/billing/credit_grantsPOST/v1/billing/credit_grantsGET/v1/billing/credit_grants/{id}POST/v1/billing/credit_grants/{id}POST/v1/billing/credit_grants/{id}/expirePOST/v1/billing/credit_grants/{id}/voidGET/v1/billing/feedback_optionsPOST/v1/billing/feedback_optionsGET/v1/billing/feedback_options/{id}POST/v1/billing/feedback_options/{id}POST/v1/billing/feedback_options/{id}/deactivatePOST/v1/billing/meter_event_adjustmentsPOST/v1/billing/meter_eventsGET/v1/billing/metersPOST/v1/billing/metersGET/v1/billing/meters/{id}POST/v1/billing/meters/{id}POST/v1/billing/meters/{id}/deactivateGET/v1/billing/meters/{id}/event_summariesPOST/v1/billing/meters/{id}/reactivateGET/v1/billing_portal/configurationsPOST/v1/billing_portal/configurationsGET/v1/billing_portal/configurations/{configuration}POST/v1/billing_portal/configurations/{configuration}POST/v1/billing_portal/sessionsGET/v1/chargesPOST/v1/chargesGET/v1/charges/searchGET/v1/charges/{charge}POST/v1/charges/{charge}POST/v1/charges/{charge}/captureGET/v1/charges/{charge}/disputePOST/v1/charges/{charge}/disputePOST/v1/charges/{charge}/dispute/closePOST/v1/charges/{charge}/refundGET/v1/charges/{charge}/refundsPOST/v1/charges/{charge}/refundsGET/v1/charges/{charge}/refunds/{refund}POST/v1/charges/{charge}/refunds/{refund}GET/v1/checkout/sessionsPOST/v1/checkout/sessionsGET/v1/checkout/sessions/{session}POST/v1/checkout/sessions/{session}POST/v1/checkout/sessions/{session}/expireGET/v1/checkout/sessions/{session}/line_itemsGET/v1/climate/ordersPOST/v1/climate/ordersGET/v1/climate/orders/{order}POST/v1/climate/orders/{order}POST/v1/climate/orders/{order}/cancelGET/v1/climate/productsGET/v1/climate/products/{product}GET/v1/climate/suppliersGET/v1/climate/suppliers/{supplier}GET/v1/confirmation_tokens/{confirmation_token}GET/v1/country_specsGET/v1/country_specs/{country}GET/v1/couponsPOST/v1/couponsGET/v1/coupons/{coupon}POST/v1/coupons/{coupon}DELETE/v1/coupons/{coupon}GET/v1/credit_notesPOST/v1/credit_notesGET/v1/credit_notes/previewGET/v1/credit_notes/preview/linesGET/v1/credit_notes/{credit_note}/linesGET/v1/credit_notes/{id}POST/v1/credit_notes/{id}POST/v1/credit_notes/{id}/voidPOST/v1/customer_sessionsGET/v1/customersPOST/v1/customersGET/v1/customers/searchGET/v1/customers/{customer}POST/v1/customers/{customer}DELETE/v1/customers/{customer}GET/v1/customers/{customer}/balance_transactionsPOST/v1/customers/{customer}/balance_transactionsGET/v1/customers/{customer}/balance_transactions/{transaction}POST/v1/customers/{customer}/balance_transactions/{transaction}GET/v1/customers/{customer}/bank_accountsPOST/v1/customers/{customer}/bank_accountsGET/v1/customers/{customer}/bank_accounts/{id}POST/v1/customers/{customer}/bank_accounts/{id}DELETE/v1/customers/{customer}/bank_accounts/{id}POST/v1/customers/{customer}/bank_accounts/{id}/verifyGET/v1/customers/{customer}/cardsPOST/v1/customers/{customer}/cardsGET/v1/customers/{customer}/cards/{id}POST/v1/customers/{customer}/cards/{id}DELETE/v1/customers/{customer}/cards/{id}GET/v1/customers/{customer}/cash_balancePOST/v1/customers/{customer}/cash_balanceGET/v1/customers/{customer}/cash_balance_transactionsGET/v1/customers/{customer}/cash_balance_transactions/{transaction}GET/v1/customers/{customer}/discountDELETE/v1/customers/{customer}/discountPOST/v1/customers/{customer}/funding_instructionsGET/v1/customers/{customer}/payment_methodsGET/v1/customers/{customer}/payment_methods/{payment_method}GET/v1/customers/{customer}/sourcesPOST/v1/customers/{customer}/sourcesGET/v1/customers/{customer}/sources/{id}POST/v1/customers/{customer}/sources/{id}DELETE/v1/customers/{customer}/sources/{id}POST/v1/customers/{customer}/sources/{id}/verifyGET/v1/customers/{customer}/subscriptionsPOST/v1/customers/{customer}/subscriptionsGET/v1/customers/{customer}/subscriptions/{subscription_exposed_id}POST/v1/customers/{customer}/subscriptions/{subscription_exposed_id}DELETE/v1/customers/{customer}/subscriptions/{subscription_exposed_id}GET/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discountDELETE/v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discountGET/v1/customers/{customer}/tax_idsPOST/v1/customers/{customer}/tax_idsGET/v1/customers/{customer}/tax_ids/{id}DELETE/v1/customers/{customer}/tax_ids/{id}GET/v1/disputesGET/v1/disputes/{dispute}POST/v1/disputes/{dispute}POST/v1/disputes/{dispute}/closeGET/v1/entitlements/active_entitlementsGET/v1/entitlements/active_entitlements/{id}GET/v1/entitlements/featuresPOST/v1/entitlements/featuresGET/v1/entitlements/features/{id}POST/v1/entitlements/features/{id}POST/v1/ephemeral_keysDELETE/v1/ephemeral_keys/{key}GET/v1/eventsGET/v1/events/{id}GET/v1/exchange_ratesGET/v1/exchange_rates/{rate_id}POST/v1/external_accounts/{id}GET/v1/file_linksPOST/v1/file_linksGET/v1/file_links/{link}POST/v1/file_links/{link}GET/v1/filesPOST/v1/filesGET/v1/files/{file}GET/v1/financial_connections/accountsGET/v1/financial_connections/accounts/{account}POST/v1/financial_connections/accounts/{account}/disconnectGET/v1/financial_connections/accounts/{account}/ownersPOST/v1/financial_connections/accounts/{account}/refreshPOST/v1/financial_connections/accounts/{account}/subscribePOST/v1/financial_connections/accounts/{account}/unsubscribePOST/v1/financial_connections/sessionsGET/v1/financial_connections/sessions/{session}GET/v1/financial_connections/transactionsGET/v1/financial_connections/transactions/{transaction}GET/v1/forwarding/requestsPOST/v1/forwarding/requestsGET/v1/forwarding/requests/{id}GET/v1/identity/verification_reportsGET/v1/identity/verification_reports/{report}GET/v1/identity/verification_sessionsPOST/v1/identity/verification_sessionsGET/v1/identity/verification_sessions/{session}POST/v1/identity/verification_sessions/{session}POST/v1/identity/verification_sessions/{session}/cancelPOST/v1/identity/verification_sessions/{session}/redactGET/v1/invoice_paymentsGET/v1/invoice_payments/{invoice_payment}GET/v1/invoice_rendering_templatesGET/v1/invoice_rendering_templates/{template}POST/v1/invoice_rendering_templates/{template}/archivePOST/v1/invoice_rendering_templates/{template}/unarchiveGET/v1/invoiceitemsPOST/v1/invoiceitemsGET/v1/invoiceitems/{invoiceitem}POST/v1/invoiceitems/{invoiceitem}DELETE/v1/invoiceitems/{invoiceitem}GET/v1/invoicesPOST/v1/invoicesPOST/v1/invoices/create_previewGET/v1/invoices/searchGET/v1/invoices/{invoice}POST/v1/invoices/{invoice}DELETE/v1/invoices/{invoice}POST/v1/invoices/{invoice}/add_linesPOST/v1/invoices/{invoice}/attach_paymentPOST/v1/invoices/{invoice}/finalizeGET/v1/invoices/{invoice}/linesPOST/v1/invoices/{invoice}/lines/{line_item_id}POST/v1/invoices/{invoice}/mark_uncollectiblePOST/v1/invoices/{invoice}/payPOST/v1/invoices/{invoice}/remove_linesPOST/v1/invoices/{invoice}/sendPOST/v1/invoices/{invoice}/update_linesPOST/v1/invoices/{invoice}/voidGET/v1/issuing/authorizationsGET/v1/issuing/authorizations/{authorization}POST/v1/issuing/authorizations/{authorization}POST/v1/issuing/authorizations/{authorization}/approvePOST/v1/issuing/authorizations/{authorization}/declineGET/v1/issuing/cardholdersPOST/v1/issuing/cardholdersGET/v1/issuing/cardholders/{cardholder}POST/v1/issuing/cardholders/{cardholder}GET/v1/issuing/cardsPOST/v1/issuing/cardsGET/v1/issuing/cards/{card}POST/v1/issuing/cards/{card}GET/v1/issuing/disputesPOST/v1/issuing/disputesGET/v1/issuing/disputes/{dispute}POST/v1/issuing/disputes/{dispute}POST/v1/issuing/disputes/{dispute}/submitGET/v1/issuing/personalization_designsPOST/v1/issuing/personalization_designsGET/v1/issuing/personalization_designs/{personalization_design}POST/v1/issuing/personalization_designs/{personalization_design}GET/v1/issuing/physical_bundlesGET/v1/issuing/physical_bundles/{physical_bundle}GET/v1/issuing/settlements/{settlement}POST/v1/issuing/settlements/{settlement}GET/v1/issuing/tokensGET/v1/issuing/tokens/{token}POST/v1/issuing/tokens/{token}GET/v1/issuing/transactionsGET/v1/issuing/transactions/{transaction}POST/v1/issuing/transactions/{transaction}POST/v1/link_account_sessionsGET/v1/link_account_sessions/{session}GET/v1/linked_accountsGET/v1/linked_accounts/{account}POST/v1/linked_accounts/{account}/disconnectGET/v1/linked_accounts/{account}/ownersPOST/v1/linked_accounts/{account}/refreshGET/v1/mandates/{mandate}GET/v1/payment_attempt_recordsGET/v1/payment_attempt_records/{id}GET/v1/payment_intentsPOST/v1/payment_intentsGET/v1/payment_intents/searchGET/v1/payment_intents/{intent}POST/v1/payment_intents/{intent}GET/v1/payment_intents/{intent}/amount_details_line_itemsPOST/v1/payment_intents/{intent}/apply_customer_balancePOST/v1/payment_intents/{intent}/cancelPOST/v1/payment_intents/{intent}/capturePOST/v1/payment_intents/{intent}/confirmPOST/v1/payment_intents/{intent}/increment_authorizationPOST/v1/payment_intents/{intent}/verify_microdepositsGET/v1/payment_linksPOST/v1/payment_linksGET/v1/payment_links/{payment_link}POST/v1/payment_links/{payment_link}GET/v1/payment_links/{payment_link}/line_itemsGET/v1/payment_method_configurationsPOST/v1/payment_method_configurationsGET/v1/payment_method_configurations/{configuration}POST/v1/payment_method_configurations/{configuration}GET/v1/payment_method_domainsPOST/v1/payment_method_domainsGET/v1/payment_method_domains/{payment_method_domain}POST/v1/payment_method_domains/{payment_method_domain}POST/v1/payment_method_domains/{payment_method_domain}/validateGET/v1/payment_methodsPOST/v1/payment_methodsGET/v1/payment_methods/{payment_method}POST/v1/payment_methods/{payment_method}POST/v1/payment_methods/{payment_method}/attachPOST/v1/payment_methods/{payment_method}/detachGET/v1/payment_recordsPOST/v1/payment_records/report_paymentGET/v1/payment_records/{id}POST/v1/payment_records/{id}/report_payment_attemptPOST/v1/payment_records/{id}/report_payment_attempt_canceledPOST/v1/payment_records/{id}/report_payment_attempt_failedPOST/v1/payment_records/{id}/report_payment_attempt_guaranteedPOST/v1/payment_records/{id}/report_payment_attempt_informationalPOST/v1/payment_records/{id}/report_refundGET/v1/payoutsPOST/v1/payoutsGET/v1/payouts/{payout}POST/v1/payouts/{payout}POST/v1/payouts/{payout}/cancelPOST/v1/payouts/{payout}/reverseGET/v1/plansPOST/v1/plansGET/v1/plans/{plan}POST/v1/plans/{plan}DELETE/v1/plans/{plan}GET/v1/pricesPOST/v1/pricesGET/v1/prices/searchGET/v1/prices/{price}POST/v1/prices/{price}GET/v1/product_catalog/trial_offersPOST/v1/product_catalog/trial_offersGET/v1/product_catalog/trial_offers/{id}POST/v1/product_catalog/trial_offers/{id}GET/v1/productsPOST/v1/productsGET/v1/products/searchGET/v1/products/{id}POST/v1/products/{id}DELETE/v1/products/{id}GET/v1/products/{product}/featuresPOST/v1/products/{product}/featuresGET/v1/products/{product}/features/{id}DELETE/v1/products/{product}/features/{id}GET/v1/promotion_codesPOST/v1/promotion_codesGET/v1/promotion_codes/{promotion_code}POST/v1/promotion_codes/{promotion_code}GET/v1/quotesPOST/v1/quotesGET/v1/quotes/{quote}POST/v1/quotes/{quote}POST/v1/quotes/{quote}/acceptPOST/v1/quotes/{quote}/cancelGET/v1/quotes/{quote}/computed_upfront_line_itemsPOST/v1/quotes/{quote}/finalizeGET/v1/quotes/{quote}/line_itemsGET/v1/quotes/{quote}/pdfGET/v1/radar/early_fraud_warningsGET/v1/radar/early_fraud_warnings/{early_fraud_warning}POST/v1/radar/payment_evaluationsGET/v1/radar/value_list_itemsPOST/v1/radar/value_list_itemsGET/v1/radar/value_list_items/{item}DELETE/v1/radar/value_list_items/{item}GET/v1/radar/value_listsPOST/v1/radar/value_listsGET/v1/radar/value_lists/{value_list}POST/v1/radar/value_lists/{value_list}DELETE/v1/radar/value_lists/{value_list}GET/v1/refundsPOST/v1/refundsGET/v1/refunds/{refund}POST/v1/refunds/{refund}POST/v1/refunds/{refund}/cancelGET/v1/reporting/report_runsPOST/v1/reporting/report_runsGET/v1/reporting/report_runs/{report_run}GET/v1/reporting/report_typesGET/v1/reporting/report_types/{report_type}GET/v1/reviewsGET/v1/reviews/{review}POST/v1/reviews/{review}/approveGET/v1/setup_attemptsGET/v1/setup_intentsPOST/v1/setup_intentsGET/v1/setup_intents/{intent}POST/v1/setup_intents/{intent}POST/v1/setup_intents/{intent}/cancelPOST/v1/setup_intents/{intent}/confirmPOST/v1/setup_intents/{intent}/verify_microdepositsGET/v1/shipping_ratesPOST/v1/shipping_ratesGET/v1/shipping_rates/{shipping_rate_token}POST/v1/shipping_rates/{shipping_rate_token}POST/v1/sigma/saved_queries/{id}GET/v1/sigma/scheduled_query_runsGET/v1/sigma/scheduled_query_runs/{scheduled_query_run}POST/v1/sourcesGET/v1/sources/{source}POST/v1/sources/{source}GET/v1/sources/{source}/mandate_notifications/{mandate_notification}GET/v1/sources/{source}/source_transactionsGET/v1/sources/{source}/source_transactions/{source_transaction}POST/v1/sources/{source}/verifyGET/v1/subscription_itemsPOST/v1/subscription_itemsGET/v1/subscription_items/{item}POST/v1/subscription_items/{item}DELETE/v1/subscription_items/{item}GET/v1/subscription_schedulesPOST/v1/subscription_schedulesGET/v1/subscription_schedules/{schedule}POST/v1/subscription_schedules/{schedule}POST/v1/subscription_schedules/{schedule}/cancelPOST/v1/subscription_schedules/{schedule}/releaseGET/v1/subscriptionsPOST/v1/subscriptionsGET/v1/subscriptions/searchGET/v1/subscriptions/{subscription_exposed_id}POST/v1/subscriptions/{subscription_exposed_id}DELETE/v1/subscriptions/{subscription_exposed_id}DELETE/v1/subscriptions/{subscription_exposed_id}/discountPOST/v1/subscriptions/{subscription}/migratePOST/v1/subscriptions/{subscription}/pausePOST/v1/subscriptions/{subscription}/resumeGET/v1/tax/associations/findPOST/v1/tax/calculationsGET/v1/tax/calculations/{calculation}GET/v1/tax/calculations/{calculation}/line_itemsGET/v1/tax/locationsPOST/v1/tax/locationsGET/v1/tax/locations/{location}GET/v1/tax/registrationsPOST/v1/tax/registrationsGET/v1/tax/registrations/{id}POST/v1/tax/registrations/{id}GET/v1/tax/settingsPOST/v1/tax/settingsPOST/v1/tax/transactions/create_from_calculationPOST/v1/tax/transactions/create_reversalGET/v1/tax/transactions/{transaction}GET/v1/tax/transactions/{transaction}/line_itemsGET/v1/tax_codesGET/v1/tax_codes/{id}GET/v1/tax_idsPOST/v1/tax_idsGET/v1/tax_ids/{id}DELETE/v1/tax_ids/{id}GET/v1/tax_ratesPOST/v1/tax_ratesGET/v1/tax_rates/{tax_rate}POST/v1/tax_rates/{tax_rate}GET/v1/terminal/configurationsPOST/v1/terminal/configurationsGET/v1/terminal/configurations/{configuration}POST/v1/terminal/configurations/{configuration}DELETE/v1/terminal/configurations/{configuration}POST/v1/terminal/connection_tokensGET/v1/terminal/locationsPOST/v1/terminal/locationsGET/v1/terminal/locations/{location}POST/v1/terminal/locations/{location}DELETE/v1/terminal/locations/{location}POST/v1/terminal/onboarding_linksGET/v1/terminal/readersPOST/v1/terminal/readersGET/v1/terminal/readers/{reader}POST/v1/terminal/readers/{reader}DELETE/v1/terminal/readers/{reader}POST/v1/terminal/readers/{reader}/cancel_actionPOST/v1/terminal/readers/{reader}/collect_inputsPOST/v1/terminal/readers/{reader}/collect_payment_methodPOST/v1/terminal/readers/{reader}/confirm_payment_intentPOST/v1/terminal/readers/{reader}/process_payment_intentPOST/v1/terminal/readers/{reader}/process_setup_intentPOST/v1/terminal/readers/{reader}/refund_paymentPOST/v1/terminal/readers/{reader}/set_reader_displayPOST/v1/terminal/refundsPOST/v1/test_helpers/confirmation_tokensPOST/v1/test_helpers/customers/{customer}/fund_cash_balancePOST/v1/test_helpers/issuing/authorizationsPOST/v1/test_helpers/issuing/authorizations/{authorization}/capturePOST/v1/test_helpers/issuing/authorizations/{authorization}/expirePOST/v1/test_helpers/issuing/authorizations/{authorization}/finalize_amountPOST/v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respondPOST/v1/test_helpers/issuing/authorizations/{authorization}/incrementPOST/v1/test_helpers/issuing/authorizations/{authorization}/reversePOST/v1/test_helpers/issuing/cards/{card}/shipping/deliverPOST/v1/test_helpers/issuing/cards/{card}/shipping/failPOST/v1/test_helpers/issuing/cards/{card}/shipping/returnPOST/v1/test_helpers/issuing/cards/{card}/shipping/shipPOST/v1/test_helpers/issuing/cards/{card}/shipping/submitPOST/v1/test_helpers/issuing/personalization_designs/{personalization_design}/activatePOST/v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivatePOST/v1/test_helpers/issuing/personalization_designs/{personalization_design}/rejectPOST/v1/test_helpers/issuing/settlementsPOST/v1/test_helpers/issuing/settlements/{settlement}/completePOST/v1/test_helpers/issuing/transactions/create_force_capturePOST/v1/test_helpers/issuing/transactions/create_unlinked_refundPOST/v1/test_helpers/issuing/transactions/{transaction}/refundPOST/v1/test_helpers/refunds/{refund}/expirePOST/v1/test_helpers/terminal/readers/{reader}/present_payment_methodPOST/v1/test_helpers/terminal/readers/{reader}/succeed_input_collectionPOST/v1/test_helpers/terminal/readers/{reader}/timeout_input_collectionGET/v1/test_helpers/test_clocksPOST/v1/test_helpers/test_clocksGET/v1/test_helpers/test_clocks/{test_clock}DELETE/v1/test_helpers/test_clocks/{test_clock}POST/v1/test_helpers/test_clocks/{test_clock}/advancePOST/v1/test_helpers/treasury/inbound_transfers/{id}/failPOST/v1/test_helpers/treasury/inbound_transfers/{id}/returnPOST/v1/test_helpers/treasury/inbound_transfers/{id}/succeedPOST/v1/test_helpers/treasury/outbound_payments/{id}POST/v1/test_helpers/treasury/outbound_payments/{id}/failPOST/v1/test_helpers/treasury/outbound_payments/{id}/postPOST/v1/test_helpers/treasury/outbound_payments/{id}/returnPOST/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}POST/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/failPOST/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/postPOST/v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/returnPOST/v1/test_helpers/treasury/received_creditsPOST/v1/test_helpers/treasury/received_debitsGET/v1/three_d_secure/authenticationsPOST/v1/three_d_secure/authenticationsGET/v1/three_d_secure/authentications/{authentication}POST/v1/three_d_secure/authentications/{authentication}/cancelPOST/v1/three_d_secure/authentications/{authentication}/submitPOST/v1/tokensGET/v1/tokens/{token}GET/v1/topupsPOST/v1/topupsGET/v1/topups/{topup}POST/v1/topups/{topup}POST/v1/topups/{topup}/cancelGET/v1/transfersPOST/v1/transfersGET/v1/transfers/{id}/reversalsPOST/v1/transfers/{id}/reversalsGET/v1/transfers/{transfer}POST/v1/transfers/{transfer}GET/v1/transfers/{transfer}/reversals/{id}POST/v1/transfers/{transfer}/reversals/{id}GET/v1/treasury/credit_reversalsPOST/v1/treasury/credit_reversalsGET/v1/treasury/credit_reversals/{credit_reversal}GET/v1/treasury/debit_reversalsPOST/v1/treasury/debit_reversalsGET/v1/treasury/debit_reversals/{debit_reversal}GET/v1/treasury/financial_accountsPOST/v1/treasury/financial_accountsGET/v1/treasury/financial_accounts/{financial_account}POST/v1/treasury/financial_accounts/{financial_account}POST/v1/treasury/financial_accounts/{financial_account}/closeGET/v1/treasury/financial_accounts/{financial_account}/featuresPOST/v1/treasury/financial_accounts/{financial_account}/featuresGET/v1/treasury/inbound_transfersPOST/v1/treasury/inbound_transfersGET/v1/treasury/inbound_transfers/{id}POST/v1/treasury/inbound_transfers/{inbound_transfer}/cancelGET/v1/treasury/outbound_paymentsPOST/v1/treasury/outbound_paymentsGET/v1/treasury/outbound_payments/{id}POST/v1/treasury/outbound_payments/{id}/cancelGET/v1/treasury/outbound_transfersPOST/v1/treasury/outbound_transfersGET/v1/treasury/outbound_transfers/{outbound_transfer}POST/v1/treasury/outbound_transfers/{outbound_transfer}/cancelGET/v1/treasury/received_creditsGET/v1/treasury/received_credits/{id}GET/v1/treasury/received_debitsGET/v1/treasury/received_debits/{id}GET/v1/treasury/transaction_entriesGET/v1/treasury/transaction_entries/{id}GET/v1/treasury/transactionsGET/v1/treasury/transactions/{id}GET/v1/webhook_endpointsPOST/v1/webhook_endpointsGET/v1/webhook_endpoints/{webhook_endpoint}POST/v1/webhook_endpoints/{webhook_endpoint}DELETE/v1/webhook_endpoints/{webhook_endpoint}

Retrieve account​

GET
/v1/account

Retrieves the details of an account.

Authorizations​

basicAuth

Basic HTTP authentication. Allowed headers-- Authorization: Basic <api_key> | Authorization: Basic <base64 hash of api_key:>

Type
HTTP (basic)
or
bearerAuth

Bearer HTTP authentication. Allowed headers-- Authorization: Bearer <api_key>

Type
HTTP (bearer)

Parameters​

Query Parameters

expand

Specifies which fields in the response should be expanded.

Type
array

Request Body​

application/x-www-form-urlencoded

Responses​

Successful response.

application/json

For new integrations, we recommend using the Accounts v2 API, in place of /v1/accounts and /v1/customers to represent a user.

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.

Business information about the account.

The business type.

Valid values"company""government_entity""individual""non_profit"

Whether the account can process charges.

The account's country.

Max Length5000

Time at which the account was connected. Measured in seconds since the Unix epoch.

Format"unix-time"

Three-letter ISO currency code representing the default currency for the account. This must be a currency that Stripe supports in the account's country.

Max Length5000

Whether account details have been submitted. Accounts with Stripe Dashboard access, which includes Standard accounts, cannot receive payouts before this is true. Accounts where this is false should be directed to an onboarding flow to finish submitting account details.

An email address associated with the account. It's not used for authentication and Stripe doesn't market to this field without explicit approval from the platform.

Max Length5000

External accounts (bank accounts and debit cards) currently attached to this account. External accounts are only returned for requests where controller[is_controller] is true.

The groups associated with the account.

Unique identifier for the object.

Max Length5000

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

A platform can only access a subset of data in 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.

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

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

Valid values"account"

Whether the funds in this account can be paid out.

Options for customizing how the account functions within Stripe.

The Stripe account type. Can be standard, express, custom, or none.

Valid values"custom""express""none""standard"

Playground​

Authorization
Variables
Key
Value
Body

Samples​


Powered by VitePress OpenAPI