# Apivom Atlas — Stripe API

> Apivom Atlas integration for Stripe API: 585 gateway routes over `api.stripe.com`, available through the Apivom platform (Apivom Iris workflows and the Apivom Atlas API portal). Auth model: caller-supplied token passed through to the vendor.

Notes for AI assistants:

- This catalog mirrors the vendor's public API surface as registered in Apivom Atlas (0 read-only, 585 write routes).
- Access is provisioned per customer. Commercialized providers are self-service in the Atlas portal; for everything else [request a demo](https://apivom.com/en/demo).
- Credentials are always owned by the calling tenant — Apivom Atlas is a stateless gateway.

## Routes

- `GET /v1/account` (v1-account)
- `POST /v1/account_links` (v1-account-links-post) — params: account, collect, collection_options, expand, refresh_url, return_url, type
- `POST /v1/account_sessions` (v1-account-sessions-post) — params: account, components, expand
- `GET /v1/accounts` (v1-accounts)
- `GET /v1/accounts/{account}` (v1-accounts-by-account)
- `GET /v1/accounts/{account}/bank_accounts/{id}` (v1-accounts-by-account-bank-accounts-by-id)
- `DELETE /v1/accounts/{account}/bank_accounts/{id}` (v1-accounts-by-account-bank-accounts-by-id-delete)
- `POST /v1/accounts/{account}/bank_accounts/{id}` (v1-accounts-by-account-bank-accounts-by-id-post) — params: account_holder_name, account_holder_type, account_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, default_for_currency, documents, exp_month, exp_year, expand, metadata, name
- `POST /v1/accounts/{account}/bank_accounts` (v1-accounts-by-account-bank-accounts-post) — params: bank_account, default_for_currency, expand, external_account, metadata
- `GET /v1/accounts/{account}/capabilities` (v1-accounts-by-account-capabilities)
- `GET /v1/accounts/{account}/capabilities/{capability}` (v1-accounts-by-account-capabilities-by-capability)
- `POST /v1/accounts/{account}/capabilities/{capability}` (v1-accounts-by-account-capabilities-by-capability-post) — params: expand, requested
- `DELETE /v1/accounts/{account}` (v1-accounts-by-account-delete)
- `GET /v1/accounts/{account}/external_accounts` (v1-accounts-by-account-external-accounts)
- `GET /v1/accounts/{account}/external_accounts/{id}` (v1-accounts-by-account-external-accounts-by-id)
- `DELETE /v1/accounts/{account}/external_accounts/{id}` (v1-accounts-by-account-external-accounts-by-id-delete)
- `POST /v1/accounts/{account}/external_accounts/{id}` (v1-accounts-by-account-external-accounts-by-id-post) — params: account_holder_name, account_holder_type, account_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, default_for_currency, documents, exp_month, exp_year, expand, metadata, name
- `POST /v1/accounts/{account}/external_accounts` (v1-accounts-by-account-external-accounts-post) — params: bank_account, default_for_currency, expand, external_account, metadata
- `POST /v1/accounts/{account}/login_links` (v1-accounts-by-account-login-links-post) — params: expand
- `GET /v1/accounts/{account}/people` (v1-accounts-by-account-people)
- `GET /v1/accounts/{account}/people/{person}` (v1-accounts-by-account-people-by-person)
- `DELETE /v1/accounts/{account}/people/{person}` (v1-accounts-by-account-people-by-person-delete)
- `POST /v1/accounts/{account}/people/{person}` (v1-accounts-by-account-people-by-person-post) — params: additional_tos_acceptances, address, address_kana, address_kanji, dob, documents, email, expand, first_name, first_name_kana, first_name_kanji, full_name_aliases, gender, id_number, id_number_secondary, last_name, last_name_kana, last_name_kanji, maiden_name, metadata, nationality, person_token, phone, political_exposure, registered_address, relationship, ssn_last_4, us_cfpb_data, verification
- `POST /v1/accounts/{account}/people` (v1-accounts-by-account-people-post) — params: additional_tos_acceptances, address, address_kana, address_kanji, dob, documents, email, expand, first_name, first_name_kana, first_name_kanji, full_name_aliases, gender, id_number, id_number_secondary, last_name, last_name_kana, last_name_kanji, maiden_name, metadata, nationality, person_token, phone, political_exposure, registered_address, relationship, ssn_last_4, us_cfpb_data, verification
- `GET /v1/accounts/{account}/persons` (v1-accounts-by-account-persons)
- `GET /v1/accounts/{account}/persons/{person}` (v1-accounts-by-account-persons-by-person)
- `DELETE /v1/accounts/{account}/persons/{person}` (v1-accounts-by-account-persons-by-person-delete)
- `POST /v1/accounts/{account}/persons/{person}` (v1-accounts-by-account-persons-by-person-post) — params: additional_tos_acceptances, address, address_kana, address_kanji, dob, documents, email, expand, first_name, first_name_kana, first_name_kanji, full_name_aliases, gender, id_number, id_number_secondary, last_name, last_name_kana, last_name_kanji, maiden_name, metadata, nationality, person_token, phone, political_exposure, registered_address, relationship, ssn_last_4, us_cfpb_data, verification
- `POST /v1/accounts/{account}/persons` (v1-accounts-by-account-persons-post) — params: additional_tos_acceptances, address, address_kana, address_kanji, dob, documents, email, expand, first_name, first_name_kana, first_name_kanji, full_name_aliases, gender, id_number, id_number_secondary, last_name, last_name_kana, last_name_kanji, maiden_name, metadata, nationality, person_token, phone, political_exposure, registered_address, relationship, ssn_last_4, us_cfpb_data, verification
- `POST /v1/accounts/{account}` (v1-accounts-by-account-post) — params: account_token, business_profile, business_type, capabilities, company, default_currency, documents, email, expand, external_account, groups, individual, metadata, settings, tos_acceptance
- `POST /v1/accounts/{account}/reject` (v1-accounts-by-account-reject-post) — params: expand, reason
- `POST /v1/accounts` (v1-accounts-post) — params: account_token, bank_account, business_profile, business_type, capabilities, company, controller, country, default_currency, documents, email, expand, external_account, groups, individual, metadata, settings, tos_acceptance, type
- `GET /v1/apple_pay/domains` (v1-apple-pay-domains)
- `GET /v1/apple_pay/domains/{domain}` (v1-apple-pay-domains-by-domain)
- `DELETE /v1/apple_pay/domains/{domain}` (v1-apple-pay-domains-by-domain-delete)
- `POST /v1/apple_pay/domains` (v1-apple-pay-domains-post) — params: domain_name, expand
- `GET /v1/application_fees` (v1-application-fees)
- `GET /v1/application_fees/{fee}/refunds/{id}` (v1-application-fees-by-fee-refunds-by-id)
- `POST /v1/application_fees/{fee}/refunds/{id}` (v1-application-fees-by-fee-refunds-by-id-post) — params: expand, metadata
- `GET /v1/application_fees/{id}` (v1-application-fees-by-id)
- `POST /v1/application_fees/{id}/refund` (v1-application-fees-by-id-refund-post) — params: amount, directive, expand
- `GET /v1/application_fees/{id}/refunds` (v1-application-fees-by-id-refunds)
- `POST /v1/application_fees/{id}/refunds` (v1-application-fees-by-id-refunds-post) — params: amount, expand, metadata
- `GET /v1/apps/secrets` (v1-apps-secrets)
- `POST /v1/apps/secrets/delete` (v1-apps-secrets-delete-post) — params: expand, name, scope
- `GET /v1/apps/secrets/find` (v1-apps-secrets-find)
- `POST /v1/apps/secrets` (v1-apps-secrets-post) — params: expand, expires_at, name, payload, scope
- `GET /v1/balance` (v1-balance)
- `GET /v1/balance/history` (v1-balance-history)
- `GET /v1/balance/history/{id}` (v1-balance-history-by-id)
- `GET /v1/balance_settings` (v1-balance-settings)
- `POST /v1/balance_settings` (v1-balance-settings-post) — params: expand, payments
- `GET /v1/balance_transactions` (v1-balance-transactions)
- `GET /v1/balance_transactions/{id}` (v1-balance-transactions-by-id)
- `GET /v1/billing/alerts` (v1-billing-alerts)
- `GET /v1/billing/alerts/{id}` (v1-billing-alerts-by-id)
- `POST /v1/billing/alerts/{id}/activate` (v1-billing-alerts-by-id-activate-post) — params: expand
- `POST /v1/billing/alerts/{id}/archive` (v1-billing-alerts-by-id-archive-post) — params: expand
- `POST /v1/billing/alerts/{id}/deactivate` (v1-billing-alerts-by-id-deactivate-post) — params: expand
- `POST /v1/billing/alerts` (v1-billing-alerts-post) — params: alert_type, expand, title, usage_threshold
- `GET /v1/billing/credit_balance_summary` (v1-billing-credit-balance-summary)
- `GET /v1/billing/credit_balance_transactions` (v1-billing-credit-balance-transactions)
- `GET /v1/billing/credit_balance_transactions/{id}` (v1-billing-credit-balance-transactions-by-id)
- `GET /v1/billing/credit_grants` (v1-billing-credit-grants)
- `GET /v1/billing/credit_grants/{id}` (v1-billing-credit-grants-by-id)
- `POST /v1/billing/credit_grants/{id}/expire` (v1-billing-credit-grants-by-id-expire-post) — params: expand
- `POST /v1/billing/credit_grants/{id}` (v1-billing-credit-grants-by-id-post) — params: expand, expires_at, metadata
- `POST /v1/billing/credit_grants/{id}/void` (v1-billing-credit-grants-by-id-void-post) — params: expand
- `POST /v1/billing/credit_grants` (v1-billing-credit-grants-post) — params: amount, applicability_config, category, customer, customer_account, effective_at, expand, expires_at, metadata, name, priority
- `POST /v1/billing/meter_event_adjustments` (v1-billing-meter-event-adjustments-post) — params: cancel, event_name, expand, type
- `POST /v1/billing/meter_events` (v1-billing-meter-events-post) — params: event_name, expand, identifier, payload, timestamp
- `GET /v1/billing/meters` (v1-billing-meters)
- `GET /v1/billing/meters/{id}` (v1-billing-meters-by-id)
- `POST /v1/billing/meters/{id}/deactivate` (v1-billing-meters-by-id-deactivate-post) — params: expand
- `GET /v1/billing/meters/{id}/event_summaries` (v1-billing-meters-by-id-event-summaries)
- `POST /v1/billing/meters/{id}` (v1-billing-meters-by-id-post) — params: display_name, expand
- `POST /v1/billing/meters/{id}/reactivate` (v1-billing-meters-by-id-reactivate-post) — params: expand
- `POST /v1/billing/meters` (v1-billing-meters-post) — params: customer_mapping, default_aggregation, display_name, event_name, event_time_window, expand, value_settings
- `GET /v1/billing_portal/configurations` (v1-billing-portal-configurations)
- `GET /v1/billing_portal/configurations/{configuration}` (v1-billing-portal-configurations-by-configuration)
- `POST /v1/billing_portal/configurations/{configuration}` (v1-billing-portal-configurations-by-configuration-post) — params: active, business_profile, default_return_url, expand, features, login_page, metadata, name
- `POST /v1/billing_portal/configurations` (v1-billing-portal-configurations-post) — params: business_profile, default_return_url, expand, features, login_page, metadata, name
- `POST /v1/billing_portal/sessions` (v1-billing-portal-sessions-post) — params: configuration, customer, customer_account, expand, flow_data, locale, on_behalf_of, return_url
- `GET /v1/charges` (v1-charges)
- `GET /v1/charges/{charge}` (v1-charges-by-charge)
- `POST /v1/charges/{charge}/capture` (v1-charges-by-charge-capture-post) — params: amount, application_fee, application_fee_amount, expand, receipt_email, statement_descriptor, statement_descriptor_suffix, transfer_data, transfer_group
- `GET /v1/charges/{charge}/dispute` (v1-charges-by-charge-dispute)
- `POST /v1/charges/{charge}/dispute/close` (v1-charges-by-charge-dispute-close-post) — params: expand
- `POST /v1/charges/{charge}/dispute` (v1-charges-by-charge-dispute-post) — params: evidence, expand, metadata, submit
- `POST /v1/charges/{charge}` (v1-charges-by-charge-post) — params: customer, description, expand, fraud_details, metadata, receipt_email, shipping, transfer_group
- `POST /v1/charges/{charge}/refund` (v1-charges-by-charge-refund-post) — params: amount, expand, instructions_email, metadata, payment_intent, reason, refund_application_fee, reverse_transfer
- `GET /v1/charges/{charge}/refunds` (v1-charges-by-charge-refunds)
- `GET /v1/charges/{charge}/refunds/{refund}` (v1-charges-by-charge-refunds-by-refund)
- `POST /v1/charges/{charge}/refunds/{refund}` (v1-charges-by-charge-refunds-by-refund-post) — params: expand, metadata
- `POST /v1/charges/{charge}/refunds` (v1-charges-by-charge-refunds-post) — params: amount, currency, customer, expand, instructions_email, metadata, origin, payment_intent, reason, refund_application_fee, reverse_transfer
- `POST /v1/charges` (v1-charges-post) — params: amount, application_fee, application_fee_amount, capture, card, currency, customer, description, destination, expand, metadata, on_behalf_of, radar_options, receipt_email, shipping, source, statement_descriptor, statement_descriptor_suffix, transfer_data, transfer_group
- `GET /v1/charges/search` (v1-charges-search)
- `GET /v1/checkout/sessions` (v1-checkout-sessions)
- `GET /v1/checkout/sessions/{session}` (v1-checkout-sessions-by-session)
- `POST /v1/checkout/sessions/{session}/expire` (v1-checkout-sessions-by-session-expire-post) — params: expand
- `GET /v1/checkout/sessions/{session}/line_items` (v1-checkout-sessions-by-session-line-items)
- `POST /v1/checkout/sessions/{session}` (v1-checkout-sessions-by-session-post) — params: collected_information, expand, line_items, metadata, shipping_options
- `POST /v1/checkout/sessions` (v1-checkout-sessions-post) — params: adaptive_pricing, after_expiration, allow_promotion_codes, automatic_tax, billing_address_collection, branding_settings, cancel_url, client_reference_id, consent_collection, currency, custom_fields, custom_text, customer, customer_account, customer_creation, customer_email, customer_update, discounts, excluded_payment_method_types, expand, expires_at, integration_identifier, invoice_creation, line_items, locale, managed_payments, metadata, mode, name_collection, optional_items, origin_context, payment_intent_data, payment_method_collection, payment_method_configuration, payment_method_data, payment_method_options, payment_method_types, permissions, phone_number_collection, redirect_on_completion, return_url, saved_payment_method_options, setup_intent_data, shipping_address_collection, shipping_options, submit_type, subscription_data, success_url, tax_id_collection, ui_mode, wallet_options
- `GET /v1/climate/orders` (v1-climate-orders)
- `GET /v1/climate/orders/{order}` (v1-climate-orders-by-order)
- `POST /v1/climate/orders/{order}/cancel` (v1-climate-orders-by-order-cancel-post) — params: expand
- `POST /v1/climate/orders/{order}` (v1-climate-orders-by-order-post) — params: beneficiary, expand, metadata
- `POST /v1/climate/orders` (v1-climate-orders-post) — params: amount, beneficiary, currency, expand, metadata, metric_tons, product
- `GET /v1/climate/products` (v1-climate-products)
- `GET /v1/climate/products/{product}` (v1-climate-products-by-product)
- `GET /v1/climate/suppliers` (v1-climate-suppliers)
- `GET /v1/climate/suppliers/{supplier}` (v1-climate-suppliers-by-supplier)
- `GET /v1/confirmation_tokens/{confirmation_token}` (v1-confirmation-tokens-by-confirmation-token)
- `GET /v1/country_specs` (v1-country-specs)
- `GET /v1/country_specs/{country}` (v1-country-specs-by-country)
- `GET /v1/coupons` (v1-coupons)
- `GET /v1/coupons/{coupon}` (v1-coupons-by-coupon)
- `DELETE /v1/coupons/{coupon}` (v1-coupons-by-coupon-delete)
- `POST /v1/coupons/{coupon}` (v1-coupons-by-coupon-post) — params: currency_options, expand, metadata, name
- `POST /v1/coupons` (v1-coupons-post) — params: amount_off, applies_to, currency, currency_options, duration, duration_in_months, expand, id, max_redemptions, metadata, name, percent_off, redeem_by
- `GET /v1/credit_notes` (v1-credit-notes)
- `GET /v1/credit_notes/{credit_note}/lines` (v1-credit-notes-by-credit-note-lines)
- `GET /v1/credit_notes/{id}` (v1-credit-notes-by-id)
- `POST /v1/credit_notes/{id}` (v1-credit-notes-by-id-post) — params: expand, memo, metadata
- `POST /v1/credit_notes/{id}/void` (v1-credit-notes-by-id-void-post) — params: expand
- `POST /v1/credit_notes` (v1-credit-notes-post) — params: amount, credit_amount, effective_at, email_type, expand, invoice, lines, memo, metadata, out_of_band_amount, reason, refund_amount, refunds, shipping_cost
- `GET /v1/credit_notes/preview` (v1-credit-notes-preview)
- `GET /v1/credit_notes/preview/lines` (v1-credit-notes-preview-lines)
- `POST /v1/customer_sessions` (v1-customer-sessions-post) — params: components, customer, customer_account, expand
- `GET /v1/customers` (v1-customers)
- `GET /v1/customers/{customer}` (v1-customers-by-customer)
- `GET /v1/customers/{customer}/balance_transactions` (v1-customers-by-customer-balance-transactions)
- `GET /v1/customers/{customer}/balance_transactions/{transaction}` (v1-customers-by-customer-balance-transactions-by-transaction)
- `POST /v1/customers/{customer}/balance_transactions/{transaction}` (v1-customers-by-customer-balance-transactions-by-transaction-post) — params: description, expand, metadata
- `POST /v1/customers/{customer}/balance_transactions` (v1-customers-by-customer-balance-transactions-post) — params: amount, currency, description, expand, metadata
- `GET /v1/customers/{customer}/bank_accounts` (v1-customers-by-customer-bank-accounts)
- `GET /v1/customers/{customer}/bank_accounts/{id}` (v1-customers-by-customer-bank-accounts-by-id)
- `DELETE /v1/customers/{customer}/bank_accounts/{id}` (v1-customers-by-customer-bank-accounts-by-id-delete) — params: expand
- `POST /v1/customers/{customer}/bank_accounts/{id}` (v1-customers-by-customer-bank-accounts-by-id-post) — params: account_holder_name, account_holder_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, exp_month, exp_year, expand, metadata, name, owner
- `POST /v1/customers/{customer}/bank_accounts/{id}/verify` (v1-customers-by-customer-bank-accounts-by-id-verify-post) — params: amounts, expand
- `POST /v1/customers/{customer}/bank_accounts` (v1-customers-by-customer-bank-accounts-post) — params: alipay_account, bank_account, card, expand, metadata, source
- `GET /v1/customers/{customer}/cards` (v1-customers-by-customer-cards)
- `GET /v1/customers/{customer}/cards/{id}` (v1-customers-by-customer-cards-by-id)
- `DELETE /v1/customers/{customer}/cards/{id}` (v1-customers-by-customer-cards-by-id-delete) — params: expand
- `POST /v1/customers/{customer}/cards/{id}` (v1-customers-by-customer-cards-by-id-post) — params: account_holder_name, account_holder_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, exp_month, exp_year, expand, metadata, name, owner
- `POST /v1/customers/{customer}/cards` (v1-customers-by-customer-cards-post) — params: alipay_account, bank_account, card, expand, metadata, source
- `GET /v1/customers/{customer}/cash_balance` (v1-customers-by-customer-cash-balance)
- `POST /v1/customers/{customer}/cash_balance` (v1-customers-by-customer-cash-balance-post) — params: expand, settings
- `GET /v1/customers/{customer}/cash_balance_transactions` (v1-customers-by-customer-cash-balance-transactions)
- `GET /v1/customers/{customer}/cash_balance_transactions/{transaction}` (v1-customers-by-customer-cash-balance-transactions-by-transaction)
- `DELETE /v1/customers/{customer}` (v1-customers-by-customer-delete)
- `GET /v1/customers/{customer}/discount` (v1-customers-by-customer-discount)
- `DELETE /v1/customers/{customer}/discount` (v1-customers-by-customer-discount-delete)
- `POST /v1/customers/{customer}/funding_instructions` (v1-customers-by-customer-funding-instructions-post) — params: bank_transfer, currency, expand, funding_type
- `GET /v1/customers/{customer}/payment_methods` (v1-customers-by-customer-payment-methods)
- `GET /v1/customers/{customer}/payment_methods/{payment_method}` (v1-customers-by-customer-payment-methods-by-payment-method)
- `POST /v1/customers/{customer}` (v1-customers-by-customer-post) — params: address, balance, bank_account, business_name, card, cash_balance, default_alipay_account, default_bank_account, default_card, default_source, description, email, expand, individual_name, invoice_prefix, invoice_settings, metadata, name, next_invoice_sequence, phone, preferred_locales, shipping, source, tax, tax_exempt
- `GET /v1/customers/{customer}/sources` (v1-customers-by-customer-sources)
- `GET /v1/customers/{customer}/sources/{id}` (v1-customers-by-customer-sources-by-id)
- `DELETE /v1/customers/{customer}/sources/{id}` (v1-customers-by-customer-sources-by-id-delete) — params: expand
- `POST /v1/customers/{customer}/sources/{id}` (v1-customers-by-customer-sources-by-id-post) — params: account_holder_name, account_holder_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, exp_month, exp_year, expand, metadata, name, owner
- `POST /v1/customers/{customer}/sources/{id}/verify` (v1-customers-by-customer-sources-by-id-verify-post) — params: amounts, expand
- `POST /v1/customers/{customer}/sources` (v1-customers-by-customer-sources-post) — params: alipay_account, bank_account, card, expand, metadata, source
- `GET /v1/customers/{customer}/subscriptions` (v1-customers-by-customer-subscriptions)
- `GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}` (v1-customers-by-customer-subscriptions-by-subscription-exposed-id)
- `DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}` (v1-customers-by-customer-subscriptions-by-subscription-exposed-id-delete) — params: expand, invoice_now, prorate
- `GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount` (v1-customers-by-customer-subscriptions-by-subscription-exposed-id-discount)
- `DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount` (v1-customers-by-customer-subscriptions-by-subscription-exposed-id-discount-delete)
- `POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id}` (v1-customers-by-customer-subscriptions-by-subscription-exposed-id-post) — params: add_invoice_items, application_fee_percent, automatic_tax, billing_cycle_anchor, billing_thresholds, cancel_at, cancel_at_period_end, cancellation_details, collection_method, days_until_due, default_payment_method, default_source, default_tax_rates, discounts, expand, invoice_settings, items, metadata, off_session, pause_collection, payment_behavior, payment_settings, pending_invoice_item_interval, proration_behavior, proration_date, transfer_data, trial_end, trial_from_plan, trial_settings
- `POST /v1/customers/{customer}/subscriptions` (v1-customers-by-customer-subscriptions-post) — params: add_invoice_items, application_fee_percent, automatic_tax, backdate_start_date, billing_cycle_anchor, billing_thresholds, cancel_at, cancel_at_period_end, collection_method, currency, days_until_due, default_payment_method, default_source, default_tax_rates, discounts, expand, invoice_settings, items, metadata, off_session, payment_behavior, payment_settings, pending_invoice_item_interval, proration_behavior, transfer_data, trial_end, trial_from_plan, trial_period_days, trial_settings
- `GET /v1/customers/{customer}/tax_ids` (v1-customers-by-customer-tax-ids)
- `GET /v1/customers/{customer}/tax_ids/{id}` (v1-customers-by-customer-tax-ids-by-id)
- `DELETE /v1/customers/{customer}/tax_ids/{id}` (v1-customers-by-customer-tax-ids-by-id-delete)
- `POST /v1/customers/{customer}/tax_ids` (v1-customers-by-customer-tax-ids-post) — params: expand, type, value
- `POST /v1/customers` (v1-customers-post) — params: address, balance, business_name, cash_balance, description, email, expand, individual_name, invoice_prefix, invoice_settings, metadata, name, next_invoice_sequence, payment_method, phone, preferred_locales, shipping, source, tax, tax_exempt, tax_id_data, test_clock
- `GET /v1/customers/search` (v1-customers-search)
- `GET /v1/disputes` (v1-disputes)
- `GET /v1/disputes/{dispute}` (v1-disputes-by-dispute)
- `POST /v1/disputes/{dispute}/close` (v1-disputes-by-dispute-close-post) — params: expand
- `POST /v1/disputes/{dispute}` (v1-disputes-by-dispute-post) — params: evidence, expand, metadata, submit
- `GET /v1/entitlements/active_entitlements` (v1-entitlements-active-entitlements)
- `GET /v1/entitlements/active_entitlements/{id}` (v1-entitlements-active-entitlements-by-id)
- `GET /v1/entitlements/features` (v1-entitlements-features)
- `GET /v1/entitlements/features/{id}` (v1-entitlements-features-by-id)
- `POST /v1/entitlements/features/{id}` (v1-entitlements-features-by-id-post) — params: active, expand, metadata, name
- `POST /v1/entitlements/features` (v1-entitlements-features-post) — params: expand, lookup_key, metadata, name
- `DELETE /v1/ephemeral_keys/{key}` (v1-ephemeral-keys-by-key-delete) — params: expand
- `POST /v1/ephemeral_keys` (v1-ephemeral-keys-post) — params: customer, expand, issuing_card, nonce, verification_session
- `GET /v1/events` (v1-events)
- `GET /v1/events/{id}` (v1-events-by-id)
- `GET /v1/exchange_rates` (v1-exchange-rates)
- `GET /v1/exchange_rates/{rate_id}` (v1-exchange-rates-by-rate-id)
- `POST /v1/external_accounts/{id}` (v1-external-accounts-by-id-post) — params: account_holder_name, account_holder_type, account_type, address_city, address_country, address_line1, address_line2, address_state, address_zip, default_for_currency, documents, exp_month, exp_year, expand, metadata, name
- `GET /v1/file_links` (v1-file-links)
- `GET /v1/file_links/{link}` (v1-file-links-by-link)
- `POST /v1/file_links/{link}` (v1-file-links-by-link-post) — params: expand, expires_at, metadata
- `POST /v1/file_links` (v1-file-links-post) — params: expand, expires_at, file, metadata
- `GET /v1/files` (v1-files)
- `GET /v1/files/{file}` (v1-files-by-file)
- `POST /v1/files` (v1-files-post) — params: expand, file, file_link_data, purpose
- `GET /v1/financial_connections/accounts` (v1-financial-connections-accounts)
- `GET /v1/financial_connections/accounts/{account}` (v1-financial-connections-accounts-by-account)
- `POST /v1/financial_connections/accounts/{account}/disconnect` (v1-financial-connections-accounts-by-account-disconnect-post) — params: expand
- `GET /v1/financial_connections/accounts/{account}/owners` (v1-financial-connections-accounts-by-account-owners)
- `POST /v1/financial_connections/accounts/{account}/refresh` (v1-financial-connections-accounts-by-account-refresh-post) — params: expand, features
- `POST /v1/financial_connections/accounts/{account}/subscribe` (v1-financial-connections-accounts-by-account-subscribe-post) — params: expand, features
- `POST /v1/financial_connections/accounts/{account}/unsubscribe` (v1-financial-connections-accounts-by-account-unsubscribe-post) — params: expand, features
- `GET /v1/financial_connections/sessions/{session}` (v1-financial-connections-sessions-by-session)
- `POST /v1/financial_connections/sessions` (v1-financial-connections-sessions-post) — params: account_holder, expand, filters, permissions, prefetch, return_url
- `GET /v1/financial_connections/transactions` (v1-financial-connections-transactions)
- `GET /v1/financial_connections/transactions/{transaction}` (v1-financial-connections-transactions-by-transaction)
- `GET /v1/forwarding/requests` (v1-forwarding-requests)
- `GET /v1/forwarding/requests/{id}` (v1-forwarding-requests-by-id)
- `POST /v1/forwarding/requests` (v1-forwarding-requests-post) — params: expand, metadata, payment_method, replacements, request, url
- `GET /v1/identity/verification_reports` (v1-identity-verification-reports)
- `GET /v1/identity/verification_reports/{report}` (v1-identity-verification-reports-by-report)
- `GET /v1/identity/verification_sessions` (v1-identity-verification-sessions)
- `GET /v1/identity/verification_sessions/{session}` (v1-identity-verification-sessions-by-session)
- `POST /v1/identity/verification_sessions/{session}/cancel` (v1-identity-verification-sessions-by-session-cancel-post) — params: expand
- `POST /v1/identity/verification_sessions/{session}` (v1-identity-verification-sessions-by-session-post) — params: expand, metadata, options, provided_details, type
- `POST /v1/identity/verification_sessions/{session}/redact` (v1-identity-verification-sessions-by-session-redact-post) — params: expand
- `POST /v1/identity/verification_sessions` (v1-identity-verification-sessions-post) — params: client_reference_id, expand, metadata, options, provided_details, related_customer, related_customer_account, related_person, return_url, type, verification_flow
- `GET /v1/invoice_payments` (v1-invoice-payments)
- `GET /v1/invoice_payments/{invoice_payment}` (v1-invoice-payments-by-invoice-payment)
- `GET /v1/invoice_rendering_templates` (v1-invoice-rendering-templates)
- `GET /v1/invoice_rendering_templates/{template}` (v1-invoice-rendering-templates-by-template)
- `POST /v1/invoice_rendering_templates/{template}/archive` (v1-invoice-rendering-templates-by-template-archive-post) — params: expand
- `POST /v1/invoice_rendering_templates/{template}/unarchive` (v1-invoice-rendering-templates-by-template-unarchive-post) — params: expand
- `GET /v1/invoiceitems` (v1-invoiceitems)
- `GET /v1/invoiceitems/{invoiceitem}` (v1-invoiceitems-by-invoiceitem)
- `DELETE /v1/invoiceitems/{invoiceitem}` (v1-invoiceitems-by-invoiceitem-delete)
- `POST /v1/invoiceitems/{invoiceitem}` (v1-invoiceitems-by-invoiceitem-post) — params: amount, description, discountable, discounts, expand, metadata, period, price_data, pricing, quantity, quantity_decimal, tax_behavior, tax_code, tax_rates, unit_amount_decimal
- `POST /v1/invoiceitems` (v1-invoiceitems-post) — params: amount, currency, customer, customer_account, description, discountable, discounts, expand, invoice, metadata, period, price_data, pricing, quantity, quantity_decimal, subscription, tax_behavior, tax_code, tax_rates, unit_amount_decimal
- `GET /v1/invoices` (v1-invoices)
- `GET /v1/invoices/{invoice}` (v1-invoices-by-invoice)
- `POST /v1/invoices/{invoice}/add_lines` (v1-invoices-by-invoice-add-lines-post) — params: expand, invoice_metadata, lines
- `POST /v1/invoices/{invoice}/attach_payment` (v1-invoices-by-invoice-attach-payment-post) — params: expand, payment_intent, payment_record
- `DELETE /v1/invoices/{invoice}` (v1-invoices-by-invoice-delete)
- `POST /v1/invoices/{invoice}/finalize` (v1-invoices-by-invoice-finalize-post) — params: auto_advance, expand
- `GET /v1/invoices/{invoice}/lines` (v1-invoices-by-invoice-lines)
- `POST /v1/invoices/{invoice}/lines/{line_item_id}` (v1-invoices-by-invoice-lines-by-line-item-id-post) — params: amount, description, discountable, discounts, expand, metadata, period, price_data, pricing, quantity, quantity_decimal, tax_amounts, tax_rates
- `POST /v1/invoices/{invoice}/mark_uncollectible` (v1-invoices-by-invoice-mark-uncollectible-post) — params: expand
- `POST /v1/invoices/{invoice}/pay` (v1-invoices-by-invoice-pay-post) — params: expand, forgive, mandate, off_session, paid_out_of_band, payment_method, source
- `POST /v1/invoices/{invoice}` (v1-invoices-by-invoice-post) — params: account_tax_ids, application_fee_amount, auto_advance, automatic_tax, automatically_finalizes_at, collection_method, custom_fields, days_until_due, default_payment_method, default_source, default_tax_rates, description, discounts, due_date, effective_at, expand, footer, issuer, metadata, number, on_behalf_of, payment_settings, rendering, shipping_cost, shipping_details, statement_descriptor, transfer_data
- `POST /v1/invoices/{invoice}/remove_lines` (v1-invoices-by-invoice-remove-lines-post) — params: expand, invoice_metadata, lines
- `POST /v1/invoices/{invoice}/send` (v1-invoices-by-invoice-send-post) — params: expand
- `POST /v1/invoices/{invoice}/update_lines` (v1-invoices-by-invoice-update-lines-post) — params: expand, invoice_metadata, lines
- `POST /v1/invoices/{invoice}/void` (v1-invoices-by-invoice-void-post) — params: expand
- `POST /v1/invoices/create_preview` (v1-invoices-create-preview-post) — params: automatic_tax, currency, customer, customer_account, customer_details, discounts, expand, invoice_items, issuer, on_behalf_of, preview_mode, schedule, schedule_details, subscription, subscription_details
- `POST /v1/invoices` (v1-invoices-post) — params: account_tax_ids, application_fee_amount, auto_advance, automatic_tax, automatically_finalizes_at, collection_method, currency, custom_fields, customer, customer_account, days_until_due, default_payment_method, default_source, default_tax_rates, description, discounts, due_date, effective_at, expand, footer, from_invoice, issuer, metadata, number, on_behalf_of, payment_settings, pending_invoice_items_behavior, rendering, shipping_cost, shipping_details, statement_descriptor, subscription, transfer_data
- `GET /v1/invoices/search` (v1-invoices-search)
- `GET /v1/issuing/authorizations` (v1-issuing-authorizations)
- `GET /v1/issuing/authorizations/{authorization}` (v1-issuing-authorizations-by-authorization)
- `POST /v1/issuing/authorizations/{authorization}/approve` (v1-issuing-authorizations-by-authorization-approve-post) — params: amount, expand, metadata
- `POST /v1/issuing/authorizations/{authorization}/decline` (v1-issuing-authorizations-by-authorization-decline-post) — params: expand, metadata
- `POST /v1/issuing/authorizations/{authorization}` (v1-issuing-authorizations-by-authorization-post) — params: expand, metadata
- `GET /v1/issuing/cardholders` (v1-issuing-cardholders)
- `GET /v1/issuing/cardholders/{cardholder}` (v1-issuing-cardholders-by-cardholder)
- `POST /v1/issuing/cardholders/{cardholder}` (v1-issuing-cardholders-by-cardholder-post) — params: billing, company, email, expand, individual, metadata, phone_number, preferred_locales, spending_controls, status
- `POST /v1/issuing/cardholders` (v1-issuing-cardholders-post) — params: billing, company, email, expand, individual, metadata, name, phone_number, preferred_locales, spending_controls, status, type
- `GET /v1/issuing/cards` (v1-issuing-cards)
- `GET /v1/issuing/cards/{card}` (v1-issuing-cards-by-card)
- `POST /v1/issuing/cards/{card}` (v1-issuing-cards-by-card-post) — params: cancellation_reason, expand, metadata, personalization_design, pin, shipping, spending_controls, status
- `POST /v1/issuing/cards` (v1-issuing-cards-post) — params: cardholder, currency, exp_month, exp_year, expand, financial_account, lifecycle_controls, metadata, personalization_design, pin, replacement_for, replacement_reason, second_line, shipping, spending_controls, status, type
- `GET /v1/issuing/disputes` (v1-issuing-disputes)
- `GET /v1/issuing/disputes/{dispute}` (v1-issuing-disputes-by-dispute)
- `POST /v1/issuing/disputes/{dispute}` (v1-issuing-disputes-by-dispute-post) — params: amount, evidence, expand, metadata
- `POST /v1/issuing/disputes/{dispute}/submit` (v1-issuing-disputes-by-dispute-submit-post) — params: expand, metadata
- `POST /v1/issuing/disputes` (v1-issuing-disputes-post) — params: amount, evidence, expand, metadata, transaction, treasury
- `GET /v1/issuing/personalization_designs` (v1-issuing-personalization-designs)
- `GET /v1/issuing/personalization_designs/{personalization_design}` (v1-issuing-personalization-designs-by-personalization-design)
- `POST /v1/issuing/personalization_designs/{personalization_design}` (v1-issuing-personalization-designs-by-personalization-design-post) — params: card_logo, carrier_text, expand, lookup_key, metadata, name, physical_bundle, preferences, transfer_lookup_key
- `POST /v1/issuing/personalization_designs` (v1-issuing-personalization-designs-post) — params: card_logo, carrier_text, expand, lookup_key, metadata, name, physical_bundle, preferences, transfer_lookup_key
- `GET /v1/issuing/physical_bundles` (v1-issuing-physical-bundles)
- `GET /v1/issuing/physical_bundles/{physical_bundle}` (v1-issuing-physical-bundles-by-physical-bundle)
- `GET /v1/issuing/settlements/{settlement}` (v1-issuing-settlements-by-settlement)
- `POST /v1/issuing/settlements/{settlement}` (v1-issuing-settlements-by-settlement-post) — params: expand, metadata
- `GET /v1/issuing/tokens` (v1-issuing-tokens)
- `GET /v1/issuing/tokens/{token}` (v1-issuing-tokens-by-token)
- `POST /v1/issuing/tokens/{token}` (v1-issuing-tokens-by-token-post) — params: expand, status
- `GET /v1/issuing/transactions` (v1-issuing-transactions)
- `GET /v1/issuing/transactions/{transaction}` (v1-issuing-transactions-by-transaction)
- `POST /v1/issuing/transactions/{transaction}` (v1-issuing-transactions-by-transaction-post) — params: expand, metadata
- `GET /v1/link_account_sessions/{session}` (v1-link-account-sessions-by-session)
- `POST /v1/link_account_sessions` (v1-link-account-sessions-post) — params: account_holder, expand, filters, permissions, prefetch, return_url
- `GET /v1/linked_accounts` (v1-linked-accounts)
- `GET /v1/linked_accounts/{account}` (v1-linked-accounts-by-account)
- `POST /v1/linked_accounts/{account}/disconnect` (v1-linked-accounts-by-account-disconnect-post) — params: expand
- `GET /v1/linked_accounts/{account}/owners` (v1-linked-accounts-by-account-owners)
- `POST /v1/linked_accounts/{account}/refresh` (v1-linked-accounts-by-account-refresh-post) — params: expand, features
- `GET /v1/mandates/{mandate}` (v1-mandates-by-mandate)
- `GET /v1/payment_attempt_records` (v1-payment-attempt-records)
- `GET /v1/payment_attempt_records/{id}` (v1-payment-attempt-records-by-id)
- `GET /v1/payment_intents` (v1-payment-intents)
- `GET /v1/payment_intents/{intent}` (v1-payment-intents-by-intent)
- `GET /v1/payment_intents/{intent}/amount_details_line_items` (v1-payment-intents-by-intent-amount-details-line-items)
- `POST /v1/payment_intents/{intent}/apply_customer_balance` (v1-payment-intents-by-intent-apply-customer-balance-post) — params: amount, currency, expand
- `POST /v1/payment_intents/{intent}/cancel` (v1-payment-intents-by-intent-cancel-post) — params: cancellation_reason, expand
- `POST /v1/payment_intents/{intent}/capture` (v1-payment-intents-by-intent-capture-post) — params: amount_details, amount_to_capture, application_fee_amount, expand, final_capture, hooks, metadata, payment_details, statement_descriptor, statement_descriptor_suffix, transfer_data
- `POST /v1/payment_intents/{intent}/confirm` (v1-payment-intents-by-intent-confirm-post) — params: amount_details, amount_to_confirm, capture_method, client_secret, confirmation_token, error_on_requires_action, excluded_payment_method_types, expand, hooks, mandate, mandate_data, off_session, payment_details, payment_method, payment_method_data, payment_method_options, payment_method_types, radar_options, receipt_email, return_url, setup_future_usage, shipping, use_stripe_sdk
- `POST /v1/payment_intents/{intent}/increment_authorization` (v1-payment-intents-by-intent-increment-authorization-post) — params: amount, amount_details, application_fee_amount, description, expand, hooks, metadata, payment_details, statement_descriptor, transfer_data
- `POST /v1/payment_intents/{intent}` (v1-payment-intents-by-intent-post) — params: amount, amount_details, application_fee_amount, capture_method, currency, customer, customer_account, description, excluded_payment_method_types, expand, hooks, metadata, payment_details, payment_method, payment_method_configuration, payment_method_data, payment_method_options, payment_method_types, receipt_email, setup_future_usage, shipping, statement_descriptor, statement_descriptor_suffix, transfer_data, transfer_group
- `POST /v1/payment_intents/{intent}/verify_microdeposits` (v1-payment-intents-by-intent-verify-microdeposits-post) — params: amounts, client_secret, descriptor_code, expand
- `POST /v1/payment_intents` (v1-payment-intents-post) — params: amount, amount_details, application_fee_amount, automatic_payment_methods, capture_method, confirm, confirmation_method, confirmation_token, currency, customer, customer_account, description, error_on_requires_action, excluded_payment_method_types, expand, hooks, mandate, mandate_data, metadata, off_session, on_behalf_of, payment_details, payment_method, payment_method_configuration, payment_method_data, payment_method_options, payment_method_types, radar_options, receipt_email, return_url, setup_future_usage, shipping, statement_descriptor, statement_descriptor_suffix, transfer_data, transfer_group, use_stripe_sdk
- `GET /v1/payment_intents/search` (v1-payment-intents-search)
- `GET /v1/payment_links` (v1-payment-links)
- `GET /v1/payment_links/{payment_link}` (v1-payment-links-by-payment-link)
- `GET /v1/payment_links/{payment_link}/line_items` (v1-payment-links-by-payment-link-line-items)
- `POST /v1/payment_links/{payment_link}` (v1-payment-links-by-payment-link-post) — params: active, after_completion, allow_promotion_codes, automatic_tax, billing_address_collection, custom_fields, custom_text, customer_creation, expand, inactive_message, invoice_creation, line_items, metadata, name_collection, optional_items, payment_intent_data, payment_method_collection, payment_method_options, payment_method_types, phone_number_collection, restrictions, shipping_address_collection, submit_type, subscription_data, tax_id_collection
- `POST /v1/payment_links` (v1-payment-links-post) — params: after_completion, allow_promotion_codes, application_fee_amount, application_fee_percent, automatic_tax, billing_address_collection, consent_collection, currency, custom_fields, custom_text, customer_creation, expand, inactive_message, invoice_creation, line_items, managed_payments, metadata, name_collection, on_behalf_of, optional_items, payment_intent_data, payment_method_collection, payment_method_options, payment_method_types, phone_number_collection, restrictions, shipping_address_collection, shipping_options, submit_type, subscription_data, tax_id_collection, transfer_data
- `GET /v1/payment_method_configurations` (v1-payment-method-configurations)
- `GET /v1/payment_method_configurations/{configuration}` (v1-payment-method-configurations-by-configuration)
- `POST /v1/payment_method_configurations/{configuration}` (v1-payment-method-configurations-by-configuration-post) — params: acss_debit, active, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple_pay, apple_pay_later, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cartes_bancaires, cashapp, crypto, customer_balance, eps, expand, fpx, fr_meal_voucher_conecs, giropay, google_pay, grabpay, ideal, jcb, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, name, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
- `POST /v1/payment_method_configurations` (v1-payment-method-configurations-post) — params: acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple_pay, apple_pay_later, au_becs_debit, bacs_debit, bancontact, billie, bizum, blik, boleto, card, cartes_bancaires, cashapp, crypto, customer_balance, eps, expand, fpx, fr_meal_voucher_conecs, giropay, google_pay, grabpay, ideal, jcb, kakao_pay, klarna, konbini, kr_card, link, mb_way, mobilepay, multibanco, name, naver_pay, nz_bank_account, oxxo, p24, parent, pay_by_bank, payco, paynow, paypal, payto, pix, promptpay, revolut_pay, samsung_pay, satispay, scalapay, sepa_debit, sofort, sunbit, swish, twint, upi, us_bank_account, wechat_pay, zip
- `GET /v1/payment_method_domains` (v1-payment-method-domains)
- `GET /v1/payment_method_domains/{payment_method_domain}` (v1-payment-method-domains-by-payment-method-domain)
- `POST /v1/payment_method_domains/{payment_method_domain}` (v1-payment-method-domains-by-payment-method-domain-post) — params: enabled, expand
- `POST /v1/payment_method_domains/{payment_method_domain}/validate` (v1-payment-method-domains-by-payment-method-domain-validate-post) — params: expand
- `POST /v1/payment_method_domains` (v1-payment-method-domains-post) — params: domain_name, enabled, expand
- `GET /v1/payment_methods` (v1-payment-methods)
- `GET /v1/payment_methods/{payment_method}` (v1-payment-methods-by-payment-method)
- `POST /v1/payment_methods/{payment_method}/attach` (v1-payment-methods-by-payment-method-attach-post) — params: customer, customer_account, expand
- `POST /v1/payment_methods/{payment_method}/detach` (v1-payment-methods-by-payment-method-detach-post) — params: expand
- `POST /v1/payment_methods/{payment_method}` (v1-payment-methods-by-payment-method-post) — params: allow_redisplay, billing_details, card, expand, metadata, payto, us_bank_account
- `GET /v1/payment_records/{id}` (v1-payment-records-by-id)
- `POST /v1/payment_records/{id}/report_payment_attempt_canceled` (v1-payment-records-by-id-report-payment-attempt-canceled-post) — params: canceled_at, expand, metadata
- `POST /v1/payment_records/{id}/report_payment_attempt_failed` (v1-payment-records-by-id-report-payment-attempt-failed-post) — params: expand, failed_at, metadata
- `POST /v1/payment_records/{id}/report_payment_attempt_guaranteed` (v1-payment-records-by-id-report-payment-attempt-guaranteed-post) — params: expand, guaranteed_at, metadata
- `POST /v1/payment_records/{id}/report_payment_attempt_informational` (v1-payment-records-by-id-report-payment-attempt-informational-post) — params: customer_details, description, expand, metadata, shipping_details
- `POST /v1/payment_records/{id}/report_payment_attempt` (v1-payment-records-by-id-report-payment-attempt-post) — params: description, expand, failed, guaranteed, initiated_at, metadata, outcome, payment_method_details, shipping_details
- `POST /v1/payment_records/{id}/report_refund` (v1-payment-records-by-id-report-refund-post) — params: amount, expand, initiated_at, metadata, outcome, processor_details, refunded
- `POST /v1/payment_records/report_payment` (v1-payment-records-report-payment-post) — params: amount_requested, customer_details, customer_presence, description, expand, failed, guaranteed, initiated_at, metadata, outcome, payment_method_details, processor_details, shipping_details
- `GET /v1/payouts` (v1-payouts)
- `GET /v1/payouts/{payout}` (v1-payouts-by-payout)
- `POST /v1/payouts/{payout}/cancel` (v1-payouts-by-payout-cancel-post) — params: expand
- `POST /v1/payouts/{payout}` (v1-payouts-by-payout-post) — params: expand, metadata
- `POST /v1/payouts/{payout}/reverse` (v1-payouts-by-payout-reverse-post) — params: expand, metadata
- `POST /v1/payouts` (v1-payouts-post) — params: amount, currency, description, destination, expand, metadata, method, payout_method, source_type, statement_descriptor
- `GET /v1/plans` (v1-plans)
- `GET /v1/plans/{plan}` (v1-plans-by-plan)
- `DELETE /v1/plans/{plan}` (v1-plans-by-plan-delete)
- `POST /v1/plans/{plan}` (v1-plans-by-plan-post) — params: active, expand, metadata, nickname, product, trial_period_days
- `POST /v1/plans` (v1-plans-post) — params: active, amount, amount_decimal, billing_scheme, currency, expand, id, interval, interval_count, metadata, meter, nickname, product, tiers, tiers_mode, transform_usage, trial_period_days, usage_type
- `GET /v1/prices` (v1-prices)
- `GET /v1/prices/{price}` (v1-prices-by-price)
- `POST /v1/prices/{price}` (v1-prices-by-price-post) — params: active, currency_options, expand, lookup_key, metadata, nickname, tax_behavior, transfer_lookup_key
- `POST /v1/prices` (v1-prices-post) — params: active, billing_scheme, currency, currency_options, custom_unit_amount, expand, lookup_key, metadata, nickname, product, product_data, recurring, tax_behavior, tiers, tiers_mode, transfer_lookup_key, transform_quantity, unit_amount, unit_amount_decimal
- `GET /v1/prices/search` (v1-prices-search)
- `GET /v1/products` (v1-products)
- `GET /v1/products/{id}` (v1-products-by-id)
- `DELETE /v1/products/{id}` (v1-products-by-id-delete)
- `POST /v1/products/{id}` (v1-products-by-id-post) — params: active, default_price, description, expand, images, marketing_features, metadata, name, package_dimensions, shippable, statement_descriptor, tax_code, unit_label, url
- `GET /v1/products/{product}/features` (v1-products-by-product-features)
- `GET /v1/products/{product}/features/{id}` (v1-products-by-product-features-by-id)
- `DELETE /v1/products/{product}/features/{id}` (v1-products-by-product-features-by-id-delete)
- `POST /v1/products/{product}/features` (v1-products-by-product-features-post) — params: entitlement_feature, expand
- `POST /v1/products` (v1-products-post) — params: active, default_price_data, description, expand, id, images, marketing_features, metadata, name, package_dimensions, shippable, statement_descriptor, tax_code, unit_label, url
- `GET /v1/products/search` (v1-products-search)
- `GET /v1/promotion_codes` (v1-promotion-codes)
- `GET /v1/promotion_codes/{promotion_code}` (v1-promotion-codes-by-promotion-code)
- `POST /v1/promotion_codes/{promotion_code}` (v1-promotion-codes-by-promotion-code-post) — params: active, expand, metadata, restrictions
- `POST /v1/promotion_codes` (v1-promotion-codes-post) — params: active, code, customer, customer_account, expand, expires_at, max_redemptions, metadata, promotion, restrictions
- `GET /v1/quotes` (v1-quotes)
- `GET /v1/quotes/{quote}` (v1-quotes-by-quote)
- `POST /v1/quotes/{quote}/accept` (v1-quotes-by-quote-accept-post) — params: expand
- `POST /v1/quotes/{quote}/cancel` (v1-quotes-by-quote-cancel-post) — params: expand
- `GET /v1/quotes/{quote}/computed_upfront_line_items` (v1-quotes-by-quote-computed-upfront-line-items)
- `POST /v1/quotes/{quote}/finalize` (v1-quotes-by-quote-finalize-post) — params: expand, expires_at
- `GET /v1/quotes/{quote}/line_items` (v1-quotes-by-quote-line-items)
- `GET /v1/quotes/{quote}/pdf` (v1-quotes-by-quote-pdf)
- `POST /v1/quotes/{quote}` (v1-quotes-by-quote-post) — params: application_fee_amount, application_fee_percent, automatic_tax, collection_method, customer, customer_account, default_tax_rates, description, discounts, expand, expires_at, footer, header, invoice_settings, line_items, metadata, on_behalf_of, subscription_data, transfer_data
- `POST /v1/quotes` (v1-quotes-post) — params: application_fee_amount, application_fee_percent, automatic_tax, collection_method, customer, customer_account, default_tax_rates, description, discounts, expand, expires_at, footer, from_quote, header, invoice_settings, line_items, metadata, on_behalf_of, subscription_data, test_clock, transfer_data
- `GET /v1/radar/early_fraud_warnings` (v1-radar-early-fraud-warnings)
- `GET /v1/radar/early_fraud_warnings/{early_fraud_warning}` (v1-radar-early-fraud-warnings-by-early-fraud-warning)
- `POST /v1/radar/payment_evaluations` (v1-radar-payment-evaluations-post) — params: client_device_metadata_details, customer_details, expand, metadata, payment_details
- `GET /v1/radar/value_list_items` (v1-radar-value-list-items)
- `GET /v1/radar/value_list_items/{item}` (v1-radar-value-list-items-by-item)
- `DELETE /v1/radar/value_list_items/{item}` (v1-radar-value-list-items-by-item-delete)
- `POST /v1/radar/value_list_items` (v1-radar-value-list-items-post) — params: expand, value, value_list
- `GET /v1/radar/value_lists` (v1-radar-value-lists)
- `GET /v1/radar/value_lists/{value_list}` (v1-radar-value-lists-by-value-list)
- `DELETE /v1/radar/value_lists/{value_list}` (v1-radar-value-lists-by-value-list-delete)
- `POST /v1/radar/value_lists/{value_list}` (v1-radar-value-lists-by-value-list-post) — params: alias, expand, metadata, name
- `POST /v1/radar/value_lists` (v1-radar-value-lists-post) — params: alias, expand, item_type, metadata, name
- `GET /v1/refunds` (v1-refunds)
- `GET /v1/refunds/{refund}` (v1-refunds-by-refund)
- `POST /v1/refunds/{refund}/cancel` (v1-refunds-by-refund-cancel-post) — params: expand
- `POST /v1/refunds/{refund}` (v1-refunds-by-refund-post) — params: expand, metadata
- `POST /v1/refunds` (v1-refunds-post) — params: amount, charge, currency, customer, expand, instructions_email, metadata, origin, payment_intent, reason, refund_application_fee, reverse_transfer
- `GET /v1/reporting/report_runs` (v1-reporting-report-runs)
- `GET /v1/reporting/report_runs/{report_run}` (v1-reporting-report-runs-by-report-run)
- `POST /v1/reporting/report_runs` (v1-reporting-report-runs-post) — params: expand, parameters, report_type
- `GET /v1/reporting/report_types` (v1-reporting-report-types)
- `GET /v1/reporting/report_types/{report_type}` (v1-reporting-report-types-by-report-type)
- `GET /v1/reviews` (v1-reviews)
- `GET /v1/reviews/{review}` (v1-reviews-by-review)
- `POST /v1/reviews/{review}/approve` (v1-reviews-by-review-approve-post) — params: expand
- `GET /v1/setup_attempts` (v1-setup-attempts)
- `GET /v1/setup_intents` (v1-setup-intents)
- `GET /v1/setup_intents/{intent}` (v1-setup-intents-by-intent)
- `POST /v1/setup_intents/{intent}/cancel` (v1-setup-intents-by-intent-cancel-post) — params: cancellation_reason, expand
- `POST /v1/setup_intents/{intent}/confirm` (v1-setup-intents-by-intent-confirm-post) — params: client_secret, confirmation_token, expand, mandate_data, payment_method, payment_method_data, payment_method_options, return_url, use_stripe_sdk
- `POST /v1/setup_intents/{intent}` (v1-setup-intents-by-intent-post) — params: attach_to_self, customer, customer_account, description, excluded_payment_method_types, expand, flow_directions, metadata, payment_method, payment_method_configuration, payment_method_data, payment_method_options, payment_method_types
- `POST /v1/setup_intents/{intent}/verify_microdeposits` (v1-setup-intents-by-intent-verify-microdeposits-post) — params: amounts, client_secret, descriptor_code, expand
- `POST /v1/setup_intents` (v1-setup-intents-post) — params: attach_to_self, automatic_payment_methods, confirm, confirmation_token, customer, customer_account, description, excluded_payment_method_types, expand, flow_directions, mandate_data, metadata, on_behalf_of, payment_method, payment_method_configuration, payment_method_data, payment_method_options, payment_method_types, return_url, single_use, usage, use_stripe_sdk
- `GET /v1/shipping_rates` (v1-shipping-rates)
- `GET /v1/shipping_rates/{shipping_rate_token}` (v1-shipping-rates-by-shipping-rate-token)
- `POST /v1/shipping_rates/{shipping_rate_token}` (v1-shipping-rates-by-shipping-rate-token-post) — params: active, expand, fixed_amount, metadata, tax_behavior
- `POST /v1/shipping_rates` (v1-shipping-rates-post) — params: delivery_estimate, display_name, expand, fixed_amount, metadata, tax_behavior, tax_code, type
- `POST /v1/sigma/saved_queries/{id}` (v1-sigma-saved-queries-by-id-post) — params: expand, name, sql
- `GET /v1/sigma/scheduled_query_runs` (v1-sigma-scheduled-query-runs)
- `GET /v1/sigma/scheduled_query_runs/{scheduled_query_run}` (v1-sigma-scheduled-query-runs-by-scheduled-query-run)
- `GET /v1/sources/{source}` (v1-sources-by-source)
- `GET /v1/sources/{source}/mandate_notifications/{mandate_notification}` (v1-sources-by-source-mandate-notifications-by-mandate-notification)
- `POST /v1/sources/{source}` (v1-sources-by-source-post) — params: amount, expand, mandate, metadata, owner, source_order
- `GET /v1/sources/{source}/source_transactions` (v1-sources-by-source-source-transactions)
- `GET /v1/sources/{source}/source_transactions/{source_transaction}` (v1-sources-by-source-source-transactions-by-source-transaction)
- `POST /v1/sources/{source}/verify` (v1-sources-by-source-verify-post) — params: expand, values
- `POST /v1/sources` (v1-sources-post) — params: amount, currency, customer, expand, flow, mandate, metadata, original_source, owner, receiver, redirect, source_order, statement_descriptor, token, type, usage
- `GET /v1/subscription_items` (v1-subscription-items)
- `GET /v1/subscription_items/{item}` (v1-subscription-items-by-item)
- `DELETE /v1/subscription_items/{item}` (v1-subscription-items-by-item-delete) — params: clear_usage, payment_behavior, proration_behavior, proration_date
- `POST /v1/subscription_items/{item}` (v1-subscription-items-by-item-post) — params: billing_thresholds, discounts, expand, metadata, off_session, payment_behavior, price, price_data, proration_behavior, proration_date, quantity, tax_rates
- `POST /v1/subscription_items` (v1-subscription-items-post) — params: billing_thresholds, discounts, expand, metadata, payment_behavior, price, price_data, proration_behavior, proration_date, quantity, subscription, tax_rates
- `GET /v1/subscription_schedules` (v1-subscription-schedules)
- `GET /v1/subscription_schedules/{schedule}` (v1-subscription-schedules-by-schedule)
- `POST /v1/subscription_schedules/{schedule}/cancel` (v1-subscription-schedules-by-schedule-cancel-post) — params: expand, invoice_now, prorate
- `POST /v1/subscription_schedules/{schedule}` (v1-subscription-schedules-by-schedule-post) — params: default_settings, end_behavior, expand, metadata, phases, proration_behavior
- `POST /v1/subscription_schedules/{schedule}/release` (v1-subscription-schedules-by-schedule-release-post) — params: expand, preserve_cancel_date
- `POST /v1/subscription_schedules` (v1-subscription-schedules-post) — params: billing_mode, customer, customer_account, default_settings, end_behavior, expand, from_subscription, metadata, phases, start_date
- `GET /v1/subscriptions` (v1-subscriptions)
- `GET /v1/subscriptions/{subscription_exposed_id}` (v1-subscriptions-by-subscription-exposed-id)
- `DELETE /v1/subscriptions/{subscription_exposed_id}` (v1-subscriptions-by-subscription-exposed-id-delete) — params: cancellation_details, expand, invoice_now, prorate
- `DELETE /v1/subscriptions/{subscription_exposed_id}/discount` (v1-subscriptions-by-subscription-exposed-id-discount-delete)
- `POST /v1/subscriptions/{subscription_exposed_id}` (v1-subscriptions-by-subscription-exposed-id-post) — params: add_invoice_items, application_fee_percent, automatic_tax, billing_cycle_anchor, billing_schedules, billing_thresholds, cancel_at, cancel_at_period_end, cancellation_details, collection_method, days_until_due, default_payment_method, default_source, default_tax_rates, description, discounts, expand, invoice_settings, items, metadata, off_session, on_behalf_of, pause_collection, payment_behavior, payment_settings, pending_invoice_item_interval, proration_behavior, proration_date, transfer_data, trial_end, trial_from_plan, trial_settings
- `POST /v1/subscriptions/{subscription}/migrate` (v1-subscriptions-by-subscription-migrate-post) — params: billing_mode, expand
- `POST /v1/subscriptions/{subscription}/resume` (v1-subscriptions-by-subscription-resume-post) — params: billing_cycle_anchor, expand, proration_behavior, proration_date
- `POST /v1/subscriptions` (v1-subscriptions-post) — params: add_invoice_items, application_fee_percent, automatic_tax, backdate_start_date, billing_cycle_anchor, billing_cycle_anchor_config, billing_mode, billing_schedules, billing_thresholds, cancel_at, cancel_at_period_end, collection_method, currency, customer, customer_account, days_until_due, default_payment_method, default_source, default_tax_rates, description, discounts, expand, invoice_settings, items, metadata, off_session, on_behalf_of, payment_behavior, payment_settings, pending_invoice_item_interval, proration_behavior, transfer_data, trial_end, trial_from_plan, trial_period_days, trial_settings
- `GET /v1/subscriptions/search` (v1-subscriptions-search)
- `GET /v1/tax/associations/find` (v1-tax-associations-find)
- `GET /v1/tax/calculations/{calculation}` (v1-tax-calculations-by-calculation)
- `GET /v1/tax/calculations/{calculation}/line_items` (v1-tax-calculations-by-calculation-line-items)
- `POST /v1/tax/calculations` (v1-tax-calculations-post) — params: currency, customer, customer_details, expand, line_items, ship_from_details, shipping_cost, tax_date
- `GET /v1/tax_codes` (v1-tax-codes)
- `GET /v1/tax_codes/{id}` (v1-tax-codes-by-id)
- `GET /v1/tax_ids` (v1-tax-ids)
- `GET /v1/tax_ids/{id}` (v1-tax-ids-by-id)
- `DELETE /v1/tax_ids/{id}` (v1-tax-ids-by-id-delete)
- `POST /v1/tax_ids` (v1-tax-ids-post) — params: expand, owner, type, value
- `GET /v1/tax_rates` (v1-tax-rates)
- `GET /v1/tax_rates/{tax_rate}` (v1-tax-rates-by-tax-rate)
- `POST /v1/tax_rates/{tax_rate}` (v1-tax-rates-by-tax-rate-post) — params: active, country, description, display_name, expand, jurisdiction, metadata, state, tax_type
- `POST /v1/tax_rates` (v1-tax-rates-post) — params: active, country, description, display_name, expand, inclusive, jurisdiction, metadata, percentage, state, tax_type
- `GET /v1/tax/registrations` (v1-tax-registrations)
- `GET /v1/tax/registrations/{id}` (v1-tax-registrations-by-id)
- `POST /v1/tax/registrations/{id}` (v1-tax-registrations-by-id-post) — params: active_from, expand, expires_at
- `POST /v1/tax/registrations` (v1-tax-registrations-post) — params: active_from, country, country_options, expand, expires_at
- `GET /v1/tax/settings` (v1-tax-settings)
- `POST /v1/tax/settings` (v1-tax-settings-post) — params: defaults, expand, head_office
- `GET /v1/tax/transactions/{transaction}` (v1-tax-transactions-by-transaction)
- `GET /v1/tax/transactions/{transaction}/line_items` (v1-tax-transactions-by-transaction-line-items)
- `POST /v1/tax/transactions/create_from_calculation` (v1-tax-transactions-create-from-calculation-post) — params: calculation, expand, metadata, posted_at, reference
- `POST /v1/tax/transactions/create_reversal` (v1-tax-transactions-create-reversal-post) — params: expand, flat_amount, line_items, metadata, mode, original_transaction, reference, shipping_cost
- `GET /v1/terminal/configurations` (v1-terminal-configurations)
- `GET /v1/terminal/configurations/{configuration}` (v1-terminal-configurations-by-configuration)
- `DELETE /v1/terminal/configurations/{configuration}` (v1-terminal-configurations-by-configuration-delete)
- `POST /v1/terminal/configurations/{configuration}` (v1-terminal-configurations-by-configuration-post) — params: bbpos_wisepad3, bbpos_wisepos_e, cellular, expand, name, offline, reboot_window, stripe_s700, stripe_s710, tipping, verifone_m425, verifone_p400, verifone_p630, verifone_ux700, verifone_v660p, wifi
- `POST /v1/terminal/configurations` (v1-terminal-configurations-post) — params: bbpos_wisepad3, bbpos_wisepos_e, cellular, expand, name, offline, reboot_window, stripe_s700, stripe_s710, tipping, verifone_m425, verifone_p400, verifone_p630, verifone_ux700, verifone_v660p, wifi
- `POST /v1/terminal/connection_tokens` (v1-terminal-connection-tokens-post) — params: expand, location
- `GET /v1/terminal/locations` (v1-terminal-locations)
- `GET /v1/terminal/locations/{location}` (v1-terminal-locations-by-location)
- `DELETE /v1/terminal/locations/{location}` (v1-terminal-locations-by-location-delete)
- `POST /v1/terminal/locations/{location}` (v1-terminal-locations-by-location-post) — params: address, address_kana, address_kanji, configuration_overrides, display_name, display_name_kana, display_name_kanji, expand, metadata, phone
- `POST /v1/terminal/locations` (v1-terminal-locations-post) — params: address, address_kana, address_kanji, configuration_overrides, display_name, display_name_kana, display_name_kanji, expand, metadata, phone
- `POST /v1/terminal/onboarding_links` (v1-terminal-onboarding-links-post) — params: expand, link_options, link_type, on_behalf_of
- `GET /v1/terminal/readers` (v1-terminal-readers)
- `GET /v1/terminal/readers/{reader}` (v1-terminal-readers-by-reader)
- `POST /v1/terminal/readers/{reader}/cancel_action` (v1-terminal-readers-by-reader-cancel-action-post) — params: expand
- `POST /v1/terminal/readers/{reader}/collect_inputs` (v1-terminal-readers-by-reader-collect-inputs-post) — params: expand, inputs, metadata
- `POST /v1/terminal/readers/{reader}/collect_payment_method` (v1-terminal-readers-by-reader-collect-payment-method-post) — params: collect_config, expand, payment_intent
- `POST /v1/terminal/readers/{reader}/confirm_payment_intent` (v1-terminal-readers-by-reader-confirm-payment-intent-post) — params: confirm_config, expand, payment_intent
- `DELETE /v1/terminal/readers/{reader}` (v1-terminal-readers-by-reader-delete)
- `POST /v1/terminal/readers/{reader}` (v1-terminal-readers-by-reader-post) — params: expand, label, metadata
- `POST /v1/terminal/readers/{reader}/process_payment_intent` (v1-terminal-readers-by-reader-process-payment-intent-post) — params: expand, payment_intent, process_config
- `POST /v1/terminal/readers/{reader}/process_setup_intent` (v1-terminal-readers-by-reader-process-setup-intent-post) — params: allow_redisplay, expand, process_config, setup_intent
- `POST /v1/terminal/readers/{reader}/refund_payment` (v1-terminal-readers-by-reader-refund-payment-post) — params: amount, charge, expand, metadata, payment_intent, refund_application_fee, refund_payment_config, reverse_transfer
- `POST /v1/terminal/readers/{reader}/set_reader_display` (v1-terminal-readers-by-reader-set-reader-display-post) — params: cart, expand, type
- `POST /v1/terminal/readers` (v1-terminal-readers-post) — params: expand, label, location, metadata, registration_code
- `POST /v1/terminal/refunds` (v1-terminal-refunds-post) — params: expand
- `POST /v1/test_helpers/confirmation_tokens` (v1-test-helpers-confirmation-tokens-post) — params: expand, payment_method, payment_method_data, payment_method_options, return_url, setup_future_usage, shipping
- `POST /v1/test_helpers/customers/{customer}/fund_cash_balance` (v1-test-helpers-customers-by-customer-fund-cash-balance-post) — params: amount, currency, expand, reference
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/capture` (v1-test-helpers-issuing-authorizations-by-authorization-capture-post) — params: capture_amount, close_authorization, expand, purchase_details
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/expire` (v1-test-helpers-issuing-authorizations-by-authorization-expire-post) — params: expand
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/finalize_amount` (v1-test-helpers-issuing-authorizations-by-authorization-finalize-amount-post) — params: expand, final_amount, fleet, fuel
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/fraud_challenges/respond` (v1-test-helpers-issuing-authorizations-by-authorization-fraud-challenges-respond-post) — params: confirmed, expand
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/increment` (v1-test-helpers-issuing-authorizations-by-authorization-increment-post) — params: expand, increment_amount, is_amount_controllable
- `POST /v1/test_helpers/issuing/authorizations/{authorization}/reverse` (v1-test-helpers-issuing-authorizations-by-authorization-reverse-post) — params: expand, reverse_amount
- `POST /v1/test_helpers/issuing/authorizations` (v1-test-helpers-issuing-authorizations-post) — params: amount, amount_details, authorization_method, card, currency, expand, fleet, fraud_disputability_likelihood, fuel, is_amount_controllable, merchant_amount, merchant_currency, merchant_data, network_data, risk_assessment, verification_data, wallet
- `POST /v1/test_helpers/issuing/cards/{card}/shipping/deliver` (v1-test-helpers-issuing-cards-by-card-shipping-deliver-post) — params: expand
- `POST /v1/test_helpers/issuing/cards/{card}/shipping/fail` (v1-test-helpers-issuing-cards-by-card-shipping-fail-post) — params: expand
- `POST /v1/test_helpers/issuing/cards/{card}/shipping/return` (v1-test-helpers-issuing-cards-by-card-shipping-return-post) — params: expand
- `POST /v1/test_helpers/issuing/cards/{card}/shipping/ship` (v1-test-helpers-issuing-cards-by-card-shipping-ship-post) — params: expand
- `POST /v1/test_helpers/issuing/cards/{card}/shipping/submit` (v1-test-helpers-issuing-cards-by-card-shipping-submit-post) — params: expand
- `POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/activate` (v1-test-helpers-issuing-personalization-designs-by-personalization-design-activate-post) — params: expand
- `POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/deactivate` (v1-test-helpers-issuing-personalization-designs-by-personalization-design-deactivate-post) — params: expand
- `POST /v1/test_helpers/issuing/personalization_designs/{personalization_design}/reject` (v1-test-helpers-issuing-personalization-designs-by-personalization-design-reject-post) — params: expand, rejection_reasons
- `POST /v1/test_helpers/issuing/settlements/{settlement}/complete` (v1-test-helpers-issuing-settlements-by-settlement-complete-post) — params: expand
- `POST /v1/test_helpers/issuing/settlements` (v1-test-helpers-issuing-settlements-post) — params: bin, clearing_date, currency, expand, interchange_fees_amount, net_total_amount, network, network_settlement_identifier, transaction_amount, transaction_count
- `POST /v1/test_helpers/issuing/transactions/{transaction}/refund` (v1-test-helpers-issuing-transactions-by-transaction-refund-post) — params: expand, refund_amount
- `POST /v1/test_helpers/issuing/transactions/create_force_capture` (v1-test-helpers-issuing-transactions-create-force-capture-post) — params: amount, card, currency, expand, merchant_data, purchase_details
- `POST /v1/test_helpers/issuing/transactions/create_unlinked_refund` (v1-test-helpers-issuing-transactions-create-unlinked-refund-post) — params: amount, card, currency, expand, merchant_data, purchase_details
- `POST /v1/test_helpers/refunds/{refund}/expire` (v1-test-helpers-refunds-by-refund-expire-post) — params: expand
- `POST /v1/test_helpers/terminal/readers/{reader}/present_payment_method` (v1-test-helpers-terminal-readers-by-reader-present-payment-method-post) — params: amount_tip, card, card_present, expand, interac_present, type
- `POST /v1/test_helpers/terminal/readers/{reader}/succeed_input_collection` (v1-test-helpers-terminal-readers-by-reader-succeed-input-collection-post) — params: expand, skip_non_required_inputs
- `POST /v1/test_helpers/terminal/readers/{reader}/timeout_input_collection` (v1-test-helpers-terminal-readers-by-reader-timeout-input-collection-post) — params: expand
- `GET /v1/test_helpers/test_clocks` (v1-test-helpers-test-clocks)
- `GET /v1/test_helpers/test_clocks/{test_clock}` (v1-test-helpers-test-clocks-by-test-clock)
- `POST /v1/test_helpers/test_clocks/{test_clock}/advance` (v1-test-helpers-test-clocks-by-test-clock-advance-post) — params: expand, frozen_time
- `DELETE /v1/test_helpers/test_clocks/{test_clock}` (v1-test-helpers-test-clocks-by-test-clock-delete)
- `POST /v1/test_helpers/test_clocks` (v1-test-helpers-test-clocks-post) — params: customer, expand, frozen_time, name
- `POST /v1/test_helpers/treasury/inbound_transfers/{id}/fail` (v1-test-helpers-treasury-inbound-transfers-by-id-fail-post) — params: expand, failure_details
- `POST /v1/test_helpers/treasury/inbound_transfers/{id}/return` (v1-test-helpers-treasury-inbound-transfers-by-id-return-post) — params: expand
- `POST /v1/test_helpers/treasury/inbound_transfers/{id}/succeed` (v1-test-helpers-treasury-inbound-transfers-by-id-succeed-post) — params: expand
- `POST /v1/test_helpers/treasury/outbound_payments/{id}/fail` (v1-test-helpers-treasury-outbound-payments-by-id-fail-post) — params: expand
- `POST /v1/test_helpers/treasury/outbound_payments/{id}` (v1-test-helpers-treasury-outbound-payments-by-id-post) — params: expand, tracking_details
- `POST /v1/test_helpers/treasury/outbound_payments/{id}/post` (v1-test-helpers-treasury-outbound-payments-by-id-post-post) — params: expand
- `POST /v1/test_helpers/treasury/outbound_payments/{id}/return` (v1-test-helpers-treasury-outbound-payments-by-id-return-post) — params: expand, returned_details
- `POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/fail` (v1-test-helpers-treasury-outbound-transfers-by-outbound-transfer-fail-post) — params: expand
- `POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}` (v1-test-helpers-treasury-outbound-transfers-by-outbound-transfer-post) — params: expand, tracking_details
- `POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/post` (v1-test-helpers-treasury-outbound-transfers-by-outbound-transfer-post-post) — params: expand
- `POST /v1/test_helpers/treasury/outbound_transfers/{outbound_transfer}/return` (v1-test-helpers-treasury-outbound-transfers-by-outbound-transfer-return-post) — params: expand, returned_details
- `POST /v1/test_helpers/treasury/received_credits` (v1-test-helpers-treasury-received-credits-post) — params: amount, currency, description, expand, financial_account, initiating_payment_method_details, network
- `POST /v1/test_helpers/treasury/received_debits` (v1-test-helpers-treasury-received-debits-post) — params: amount, currency, description, expand, financial_account, initiating_payment_method_details, network
- `GET /v1/tokens/{token}` (v1-tokens-by-token)
- `GET /v1/topups` (v1-topups)
- `GET /v1/topups/{topup}` (v1-topups-by-topup)
- `POST /v1/topups/{topup}/cancel` (v1-topups-by-topup-cancel-post) — params: expand
- `POST /v1/topups/{topup}` (v1-topups-by-topup-post) — params: description, expand, metadata
- `POST /v1/topups` (v1-topups-post) — params: amount, currency, description, expand, metadata, payment_method, payment_method_options, source, statement_descriptor, transfer_group
- `GET /v1/transfers` (v1-transfers)
- `GET /v1/transfers/{id}/reversals` (v1-transfers-by-id-reversals)
- `POST /v1/transfers/{id}/reversals` (v1-transfers-by-id-reversals-post) — params: amount, description, expand, metadata, refund_application_fee
- `GET /v1/transfers/{transfer}` (v1-transfers-by-transfer)
- `POST /v1/transfers/{transfer}` (v1-transfers-by-transfer-post) — params: description, expand, metadata
- `GET /v1/transfers/{transfer}/reversals/{id}` (v1-transfers-by-transfer-reversals-by-id)
- `POST /v1/transfers/{transfer}/reversals/{id}` (v1-transfers-by-transfer-reversals-by-id-post) — params: expand, metadata
- `POST /v1/transfers` (v1-transfers-post) — params: amount, currency, description, destination, expand, metadata, source_transaction, source_type, transfer_group
- `GET /v1/treasury/credit_reversals` (v1-treasury-credit-reversals)
- `GET /v1/treasury/credit_reversals/{credit_reversal}` (v1-treasury-credit-reversals-by-credit-reversal)
- `POST /v1/treasury/credit_reversals` (v1-treasury-credit-reversals-post) — params: expand, metadata, received_credit
- `GET /v1/treasury/debit_reversals` (v1-treasury-debit-reversals)
- `GET /v1/treasury/debit_reversals/{debit_reversal}` (v1-treasury-debit-reversals-by-debit-reversal)
- `POST /v1/treasury/debit_reversals` (v1-treasury-debit-reversals-post) — params: expand, metadata, received_debit
- `GET /v1/treasury/financial_accounts` (v1-treasury-financial-accounts)
- `GET /v1/treasury/financial_accounts/{financial_account}` (v1-treasury-financial-accounts-by-financial-account)
- `POST /v1/treasury/financial_accounts/{financial_account}/close` (v1-treasury-financial-accounts-by-financial-account-close-post) — params: expand, forwarding_settings
- `GET /v1/treasury/financial_accounts/{financial_account}/features` (v1-treasury-financial-accounts-by-financial-account-features)
- `POST /v1/treasury/financial_accounts/{financial_account}/features` (v1-treasury-financial-accounts-by-financial-account-features-post) — params: card_issuing, deposit_insurance, expand, financial_addresses, inbound_transfers, intra_stripe_flows, outbound_payments, outbound_transfers
- `POST /v1/treasury/financial_accounts/{financial_account}` (v1-treasury-financial-accounts-by-financial-account-post) — params: expand, features, forwarding_settings, metadata, nickname, platform_restrictions
- `POST /v1/treasury/financial_accounts` (v1-treasury-financial-accounts-post) — params: expand, features, metadata, nickname, platform_restrictions, supported_currencies
- `GET /v1/treasury/inbound_transfers` (v1-treasury-inbound-transfers)
- `GET /v1/treasury/inbound_transfers/{id}` (v1-treasury-inbound-transfers-by-id)
- `POST /v1/treasury/inbound_transfers/{inbound_transfer}/cancel` (v1-treasury-inbound-transfers-by-inbound-transfer-cancel-post) — params: expand
- `POST /v1/treasury/inbound_transfers` (v1-treasury-inbound-transfers-post) — params: amount, currency, description, expand, financial_account, metadata, origin_payment_method, statement_descriptor
- `GET /v1/treasury/outbound_payments` (v1-treasury-outbound-payments)
- `GET /v1/treasury/outbound_payments/{id}` (v1-treasury-outbound-payments-by-id)
- `POST /v1/treasury/outbound_payments/{id}/cancel` (v1-treasury-outbound-payments-by-id-cancel-post) — params: expand
- `POST /v1/treasury/outbound_payments` (v1-treasury-outbound-payments-post) — params: amount, currency, customer, description, destination_payment_method, destination_payment_method_data, destination_payment_method_options, end_user_details, expand, financial_account, metadata, statement_descriptor
- `GET /v1/treasury/outbound_transfers` (v1-treasury-outbound-transfers)
- `GET /v1/treasury/outbound_transfers/{outbound_transfer}` (v1-treasury-outbound-transfers-by-outbound-transfer)
- `POST /v1/treasury/outbound_transfers/{outbound_transfer}/cancel` (v1-treasury-outbound-transfers-by-outbound-transfer-cancel-post) — params: expand
- `POST /v1/treasury/outbound_transfers` (v1-treasury-outbound-transfers-post) — params: amount, currency, description, destination_payment_method, destination_payment_method_data, destination_payment_method_options, expand, financial_account, metadata, statement_descriptor
- `GET /v1/treasury/received_credits` (v1-treasury-received-credits)
- `GET /v1/treasury/received_credits/{id}` (v1-treasury-received-credits-by-id)
- `GET /v1/treasury/received_debits` (v1-treasury-received-debits)
- `GET /v1/treasury/received_debits/{id}` (v1-treasury-received-debits-by-id)
- `GET /v1/treasury/transaction_entries` (v1-treasury-transaction-entries)
- `GET /v1/treasury/transaction_entries/{id}` (v1-treasury-transaction-entries-by-id)
- `GET /v1/treasury/transactions` (v1-treasury-transactions)
- `GET /v1/treasury/transactions/{id}` (v1-treasury-transactions-by-id)
- `GET /v1/webhook_endpoints` (v1-webhook-endpoints)
- `GET /v1/webhook_endpoints/{webhook_endpoint}` (v1-webhook-endpoints-by-webhook-endpoint)
- `DELETE /v1/webhook_endpoints/{webhook_endpoint}` (v1-webhook-endpoints-by-webhook-endpoint-delete)
- `POST /v1/webhook_endpoints/{webhook_endpoint}` (v1-webhook-endpoints-by-webhook-endpoint-post) — params: description, disabled, enabled_events, expand, metadata, url
- `POST /v1/webhook_endpoints` (v1-webhook-endpoints-post) — params: api_version, connect, description, enabled_events, expand, metadata, url

## Credential model

- Stripe Secret Key (`secretKey`) — required — secret
- Stripe Webhook Signing Secret (`webhookSecret`) — secret

## Optional

- [Apivom Atlas product page](https://apivom.com/en/products/atlas)
- [All Atlas integration guides](https://apivom.com/llms.txt)
- [Request a demo](https://apivom.com/en/demo)