Access levels
Each Stripe account has an access level: Read-only and Read + write. Squad refuses any agent action outside that level. You can also narrow or block single agents under Per-agent access.| Level | The connect window describes this level as | Actions agents can use |
|---|---|---|
| Read-only | ”Read customers, payments, products. Cannot charge or refund.” | 206 of 432 |
| Read + write (recommended) | “Full Stripe access — charges, refunds, customers.” | 432 of 432 |
What agents can do at each level
Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action.Read-only
Read-only
- View line items
- View transactions
- View coupons and discounts
- View and search invoices
- View settings
- View account details
- View and search customers
- View events
- View payment methods
- View and search products
- View and search subscriptions
- View domains
Account details (7)
Account details (7)
| Action | What it does | Slug |
|---|---|---|
| Get account | Retrieves detailed information for the authenticated Stripe account. | STRIPE_GET_ACCOUNT |
| Get account | Retrieves the details of a Stripe account. | STRIPE_GET_ACCOUNTS_ACCOUNT |
| Get account capabilities | Retrieves a list of all capabilities for a connected Stripe account. | STRIPE_GET_ACCOUNT_CAPABILITIES |
| Get account capability | Retrieves information about a specific capability for a Stripe account. | STRIPE_GET_ACCOUNT_CAPABILITY |
| Get linked account | STRIPE_GET_LINKED_ACCOUNT | |
| List financial connections accounts | List Financial Connections Account objects representing external financial accounts. | STRIPE_LIST_FINANCIAL_CONNECTIONS_ACCOUNTS |
| Who am I | STRIPE_WHO_AM_I |
Alerts (2)
Alerts (2)
| Action | What it does | Slug |
|---|---|---|
| Get billing alert | Retrieves a billing alert by its unique identifier. | STRIPE_GET_BILLING_ALERT |
| List billing alerts | Retrieve a paginated list of billing alerts. | STRIPE_LIST_BILLING_ALERTS |
Associations (1)
Associations (1)
| Action | What it does | Slug |
|---|---|---|
| Find tax association | Find a tax association by PaymentIntent ID. | STRIPE_FIND_TAX_ASSOCIATION |
Balances (4)
Balances (4)
| Action | What it does | Slug |
|---|---|---|
| Get billing credit balance summary | Retrieves the credit balance summary for a customer in Stripe Billing. | STRIPE_GET_BILLING_CREDIT_BALANCE_SUMMARY |
| Get customer balance txn | Retrieves a specific customer balance transaction that updated the customer’s balances. | STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TXNS_TXN |
| Get customer cash balance | Retrieve a customer’s cash balance. | STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCE |
| Retrieve balance | Retrieves the complete current balance details for the connected Stripe account. | STRIPE_RETRIEVE_BALANCE |
Bank accounts (2)
Bank accounts (2)
| Action | What it does | Slug |
|---|---|---|
| Get customer bank accounts | Fetch all bank accounts linked to a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTS |
| Get customer bank accounts ID | Retrieves details about a specific bank account stored on a Stripe customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTS_ID |
Card readers (2)
Card readers (2)
| Action | What it does | Slug |
|---|---|---|
| Get terminal reader | Retrieve a Terminal Reader object by ID. | STRIPE_GET_TERMINAL_READER |
| List terminal readers | List all Stripe Terminal Readers with optional filtering. | STRIPE_LIST_TERMINAL_READERS |
Cards (2)
Cards (2)
| Action | What it does | Slug |
|---|---|---|
| Get customer cards | List all cards for a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_CARDS |
| Get customer cards ID | Retrieves details about a specific card for a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_CARDS_ID |
Charges (3)
Charges (3)
| Action | What it does | Slug |
|---|---|---|
| List charges | Retrieves a list of Stripe charges with filtering and pagination. | STRIPE_LIST_CHARGES |
| Retrieve charge | Retrieves full details for an existing Stripe charge using its unique ID. | STRIPE_RETRIEVE_CHARGE |
| Search charges | Search charges using Stripe’s Search Query Language. | STRIPE_SEARCH_CHARGES |
Checkout sessions (2)
Checkout sessions (2)
| Action | What it does | Slug |
|---|---|---|
| List checkout sessions | Retrieve a list of Stripe Checkout Sessions with pagination support. | STRIPE_LIST_CHECKOUT_SESSIONS |
| Retrieve checkout session | Retrieve a Checkout Session object from Stripe. | STRIPE_RETRIEVE_CHECKOUT_SESSION |
Code (3)
Code (3)
| Action | What it does | Slug |
|---|---|---|
| Get tax code | Retrieves the details of an existing tax code. | STRIPE_GET_TAX_CODE |
| Get tax code2 | Retrieve all tax codes available to add to Products for specific tax calculations. | STRIPE_GET_V1_TAX_CODES_TAX_CODE2 |
| List tax codes | Retrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax. | STRIPE_LIST_TAX_CODES |
Coupons and discounts (7)
Coupons and discounts (7)
| Action | What it does | Slug |
|---|---|---|
| Get coupon | Retrieves full details for an existing Stripe coupon using its unique ID. | STRIPE_GET_COUPON |
| Get customer discount | Retrieve the discount currently active on a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_DISCOUNT |
| Get customer sub exposed ID discount | Retrieve the discount currently applied to a customer’s subscription. | STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_ID_DISCOUNT |
| Get promotion codes | Retrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions. | STRIPE_GET_PROMOTION_CODES |
| List coupons | Retrieves a list of discount coupons from a Stripe account, supporting pagination via limit, starting_after, and ending_before. | STRIPE_LIST_COUPONS |
| List promotion codes | Retrieve a list of promotion codes from Stripe. | STRIPE_LIST_PROMOTION_CODES |
| Retrieve promotion code | Retrieve a Stripe promotion code by its ID. | STRIPE_RETRIEVE_PROMOTION_CODE |
Credit notes (5)
Credit notes (5)
| Action | What it does | Slug |
|---|---|---|
| Get credit note lines | Retrieves the paginated list of line items for a specific credit note. | STRIPE_GET_CREDIT_NOTES_CREDIT_NOTE_LINES |
| Get credit notes ID | Retrieves a credit note by its unique identifier. | STRIPE_GET_CREDIT_NOTES_ID |
| Get credit notes preview | Preview a credit note without creating it in Stripe. | STRIPE_GET_CREDIT_NOTES_PREVIEW |
| Get credit notes preview lines | Retrieve a credit note preview’s line items from Stripe. | STRIPE_GET_CREDIT_NOTES_PREVIEW_LINES |
| List credit notes | Lists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support. | STRIPE_LIST_CREDIT_NOTES |
Credits (2)
Credits (2)
| Action | What it does | Slug |
|---|---|---|
| Get billing credit grants | Retrieve a paginated list of billing credit grants. | STRIPE_GET_BILLING_CREDIT_GRANTS |
| Get billing credit grants ID | Retrieves a billing credit grant by its unique identifier. | STRIPE_GET_BILLING_CREDIT_GRANTS_ID |
Customers (8)
Customers (8)
| Action | What it does | Slug |
|---|---|---|
| Get customer sources | List sources for a specified customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCES |
| Get customer sources ID | Retrieve a specified payment source for a given customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCES_ID |
| Get customer sub exposed ID | Retrieve a specific subscription for a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_ID |
| Get customers search customers | Search for Stripe customers using Stripe’s Search Query Language. | STRIPE_GET_V1_CUSTOMERS_SEARCH_CUSTOMERS |
| List customers | Retrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination. | STRIPE_LIST_CUSTOMERS |
| Post customers search customers | Search for Stripe customers using a search query. | STRIPE_POST_V1_CUSTOMERS_SEARCH_CUSTOMERS |
| Retrieve customer | Retrieves detailed information for an existing Stripe customer using their unique customer ID. | STRIPE_RETRIEVE_CUSTOMER |
| Search customers | Retrieves a list of Stripe customers matching a search query that adheres to Stripe’s Search Query Language. | STRIPE_SEARCH_CUSTOMERS |
Disputes (3)
Disputes (3)
| Action | What it does | Slug |
|---|---|---|
| Get charge dispute | Retrieve a dispute for a specified charge. | STRIPE_GET_CHARGES_CHARGE_DISPUTE |
| Get disputes | Retrieves detailed information for an existing Stripe dispute by ID. | STRIPE_GET_V1_DISPUTES_DISPUTES |
| List disputes | List all disputes from a Stripe account. | STRIPE_LIST_DISPUTES |
Documents (1)
Documents (1)
| Action | What it does | Slug |
|---|---|---|
| Download quote PDF | Download the PDF for a finalized quote from Stripe. | STRIPE_DOWNLOAD_QUOTE_PDF |
Domains (4)
Domains (4)
| Action | What it does | Slug |
|---|---|---|
| Get apple pay domain | Retrieves details about a previously registered Apple Pay domain. | STRIPE_GET_APPLE_PAY_DOMAIN |
| Get payment method domain | Retrieves details of an existing payment method domain. | STRIPE_GET_PAYMENT_METHOD_DOMAIN |
| Get payment method domains | Retrieve list of payment method domains registered with Stripe account. | STRIPE_GET_V1_PAYMENT_METHOD_DOMAINS |
| List apple pay domains | Retrieves a list of Apple Pay domains registered with Stripe. | STRIPE_LIST_APPLE_PAY_DOMAINS |
Events (6)
Events (6)
| Action | What it does | Slug |
|---|---|---|
| Get core events retrieve an event | Retrieves detailed information about a specific event from Stripe V2 Core Events API. | STRIPE_GET_V2_CORE_EVENTS_RETRIEVE_AN_EVENT |
| Get events | Retrieves a list of Stripe events from the past 30 days with filtering and pagination. | STRIPE_GET_EVENTS |
| Get events ID | Retrieves event details for events created within the last 30 days. | STRIPE_GET_EVENTS_ID |
| List meter event summaries | Retrieve billing meter event summaries for a customer within a time range. | STRIPE_LIST_METER_EVENT_SUMMARIES |
| List v2 core event destinations | Retrieves a list of event destinations from Stripe V2 Core Events API. | STRIPE_LIST_V2_CORE_EVENT_DESTINATIONS |
| List v2 core events | List v2 core events from Stripe. | STRIPE_LIST_V2_CORE_EVENTS |
Features (4)
Features (4)
| Action | What it does | Slug |
|---|---|---|
| Get entitlements features ID | Retrieve a feature by ID from Stripe. | STRIPE_GET_ENTITLEMENTS_FEATURES_ID |
| Get product features ID | Retrieves a specific product feature by its ID. | STRIPE_GET_PRODUCTS_PRODUCT_FEATURES_ID |
| List entitlements features | Retrieves a paginated list of entitlements features from Stripe. | STRIPE_LIST_ENTITLEMENTS_FEATURES |
| List product features | Retrieves a list of features attached to a product. | STRIPE_LIST_PRODUCTS_PRODUCT_FEATURES |
Files (2)
Files (2)
| Action | What it does | Slug |
|---|---|---|
| Get file | Retrieve details of an existing file object by its unique identifier. | STRIPE_GET_FILES_FILE |
| List files | Retrieve a list of files that your account has access to. | STRIPE_LIST_FILES |
History (1)
History (1)
| Action | What it does | Slug |
|---|---|---|
| Get balance history | DEPRECATED: Use STRIPE_LIST_BALANCE_TRANSACTIONS instead. | STRIPE_GET_BALANCE_HISTORY |
Invoices (8)
Invoices (8)
| Action | What it does | Slug |
|---|---|---|
| Create preview invoice | Preview an upcoming invoice without creating it. | STRIPE_CREATE_PREVIEW_INVOICE |
| Get invoice | Retrieve a specific invoice by ID. | STRIPE_GET_INVOICES_INVOICE |
| Get invoice lines | Retrieve a paginated list of line items for a specific invoice. | STRIPE_GET_INVOICES_INVOICE_LINES |
| Get invoiceitem | Retrieve the details of an invoice item using its unique identifier. | STRIPE_GET_INVOICEITEMS_INVOICEITEM |
| List invoiceitems | Retrieves a paginated list of Stripe invoice items. | STRIPE_LIST_INVOICEITEMS |
| List invoices | Retrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses. | STRIPE_LIST_INVOICES |
| Retrieve upcoming invoice | Preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items. | STRIPE_RETRIEVE_UPCOMING_INVOICE |
| Search invoices | Searches for invoices using Stripe’s Search Query Language. | STRIPE_SEARCH_INVOICES |
Line items (12)
Line items (12)
| Action | What it does | Slug |
|---|---|---|
| Get checkout session line items | Retrieve line items for a Checkout Session. | STRIPE_GET_CHECKOUT_SESSIONS_SESSION_LINE_ITEMS |
| Get payment intent amount details line items | Retrieve paginated line items for a PaymentIntent. | STRIPE_GET_PAYMENT_INTENT_AMOUNT_DETAILS_LINE_ITEMS |
| Get payment link line items | Retrieve paginated line items for a payment link. | STRIPE_GET_PAYMENT_LINKS_PAYMENT_LINK_LINE_ITEMS |
| Get quote computed upfront line items | Retrieve computed upfront line items for a quote. | STRIPE_GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMS |
| Get quote line items | Retrieve a paginated list of line items for a quote. | STRIPE_GET_QUOTES_QUOTE_LINE_ITEMS |
| Get radar value list items | List all value list items from a Stripe Radar value list. | STRIPE_GET_RADAR_VALUE_LIST_ITEMS |
| Get subscription item | Retrieves detailed information for a specific subscription item using its unique ID. | STRIPE_GET_SUBSCRIPTION_ITEM |
| Get tax calculation line items | Retrieves line items of a tax calculation as a paginated collection. | STRIPE_GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMS |
| Get tax transaction line items | Retrieves the line items of a committed standalone tax transaction. | STRIPE_GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMS |
| Get upcoming invoice line items | Retrieve a paginated list of line items for an upcoming invoice preview. | STRIPE_GET_UPCOMING_INVOICE_LINE_ITEMS |
| List all subscription item period summaries | Returns summaries sorted in reverse-chronological order (newest first), with the first item representing the most current usage period. | STRIPE_LIST_ALL_SUBSCRIPTION_ITEM_PERIOD_SUMMARIES |
| List subscription items | List all subscription items for a given subscription. | STRIPE_LIST_SUBSCRIPTION_ITEMS |
Links (2)
Links (2)
| Action | What it does | Slug |
|---|---|---|
| Get file link | Retrieves the details of an existing file link. | STRIPE_GET_FILE_LINKS_LINK |
| List file links | Retrieve a list of Stripe file links. | STRIPE_LIST_FILE_LINKS |
Lists (2)
Lists (2)
| Action | What it does | Slug |
|---|---|---|
| Get radar value list | Retrieves a specific Stripe Radar value list by its identifier. | STRIPE_GET_RADAR_VALUE_LIST |
| Get radar value lists overview radar value lists | Retrieve an overview of Radar value lists. | STRIPE_GET_V1_RADAR_VALUE_LISTS_OVERVIEW_RADAR_VALUE_LISTS |
Locations (2)
Locations (2)
| Action | What it does | Slug |
|---|---|---|
| Get terminal location | Retrieve a Terminal Location object by ID. | STRIPE_GET_TERMINAL_LOCATION |
| List terminal locations | Retrieves a list of Stripe terminal locations with pagination support. | STRIPE_LIST_TERMINAL_LOCATIONS |
Meters (2)
Meters (2)
| Action | What it does | Slug |
|---|---|---|
| Get billing meters | Retrieve a list of billing meters from Stripe. | STRIPE_GET_BILLING_METERS |
| Get billing meters ID | Retrieves a billing meter by its unique identifier. | STRIPE_GET_BILLING_METERS_ID |
Orders (1)
Orders (1)
| Action | What it does | Slug |
|---|---|---|
| List climate orders | List all Climate order objects. | STRIPE_LIST_CLIMATE_ORDERS |
Payment intents (3)
Payment intents (3)
| Action | What it does | Slug |
|---|---|---|
| List payment intents | List PaymentIntents from Stripe. | STRIPE_LIST_PAYMENT_INTENTS |
| Retrieve payment intent | Retrieves a PaymentIntent by its ID. | STRIPE_RETRIEVE_PAYMENT_INTENT |
| Search payment intents | Searches for PaymentIntents using Stripe’s Search Query Language. | STRIPE_SEARCH_PAYMENT_INTENTS |
Payment links (2)
Payment links (2)
| Action | What it does | Slug |
|---|---|---|
| Get payment link | Retrieve details of an existing Stripe payment link by ID. | STRIPE_GET_PAYMENT_LINK |
| List payment links | Retrieves a list of payment links from Stripe, sorted by creation date in descending order by default. | STRIPE_LIST_PAYMENT_LINKS |
Payment methods (5)
Payment methods (5)
| Action | What it does | Slug |
|---|---|---|
| Get customer payment method | Retrieve a specific PaymentMethod object for a given Customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_PAYMENT_METHOD |
| Get customer payment methods | Retrieves a list of payment methods for a given customer, supporting type filtering and pagination. | STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS |
| Get payment method | Retrieves the details of a PaymentMethod object by its unique identifier. | STRIPE_GET_PAYMENT_METHOD |
| Get payment method configs list payment method2 | List all payment method configurations in a Stripe account. | STRIPE_GET_V1_PAYMENT_METHOD_CONFIGS_LIST_PAYMENT_METHOD2 |
| Get payment methods2 | Retrieve a list of PaymentMethods with filtering and pagination support. | STRIPE_GET_V1_PAYMENT_METHODS_PAYMENT_METHODS2 |
Payments (3)
Payments (3)
| Action | What it does | Slug |
|---|---|---|
| Get invoice payments ID | Retrieve details of a specific Stripe invoice payment by ID. | STRIPE_GET_INVOICE_PAYMENTS_ID |
| Get invoice payments overview2 | List invoice payments in Stripe with pagination and filtering options. | STRIPE_GET_V1_INVOICE_PAYMENTS_OVERVIEW2 |
| List invoice payments | List all payments for invoices in Stripe. | STRIPE_LIST_INVOICE_PAYMENTS |
Payouts (2)
Payouts (2)
| Action | What it does | Slug |
|---|---|---|
| Get payout | Retrieve details of an existing Stripe payout. | STRIPE_GET_PAYOUT |
| List payouts | Lists Stripe payouts sent to external accounts or received from Stripe, sorted by creation date descending (newest first), with optional filtering by arrival date, creation date, destination, and status. | STRIPE_LIST_PAYOUTS |
People (2)
People (2)
| Action | What it does | Slug |
|---|---|---|
| Get account person | Retrieves an existing person associated with a Stripe account. | STRIPE_GET_ACCOUNT_PERSON |
| Get account persons | Retrieves a list of people associated with the account’s legal entity. | STRIPE_GET_ACCOUNT_PERSONS |
Plans (2)
Plans (2)
| Action | What it does | Slug |
|---|---|---|
| Get plan | Retrieve a specific Stripe plan by its unique identifier. | STRIPE_GET_PLAN |
| List plans | List all billing plans from Stripe account. | STRIPE_LIST_PLANS |
Prices (3)
Prices (3)
| Action | What it does | Slug |
|---|---|---|
| Get price | Retrieves detailed information for a specific Stripe price using its unique ID. | STRIPE_GET_PRICES_PRICE |
| List prices | List Stripe prices. | STRIPE_LIST_PRICES |
| Search prices | Search for prices using Stripe’s Search Query Language. | STRIPE_SEARCH_PRICES |
Products (5)
Products (5)
| Action | What it does | Slug |
|---|---|---|
| Get climate product | Retrieve details of a specific Stripe Climate product. | STRIPE_GET_CLIMATE_PRODUCTS_PRODUCT |
| Get products ID | Retrieves detailed information for an existing Stripe product using its unique product ID. | STRIPE_GET_PRODUCTS_ID |
| List climate products | Retrieve a list of available Stripe Climate products. | STRIPE_LIST_CLIMATE_PRODUCTS |
| List products | Retrieves a list of Stripe products, with optional filtering and pagination. | STRIPE_LIST_PRODUCTS |
| Search products | Search for products using Stripe’s Search Query Language. | STRIPE_SEARCH_PRODUCTS |
Quotes (4)
Quotes (4)
| Action | What it does | Slug |
|---|---|---|
| Get fx quote | Retrieve a specific FX (foreign exchange) Quote by its ID. | STRIPE_GET_FX_QUOTE |
| Get quote | Retrieve a quote by ID. | STRIPE_GET_QUOTES_QUOTE |
| List fx quotes | Retrieves a list of FX quotes that have been issued, with the most recent appearing first. | STRIPE_LIST_FX_QUOTES |
| List quotes | Retrieves a list of Stripe quotes with pagination support. | STRIPE_LIST_QUOTES |
Records (3)
Records (3)
| Action | What it does | Slug |
|---|---|---|
| Get payment attempt records ID | Retrieve a specific Payment Attempt Record by ID. | STRIPE_GET_PAYMENT_ATTEMPT_RECORDS_ID |
| Get payment record | Retrieve a Payment Record from Stripe. | STRIPE_GET_PAYMENT_RECORD |
| List payment attempt records | List payment attempt records for a specified payment record. | STRIPE_LIST_PAYMENT_ATTEMPT_RECORDS |
Refunds (4)
Refunds (4)
| Action | What it does | Slug |
|---|---|---|
| Get charge refund | Retrieve the details of an existing refund within a specific charge. | STRIPE_GET_CHARGES_CHARGE_REFUNDS_REFUND |
| Get refund | Retrieve details of a specific Stripe refund by ID. | STRIPE_GET_REFUNDS_REFUND |
| List charge refunds | STRIPE_LIST_CHARGE_REFUNDS | |
| List refunds | Lists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support. | STRIPE_LIST_REFUNDS |
Reviews (2)
Reviews (2)
| Action | What it does | Slug |
|---|---|---|
| List radar reviews | Returns a list of Radar Review objects that have open set to true, sorted in descending order by creation date. | STRIPE_LIST_RADAR_REVIEWS |
| List reviews | Retrieves a list of open Stripe reviews with pagination support. | STRIPE_LIST_REVIEWS |
Runs (3)
Runs (3)
| Action | What it does | Slug |
|---|---|---|
| Get reporting report run | Retrieves details of an existing Report Run object. | STRIPE_GET_REPORTING_REPORT_RUNS_REPORT_RUN |
| List reporting report runs | Lists Stripe Report Runs, sorted by creation date descending (newest first). | STRIPE_LIST_REPORTING_REPORT_RUNS |
| List sigma scheduled query runs | List all Sigma scheduled query runs. | STRIPE_LIST_SIGMA_SCHEDULED_QUERY_RUNS |
Schedules (2)
Schedules (2)
| Action | What it does | Slug |
|---|---|---|
| Get subscription schedule | Retrieve a subscription schedule using its unique identifier. | STRIPE_GET_SUBSCRIPTION_SCHEDULES_SCHEDULE |
| Get subscription schedules overview2 | Retrieves a list of subscription schedules with optional filtering and pagination capabilities. | STRIPE_GET_V1_SUBSCRIPTION_SCHEDULES_OVERVIEW2 |
Secrets (2)
Secrets (2)
| Action | What it does | Slug |
|---|---|---|
| Find apps secret | Find a secret by name and scope in the Stripe Apps secret store. | STRIPE_FIND_APPS_SECRET |
| List apps secrets | List all secrets stored on the given scope. | STRIPE_LIST_APPS_SECRETS |
Sessions (1)
Sessions (1)
| Action | What it does | Slug |
|---|---|---|
| Get financial connections session | Retrieves the details of a Financial Connections Session. | STRIPE_GET_FINANCIAL_CONNECTIONS_SESSIONS_SESSION |
Settings (8)
Settings (8)
| Action | What it does | Slug |
|---|---|---|
| Get balance settings | Retrieve balance settings for a Stripe account. | STRIPE_GET_BALANCE_SETTINGS |
| Get billing portal configuration | Retrieve a billing portal configuration from Stripe. | STRIPE_GET_BILLING_PORTAL_CONFIGURATIONS_CONFIGURATION |
| Get billing portal configurations | List billing portal configurations. | STRIPE_GET_BILLING_PORTAL_CONFIGURATIONS |
| Get payment method configuration | Retrieve a specific payment method configuration by its unique identifier. | STRIPE_GET_PAYMENT_METHOD_CONFIGURATION |
| Get tax settings | Retrieves Tax Settings for a merchant. | STRIPE_GET_TAX_SETTINGS |
| Get terminal configuration | Retrieve a specific Terminal Configuration object from Stripe. | STRIPE_GET_TERMINAL_CONFIGURATION |
| List forwarding requests | Lists ForwardingRequest objects from Stripe’s Vault and Forward API. | STRIPE_LIST_FORWARDING_REQUESTS |
| List terminal configurations | Retrieve a list of Terminal Configuration objects from Stripe. | STRIPE_LIST_TERMINAL_CONFIGURATIONS |
Setup intents (2)
Setup intents (2)
| Action | What it does | Slug |
|---|---|---|
| Get setup intent | Retrieves details of a SetupIntent by its ID. | STRIPE_GET_SETUP_INTENT |
| List setup intents | List SetupIntents from Stripe. | STRIPE_LIST_SETUP_INTENTS |
Subscriptions (5)
Subscriptions (5)
| Action | What it does | Slug |
|---|---|---|
| Get customer subscriptions | DEPRECATED: Use STRIPE_LIST_SUBSCRIPTIONS instead. | STRIPE_GET_CUSTOMERS_CUSTOMER_SUBSCRIPTIONS |
| Get subscription | Retrieves detailed information for an existing Stripe subscription using its unique ID. | STRIPE_GET_SUBSCRIPTION |
| List customer subscriptions | List all active subscriptions for a customer in Stripe. | STRIPE_LIST_CUSTOMER_SUBSCRIPTIONS |
| List subscriptions | Retrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination. | STRIPE_LIST_SUBSCRIPTIONS |
| Search subscriptions | Searches for subscriptions using Stripe’s Search Query Language. | STRIPE_SEARCH_SUBSCRIPTIONS |
Tax rates (3)
Tax rates (3)
| Action | What it does | Slug |
|---|---|---|
| Get tax rate | Retrieve the details of an existing tax rate. | STRIPE_GET_TAX_RATE |
| Get tax rate2 | Retrieve all tax rates with pagination support. | STRIPE_GET_V1_TAX_RATES_TAX_RATE2 |
| List tax rates | Retrieves a list of tax rates, which are returned sorted by creation date in descending order. | STRIPE_LIST_TAX_RATES |
Taxes (7)
Taxes (7)
| Action | What it does | Slug |
|---|---|---|
| Get customer tax IDs | Retrieve all tax IDs for a specific Stripe customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_TAX_IDS |
| Get customer tax IDs ID | Retrieve a specific tax ID for a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_TAX_IDS_ID |
| Get tax calculation | Retrieves a Tax Calculation object by its unique ID. | STRIPE_GET_TAX_CALCULATION |
| Get tax ID | Retrieves an account or customer tax ID object. | STRIPE_GET_TAX_ID |
| Get tax IDs overview2 | Retrieve a list of tax IDs with pagination support. | STRIPE_GET_V1_TAX_IDS_OVERVIEW2 |
| Get tax registration | Retrieve a specific tax registration configured for your Stripe account. | STRIPE_GET_TAX_REGISTRATION |
| List tax registrations | Retrieves a paginated list of tax registrations. | STRIPE_LIST_TAX_REGISTRATIONS |
Templates (1)
Templates (1)
| Action | What it does | Slug |
|---|---|---|
| List invoice rendering templates | List all invoice rendering templates ordered by creation date. | STRIPE_LIST_INVOICE_RENDERING_TEMPLATES |
Tokens (2)
Tokens (2)
| Action | What it does | Slug |
|---|---|---|
| Get confirmation token | Retrieve an existing ConfirmationToken object by its ID. | STRIPE_GET_CONFIRMATION_TOKENS_CONFIRMATION_TOKEN |
| Get token | Retrieves the token with the given ID. | STRIPE_GET_TOKEN |
Top-ups (1)
Top-ups (1)
| Action | What it does | Slug |
|---|---|---|
| List topups | Retrieve a list of existing top-ups from Stripe. | STRIPE_LIST_TOPUPS |
Transactions (8)
Transactions (8)
| Action | What it does | Slug |
|---|---|---|
| Get balance transaction | Retrieves the balance transaction with the given ID. | STRIPE_GET_BALANCE_TRANSACTION |
| Get billing credit balance transactions ID | Retrieves a credit balance transaction by its unique identifier. | STRIPE_GET_BILLING_CREDIT_BALANCE_TRANSACTIONS_ID |
| Get customer balance transactions | List customer balance transactions that updated a customer’s balance. | STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONS |
| Get customer cash balance transactions | Retrieve a list of cash balance transactions for a customer. | STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONS |
| Get customers cash balance transactions | Retrieve a specific cash balance transaction that updated a customer’s cash balance. | STRIPE_GET_CUSTOMERS_CASH_BALANCE_TRANSACTIONS |
| Get tax transaction | Retrieves a Tax Transaction object by ID. | STRIPE_GET_TAX_TRANSACTION |
| List balance transactions | Lists Stripe balance transactions sorted by creation date descending (newest first), with optional filtering by currency, type, source, or payout and pagination support. | STRIPE_LIST_BALANCE_TRANSACTIONS |
| List billing credit balance transactions | Retrieve a paginated list of credit balance transactions with optional filtering. | STRIPE_LIST_BILLING_CREDIT_BALANCE_TRANSACTIONS |
Transfers (2)
Transfers (2)
| Action | What it does | Slug |
|---|---|---|
| Get transfer reversal | STRIPE_GET_TRANSFER_REVERSAL | |
| List transfers | List all transfers sent to connected accounts. | STRIPE_LIST_TRANSFERS |
Types (2)
Types (2)
| Action | What it does | Slug |
|---|---|---|
| Get reporting report type | Retrieve details of a specific Stripe report type by ID. | STRIPE_GET_REPORTING_REPORT_TYPE |
| Get reporting report types overview reporting | List all available Stripe report types. | STRIPE_GET_V1_REPORTING_REPORT_TYPES_OVERVIEW_REPORTING |
Vendors (2)
Vendors (2)
| Action | What it does | Slug |
|---|---|---|
| Get climate supplier | Retrieves detailed information about a specific Stripe Climate carbon removal supplier. | STRIPE_GET_CLIMATE_SUPPLIERS_SUPPLIER |
| List climate suppliers | Retrieve a list of available Stripe Climate supplier objects for carbon removal. | STRIPE_LIST_CLIMATE_SUPPLIERS |
Other actions (15)
Other actions (15)
| Action | What it does | Slug |
|---|---|---|
| Get active entitlement | Retrieve an active entitlement describing customer access to a feature. | STRIPE_GET_ACTIVE_ENTITLEMENT |
| Get country specs country | Retrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. | STRIPE_GET_COUNTRY_SPECS_COUNTRY |
| Get entitlements active entitlements | Retrieve active entitlements for a customer. | STRIPE_GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTS |
| Get mandate | Retrieve a Stripe mandate by ID. | STRIPE_GET_MANDATE |
| Get radar early fraud warnings overview | Returns a list of early fraud warnings. | STRIPE_GET_V1_RADAR_EARLY_FRAUD_WARNINGS_OVERVIEW |
| Get setup attempts | List SetupAttempts associated with a SetupIntent. | STRIPE_GET_SETUP_ATTEMPTS |
| Get shipping rate | Retrieve details of a specific Stripe shipping rate by its unique ID. | STRIPE_GET_SHIPPING_RATE |
| Get shipping rates overview2 | Retrieve an overview of shipping rates from Stripe. | STRIPE_GET_V1_SHIPPING_RATES_OVERVIEW2 |
| Get source | Retrieves an existing source object. | STRIPE_GET_SOURCES_SOURCE |
| Get test clock | Retrieve a test clock by ID. | STRIPE_GET_TEST_CLOCK |
| List application fees | Returns a list of application fees you’ve previously collected, sorted by creation date descending (newest first). | STRIPE_LIST_APPLICATION_FEES |
| List country specs | Retrieves a list of country specifications available in the Stripe API. | STRIPE_LIST_COUNTRY_SPECS |
| List radar early fraud warnings | List all early fraud warnings from Stripe Radar. | STRIPE_LIST_RADAR_EARLY_FRAUD_WARNINGS |
| List setup attempts | List SetupAttempts associated with a SetupIntent. | STRIPE_LIST_SETUP_ATTEMPTS |
| List test clocks | Retrieves a paginated list of test clocks. | STRIPE_LIST_TEST_CLOCKS |
Read + write (recommended)
Read + write (recommended)
- Create, update, delete, send, and manage invoices
- Create, update, delete, and manage coupons and discounts
- Create, update, cancel, and test payment intents
- Create, update, delete, start, cancel, and manage subscriptions
- Create, update, and manage payment methods
- Create, update, and delete settings
- Create, update, and cancel quotes
- Create tokens
- Create sessions
- Create, update, and archive alerts
- Create, update, and delete bank accounts
- Create and update charges
Account details (2)
Account details (2)
| Action | What it does | Slug |
|---|---|---|
| Post accounts capabilities | Updates an existing account capability for a Stripe connected account. | STRIPE_POST_V1_ACCOUNTS_CAPABILITIES_CAPABILITIES |
| Update external account | STRIPE_UPDATE_EXTERNAL_ACCOUNT |
Alerts (4)
Alerts (4)
| Action | What it does | Slug |
|---|---|---|
| Activate billing alert | Reactivates a billing alert, allowing it to trigger again. | STRIPE_ACTIVATE_BILLING_ALERT |
| Archive billing alert | Archive a billing alert in Stripe, removing it from list views and APIs. | STRIPE_ARCHIVE_BILLING_ALERT |
| Create billing alert | Create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed. | STRIPE_CREATE_BILLING_ALERT |
| Deactivate billing alert | Deactivate a billing alert, preventing it from triggering. | STRIPE_DEACTIVATE_BILLING_ALERT |
Balances (4)
Balances (4)
| Action | What it does | Slug |
|---|---|---|
| Apply customer balance | Manually reconciles remaining amount for a customer_balance PaymentIntent by applying funds from customer’s cash balance. | STRIPE_APPLY_CUSTOMER_BALANCE |
| Fund test cash balance | Fund a test mode cash balance for a customer. | STRIPE_FUND_TEST_CASH_BALANCE |
| Update cash balance | Update a customer’s cash balance settings in Stripe. | STRIPE_UPDATE_CASH_BALANCE |
| Update customer balance txn | Updates an existing customer balance transaction’s description and metadata. | STRIPE_UPDATE_CUSTOMER_BALANCE_TXN |
Bank accounts (5)
Bank accounts (5)
| Action | What it does | Slug |
|---|---|---|
| Create customer bank account | Create a new bank account attached to a customer object. | STRIPE_CREATE_CUSTOMER_BANK_ACCOUNT |
| Delete customer bank account | Deletes a bank account payment source from a customer. | STRIPE_DELETE_CUSTOMER_BANK_ACCOUNT |
| Post customers sources verify the bank account | Verifies a bank account for a customer using microdeposit amounts. | STRIPE_POST_CUSTOMERS_SOURCES_VERIFY_THE_BANK_ACCOUNT |
| Update customer bank account | Updates a specified bank account for a given customer. | STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNT |
| Update customer bank account source | Updates a bank account source attached to a customer. | STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNT_SOURCE |
Card readers (9)
Card readers (9)
| Action | What it does | Slug |
|---|---|---|
| Cancel terminal reader action | Cancel the current reader action. | STRIPE_CANCEL_TERMINAL_READER_ACTION |
| Collect terminal reader inputs | Initiates input collection on a Terminal Reader to display forms and collect customer information. | STRIPE_COLLECT_TERMINAL_READER_INPUTS |
| Create terminal reader | Creates and registers a new Terminal Reader to a Stripe account at a specified location. | STRIPE_CREATE_TERMINAL_READER |
| Delete terminal reader | Permanently deletes a Terminal Reader object from your Stripe account. | STRIPE_DELETE_TERMINAL_READER |
| Post terminal reader set reader display | Configures a Stripe terminal reader to display cart information on screen. | STRIPE_POST_TERMINAL_READERS_READER_SET_READER_DISPLAY |
| Post terminal readers set reader display | Configure a terminal reader’s display to show cart details. | STRIPE_POST_TERMINAL_READERS_SET_READER_DISPLAY |
| Set reader display | Configures a Stripe Terminal reader to display cart information on its screen. | STRIPE_SET_READER_DISPLAY |
| Set terminal reader display | Set the display on a Stripe Terminal reader to show cart details. | STRIPE_SET_TERMINAL_READER_DISPLAY |
| Update terminal reader | Update a Terminal Reader object by setting parameter values. | STRIPE_UPDATE_TERMINAL_READER |
Cards (2)
Cards (2)
| Action | What it does | Slug |
|---|---|---|
| Create customer card | Create a new card payment source for an existing Stripe customer. | STRIPE_CREATE_CUSTOMER_CARD |
| Update customer card | Update a card for a specified customer. | STRIPE_UPDATE_CUSTOMER_CARD |
Charges (4)
Charges (4)
| Action | What it does | Slug |
|---|---|---|
| Capture charge | Capture payment on an uncaptured charge. | STRIPE_CAPTURE_CHARGE |
| Create charge | Create a charge to request payment from a credit or debit card. | STRIPE_CREATE_CHARGE |
| Post charge | Updates a Stripe charge with the specified parameters. | STRIPE_POST_CHARGES_CHARGE |
| Update charge | Update a Stripe charge object with provided parameters. | STRIPE_UPDATE_CHARGE |
Checkout sessions (4)
Checkout sessions (4)
| Action | What it does | Slug |
|---|---|---|
| Create checkout session | Create a Stripe Checkout Session. | STRIPE_CREATE_CHECKOUT_SESSION |
| Expire checkout session | Expire an active Stripe Checkout Session. | STRIPE_EXPIRE_CHECKOUT_SESSION |
| Post checkout sessions retrieve a checkout | Update and retrieve a Checkout Session object from Stripe. | STRIPE_POST_V1_CHECKOUT_SESSIONS_RETRIEVE_A_CHECKOUT |
| Update checkout session | Update a Stripe Checkout Session dynamically. | STRIPE_UPDATE_CHECKOUT_SESSION |
Collections (2)
Collections (2)
| Action | What it does | Slug |
|---|---|---|
| Succeed test terminal reader input collection | Simulates successful completion of an ongoing input collection on a Terminal reader. | STRIPE_SUCCEED_TEST_TERMINAL_READER_INPUT_COLLECTION |
| Timeout test terminal reader input collection | Simulate an input collection timeout on a Stripe Terminal reader. | STRIPE_TIMEOUT_TEST_TERMINAL_READER_INPUT_COLLECTION |
Coupons and discounts (9)
Coupons and discounts (9)
| Action | What it does | Slug |
|---|---|---|
| Create coupon | Creates a new discount coupon in Stripe with percentage or fixed amount discount. | STRIPE_CREATE_COUPON |
| Create promotion code | Create a promotion code linked to an underlying coupon. | STRIPE_CREATE_PROMOTION_CODE |
| Delete coupon | Delete a coupon from Stripe. | STRIPE_DELETE_COUPON |
| Delete customer discount | Removes the currently applied discount on a customer. | STRIPE_DELETE_CUSTOMER_DISCOUNT |
| Delete customer subscription discount | Removes currently applied discount from a customer’s subscription. | STRIPE_DELETE_CUSTOMER_SUBSCRIPTION_DISCOUNT |
| Delete subscription discount | Removes the currently applied discount on a subscription. | STRIPE_DELETE_SUBSCRIPTION_DISCOUNT |
| Post promotion code | Updates an existing promotion code. | STRIPE_POST_V1_PROMOTION_CODES_PROMOTION_CODE |
| Update coupon | Updates a Stripe coupon’s metadata, name, or currency options. | STRIPE_UPDATE_COUPON |
| Update promotion code | Updates an existing Stripe promotion code by setting the values of the parameters passed. | STRIPE_UPDATE_PROMOTION_CODE |
Credit notes (3)
Credit notes (3)
| Action | What it does | Slug |
|---|---|---|
| Create credit note | Issues a credit note to adjust a finalized invoice’s amount. | STRIPE_CREATE_CREDIT_NOTE |
| Post credit note2 | Update an existing credit note in Stripe by modifying its memo or metadata. | STRIPE_POST_V1_CREDIT_NOTES_CREDIT_NOTE2 |
| Void credit note | Marks a credit note as void. | STRIPE_VOID_CREDIT_NOTE |
Credits (4)
Credits (4)
| Action | What it does | Slug |
|---|---|---|
| Create billing credit grant | Create a credit grant that allocates billing credits to a customer for use against metered pricing. | STRIPE_CREATE_BILLING_CREDIT_GRANT |
| Expire billing credit grant | Expires a billing credit grant immediately. | STRIPE_EXPIRE_BILLING_CREDIT_GRANT |
| Post billing credit grants void credit grant | Voids a billing credit grant, preventing it from being applied to future invoices. | STRIPE_POST_BILLING_CREDIT_GRANTS_VOID_CREDIT_GRANT |
| Update billing credit grant | Updates an existing billing credit grant. | STRIPE_UPDATE_BILLING_CREDIT_GRANT |
Customers (9)
Customers (9)
| Action | What it does | Slug |
|---|---|---|
| Attach customer source | Attach a payment source (card token or source object) to a customer for future charges. | STRIPE_ATTACH_CUSTOMER_SOURCE |
| Create customer | Creates a new customer in Stripe, required for creating charges or subscriptions. | STRIPE_CREATE_CUSTOMER |
| Create customer source | Attaches a payment source to a customer for later reuse. | STRIPE_CREATE_CUSTOMER_SOURCE |
| Delete customer | DEPRECATED: Use STRIPE_DELETE_CUSTOMERS_CUSTOMER instead. | STRIPE_DELETE_CUSTOMER |
| Delete customer | Permanently deletes a customer and cancels active subscriptions. | STRIPE_DELETE_CUSTOMERS_CUSTOMER |
| Post customer sub exposed ID | Update a customer’s subscription. | STRIPE_POST_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_ID |
| Post customers funding instructions fund a test | Creates or retrieves funding instructions for a customer cash balance via bank transfer. | STRIPE_POST_V1_CUSTOMERS_FUNDING_INSTRUCTIONS_FUND_A_TEST |
| Update customer | Updates an existing Stripe customer, identified by customer_id, with only the provided details. | STRIPE_UPDATE_CUSTOMER |
| Update customer source | Update a specified source for a given customer. | STRIPE_UPDATE_CUSTOMER_SOURCE |
Disputes (3)
Disputes (3)
| Action | What it does | Slug |
|---|---|---|
| Close dispute | Close a dispute. | STRIPE_CLOSE_DISPUTE |
| Update charge dispute | Update metadata on a charge’s dispute. | STRIPE_UPDATE_CHARGE_DISPUTE |
| Update dispute | Update a Stripe dispute by submitting evidence or updating metadata. | STRIPE_UPDATE_DISPUTE |
Domains (4)
Domains (4)
| Action | What it does | Slug |
|---|---|---|
| Create apple pay domain | Create an Apple Pay domain registration. | STRIPE_CREATE_APPLE_PAY_DOMAIN |
| Create payment method domain | Create a payment method domain object to control where payment methods are shown. | STRIPE_CREATE_PAYMENT_METHOD_DOMAIN |
| Delete apple pay domain | Delete an Apple Pay domain from a Stripe account. | STRIPE_DELETE_APPLE_PAY_DOMAIN |
| Validate payment method domain | Validate an existing payment method domain in Stripe to activate payment methods. | STRIPE_VALIDATE_PAYMENT_METHOD_DOMAIN |
Events (5)
Events (5)
| Action | What it does | Slug |
|---|---|---|
| Create billing meter event | Creates a billing meter event using Stripe API v2 for usage-based billing. | STRIPE_CREATE_BILLING_METER_EVENT |
| Create billing meter event adjustment | Creates an adjustment to cancel a billing meter event. | STRIPE_CREATE_BILLING_METER_EVENT_ADJUSTMENT |
| Disable event destination | STRIPE_DISABLE_EVENT_DESTINATION | |
| Post billing meter event adjustments meter event | Creates a billing meter event adjustment to cancel a previously sent meter event. | STRIPE_POST_V2_BILLING_METER_EVENT_ADJUSTMENTS_METER_EVENT |
| Update event destination | STRIPE_UPDATE_EVENT_DESTINATION |
Features (4)
Features (4)
| Action | What it does | Slug |
|---|---|---|
| Attach product feature | Attach a feature to a product. | STRIPE_ATTACH_PRODUCT_FEATURE |
| Create entitlement feature | Creates a new feature entitlement in Stripe representing a monetizable ability or functionality. | STRIPE_CREATE_ENTITLEMENT_FEATURE |
| Delete product feature | Removes a feature from a product. | STRIPE_DELETE_PRODUCT_FEATURE |
| Update entitlement feature | Update a feature’s properties or deactivate it. | STRIPE_UPDATE_ENTITLEMENT_FEATURE |
Files (1)
Files (1)
| Action | What it does | Slug |
|---|---|---|
| Create file | Upload a file to Stripe for business purposes such as dispute evidence, identity verification, or business logos. | STRIPE_CREATE_FILE |
Invoices (20)
Invoices (20)
| Action | What it does | Slug |
|---|---|---|
| Add invoice lines | Add multiple line items to a draft Stripe invoice. | STRIPE_ADD_INVOICE_LINES |
| Create invoice | Creates a new draft Stripe invoice for a customer. | STRIPE_CREATE_INVOICE |
| Create invoice item | Create an invoice item for draft invoices. | STRIPE_CREATE_INVOICE_ITEM |
| Delete invoice | Permanently deletes a draft invoice. | STRIPE_DELETE_INVOICE |
| Delete invoiceitem | Delete an invoice item from Stripe. | STRIPE_DELETE_INVOICEITEM |
| Delete invoices void an invoice | Void a finalized Stripe invoice. | STRIPE_DELETE_V1_INVOICES_VOID_AN_INVOICE |
| Finalize invoice | Finalize a draft invoice so it becomes open/collectable (and immutable where required). | STRIPE_FINALIZE_INVOICE |
| Mark invoice uncollectible | Mark a Stripe invoice as uncollectible for bad debt accounting purposes. | STRIPE_MARK_INVOICE_UNCOLLECTIBLE |
| Pay invoice | Pay an invoice manually outside the normal collection schedule. | STRIPE_PAY_INVOICE |
| Post invoice void | Voids a finalized invoice and maintains a papertrail. | STRIPE_POST_INVOICES_INVOICE_VOID |
| Post invoices finalize void an invoice | Voids a finalized invoice and maintains a papertrail. | STRIPE_POST_V1_INVOICES_FINALIZE_VOID_AN_INVOICE |
| Post invoices lines overview | Updates an invoice’s line item before finalization. | STRIPE_POST_V1_INVOICES_LINES_OVERVIEW |
| Post invoices remove lines overview | Remove multiple line items from a draft Stripe invoice. | STRIPE_POST_V1_INVOICES_REMOVE_LINES_OVERVIEW |
| Post invoices send void an invoice | Void a finalized Stripe invoice. | STRIPE_POST_V1_INVOICES_SEND_VOID_AN_INVOICE |
| Post invoices void an invoice | Permanently void a finalized Stripe invoice. | STRIPE_POST_V1_INVOICES_VOID_AN_INVOICE |
| Send invoice | Manually send a finalized Stripe invoice to the customer outside the automatic billing schedule. | STRIPE_SEND_INVOICE |
| Update invoice | Updates a draft Stripe invoice. | STRIPE_UPDATE_INVOICE |
| Update invoice lines | Bulk update multiple line items on a draft invoice. | STRIPE_UPDATE_INVOICE_LINES |
| Update invoiceitem | Updates an invoice item on a draft invoice. | STRIPE_UPDATE_INVOICEITEM |
| Void invoice | Void a finalized Stripe invoice. | STRIPE_VOID_INVOICE |
Keys (2)
Keys (2)
| Action | What it does | Slug |
|---|---|---|
| Create ephemeral key | Create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources. | STRIPE_CREATE_EPHEMERAL_KEY |
| Delete ephemeral key | Immediately invalidate an ephemeral key. | STRIPE_DELETE_EPHEMERAL_KEY |
Line items (3)
Line items (3)
| Action | What it does | Slug |
|---|---|---|
| Create subscription item | Add a new item to an existing subscription without changing existing items. | STRIPE_CREATE_SUBSCRIPTION_ITEM |
| Delete subscription item | Deletes a subscription item without canceling the subscription. | STRIPE_DELETE_SUBSCRIPTION_ITEM |
| Post subscription item | Update a subscription item’s plan, quantity, billing thresholds, discounts, or metadata. | STRIPE_POST_SUBSCRIPTION_ITEMS_ITEM |
Links (3)
Links (3)
| Action | What it does | Slug |
|---|---|---|
| Create file link | Create a file link object that generates a shareable URL for accessing uploaded files. | STRIPE_CREATE_FILE_LINK |
| Create terminal onboarding link | Creates an onboarding link for Tap to Pay on iPhone. | STRIPE_CREATE_TERMINAL_ONBOARDING_LINK |
| Post file link | Update an existing file link in Stripe. | STRIPE_POST_FILE_LINKS_LINK |
Locations (3)
Locations (3)
| Action | What it does | Slug |
|---|---|---|
| Create terminal location | Creates a new Terminal Location for managing Stripe Terminal readers. | STRIPE_CREATE_TERMINAL_LOCATION |
| Delete terminal location | Permanently delete a Terminal Location object from your Stripe account. | STRIPE_DELETE_TERMINAL_LOCATION |
| Update terminal location | Updates a Terminal Location by modifying specified parameters. | STRIPE_UPDATE_TERMINAL_LOCATION |
Meters (4)
Meters (4)
| Action | What it does | Slug |
|---|---|---|
| Create billing meter | Create a billing meter in Stripe for tracking usage events. | STRIPE_CREATE_BILLING_METER |
| Deactivate billing meter | Deactivates a billing meter. | STRIPE_DEACTIVATE_BILLING_METER |
| Reactivate billing meter | Reactivates a deactivated billing meter. | STRIPE_REACTIVATE_BILLING_METER |
| Update billing meter | Update a billing meter’s display name. | STRIPE_UPDATE_BILLING_METER |
Payment intents (9)
Payment intents (9)
| Action | What it does | Slug |
|---|---|---|
| Cancel payment intent | Cancels a PaymentIntent when in cancelable state. | STRIPE_CANCEL_PAYMENT_INTENT |
| Capture payment intent | Captures the funds of an existing uncaptured PaymentIntent. | STRIPE_CAPTURE_PAYMENT_INTENT |
| Confirm payment intent | Confirm customer intent to pay with current or provided payment method. | STRIPE_CONFIRM_PAYMENT_INTENT |
| Confirm terminal reader payment intent | Confirm a PaymentIntent on a Terminal reader device. | STRIPE_CONFIRM_TERMINAL_READER_PAYMENT_INTENT |
| Create payment intent | Creates a Stripe PaymentIntent to initiate and process a customer’s payment. | STRIPE_CREATE_PAYMENT_INTENT |
| Post setup intent | Updates a SetupIntent object to modify configuration parameters and metadata. | STRIPE_POST_SETUP_INTENTS_INTENT |
| Post terminal reader process payment intent | Initiates a payment flow on a Stripe Terminal Reader to process a PaymentIntent. | STRIPE_POST_TERMINAL_READERS_READER_PROCESS_PAYMENT_INTENT |
| Update payment intent | Updates a Stripe PaymentIntent with new values for specified parameters. | STRIPE_UPDATE_PAYMENT_INTENT |
| Verify microdeposits payment intent | Verifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. | STRIPE_VERIFY_MICRODEPOSITS_PAYMENT_INTENT |
Payment links (2)
Payment links (2)
| Action | What it does | Slug |
|---|---|---|
| Create payment link | Create a Stripe Payment Link. | STRIPE_CREATE_PAYMENT_LINK |
| Update payment link | Updates an existing payment link with new configuration details. | STRIPE_UPDATE_PAYMENT_LINK |
Payment methods (8)
Payment methods (8)
| Action | What it does | Slug |
|---|---|---|
| Attach payment method | Attaches a PaymentMethod to a Customer. | STRIPE_ATTACH_PAYMENT_METHOD |
| Collect terminal reader payment method | Initiate payment method collection on a Stripe Terminal Reader. | STRIPE_COLLECT_TERMINAL_READER_PAYMENT_METHOD |
| Create payment method | Creates a PaymentMethod object representing a customer’s payment instrument (card, bank account, etc.). | STRIPE_CREATE_PAYMENT_METHOD |
| Detach payment method | Detaches a PaymentMethod object from a Customer account. | STRIPE_DETACH_PAYMENT_METHOD |
| Post payment method configs list payment method2 | Updates a payment method configuration to control which payment methods are displayed at checkout. | STRIPE_POST_V1_PAYMENT_METHOD_CONFIGS_LIST_PAYMENT_METHOD2 |
| Post payment method domains payment method | Updates an existing payment method domain to enable or disable it. | STRIPE_POST_V1_PAYMENT_METHOD_DOMAINS_PAYMENT_METHOD |
| Present payment method | Present a payment method on a simulated terminal reader for testing purposes. | STRIPE_PRESENT_PAYMENT_METHOD |
| Update payment method | Updates an existing PaymentMethod object in Stripe. | STRIPE_UPDATE_PAYMENT_METHOD |
Payments (5)
Payments (5)
| Action | What it does | Slug |
|---|---|---|
| Attach invoice payment | Attaches a PaymentIntent or Out of Band Payment to an invoice’s payments list. | STRIPE_ATTACH_INVOICE_PAYMENT |
| Create accounts capabilities card payments | Create or update card payments capability for a Stripe Connect account. | STRIPE_CREATE_ACCOUNTS_CAPABILITIES_CARD_PAYMENTS |
| Detach payment from invoice | Detach a payment from an invoice. | STRIPE_DETACH_PAYMENT_FROM_INVOICE |
| Post payment records report payment | Report a payment record in terminal state or for initialization. | STRIPE_POST_PAYMENT_RECORDS_REPORT_PAYMENT |
| Report payment attempt failed | Reports that a recent payment attempt on a Payment Record has failed. | STRIPE_REPORT_PAYMENT_ATTEMPT_FAILED |
Payouts (1)
Payouts (1)
| Action | What it does | Slug |
|---|---|---|
| Post payouts retrieve a payout | Updates a payout’s metadata and returns the updated payout object. | STRIPE_POST_V1_PAYOUTS_RETRIEVE_A_PAYOUT |
Plans (3)
Plans (3)
| Action | What it does | Slug |
|---|---|---|
| Create plan | Create a recurring billing plan with flexible pricing configuration. | STRIPE_CREATE_PLAN |
| Delete plan | Delete a plan from Stripe. | STRIPE_DELETE_PLAN |
| Post plans overview | Update a Stripe plan by setting passed parameter values. | STRIPE_POST_V1_PLANS_OVERVIEW |
Prices (2)
Prices (2)
| Action | What it does | Slug |
|---|---|---|
| Create price | Creates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme. | STRIPE_CREATE_PRICE |
| Update price | Updates a Stripe price by setting passed parameter values. | STRIPE_UPDATE_PRICE |
Products (3)
Products (3)
| Action | What it does | Slug |
|---|---|---|
| Create product | Creates a new product in Stripe, encoding the request as application/x-www-form-urlencoded by flattening nested structures. | STRIPE_CREATE_PRODUCT |
| Delete product | Delete a product. | STRIPE_DELETE_PRODUCT |
| Update product | Update an existing product in Stripe. | STRIPE_UPDATE_PRODUCT |
Quotes (6)
Quotes (6)
| Action | What it does | Slug |
|---|---|---|
| Accept quote | Accept a quote in Stripe. | STRIPE_ACCEPT_QUOTE |
| Cancel quote | Cancel a Stripe quote. | STRIPE_CANCEL_QUOTE |
| Create fx quote | Create an FX quote for currency conversion with optional rate locking. | STRIPE_CREATE_FX_QUOTE |
| Create quote | Create a Stripe quote modeling prices and services for a customer. | STRIPE_CREATE_QUOTE |
| Finalize quote | Finalize a quote in Stripe. | STRIPE_FINALIZE_QUOTE |
| Update quote | Update an existing Stripe quote with new values. | STRIPE_UPDATE_QUOTE |
Records (1)
Records (1)
| Action | What it does | Slug |
|---|---|---|
| Create usage record | Creates a usage record for a specified subscription item and timestamp. | STRIPE_CREATE_USAGE_RECORD |
Refunds (5)
Refunds (5)
| Action | What it does | Slug |
|---|---|---|
| Create charge refund | Create a refund for a charge in Stripe. | STRIPE_CREATE_CHARGE_REFUND |
| Create refund | Creates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID. | STRIPE_CREATE_REFUND |
| Post payment records report refund overview | Reports that the most recent payment attempt on a Payment Record was refunded. | STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_REFUND_OVERVIEW |
| Update application fee refund | STRIPE_UPDATE_APPLICATION_FEE_REFUND | |
| Update charge refund | Update a specified refund within a charge. | STRIPE_UPDATE_CHARGE_REFUND |
Releases (1)
Releases (1)
| Action | What it does | Slug |
|---|---|---|
| Post subscription schedules release overview | Release a subscription schedule. | STRIPE_POST_V1_SUBSCRIPTION_SCHEDULES_RELEASE_OVERVIEW |
Reports (4)
Reports (4)
| Action | What it does | Slug |
|---|---|---|
| Post payment records report attempt | Report a payment attempt on a Stripe Payment Record. | STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_ATTEMPT |
| Post payment records report canceled | Report that the most recent payment attempt was canceled. | STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_CANCELED |
| Post payment records report guaranteed | Reports that a payment attempt was guaranteed for a specific Payment Record. | STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_GUARANTEED |
| Post payment records report info | Report additional payment attempt information for a payment record. | STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_INFO |
Runs (1)
Runs (1)
| Action | What it does | Slug |
|---|---|---|
| Create report run | Creates a new report run object and begins executing the report asynchronously. | STRIPE_CREATE_REPORT_RUN |
Schedules (4)
Schedules (4)
| Action | What it does | Slug |
|---|---|---|
| Cancel subscription schedule | Cancels a subscription schedule and its associated subscription immediately (if active). | STRIPE_CANCEL_SUBSCRIPTION_SCHEDULE |
| Create subscription schedule | Create a new subscription schedule for managing subscription changes over time. | STRIPE_CREATE_SUBSCRIPTION_SCHEDULE |
| Post subscription schedules overview2 | Update an existing subscription schedule with new phases, settings, metadata, and end behavior. | STRIPE_POST_V1_SUBSCRIPTION_SCHEDULES_OVERVIEW2 |
| Update subscription schedule | Update an existing subscription schedule in Stripe. | STRIPE_UPDATE_SUBSCRIPTION_SCHEDULE |
Secrets (2)
Secrets (2)
| Action | What it does | Slug |
|---|---|---|
| Create apps secret | Create a secret in the Stripe Secret Store. | STRIPE_CREATE_APPS_SECRET |
| Delete apps secret | Delete a secret from the Stripe Secret Store by name and scope. | STRIPE_DELETE_APPS_SECRET |
Sessions (5)
Sessions (5)
| Action | What it does | Slug |
|---|---|---|
| Create account session | STRIPE_CREATE_ACCOUNT_SESSION | |
| Create billing meter event session | Creates authentication session for high-throughput meter event stream. | STRIPE_CREATE_BILLING_METER_EVENT_SESSION |
| Create billing portal session | Create a Stripe billing portal session. | STRIPE_CREATE_BILLING_PORTAL_SESSION |
| Create customer session | Create a Stripe Customer Session granting client-side access control over a Customer. | STRIPE_CREATE_CUSTOMER_SESSION |
| Create financial connections session | Create a Financial Connections Session to launch the authorization flow for linking financial accounts. | STRIPE_CREATE_FINANCIAL_CONNECTIONS_SESSION |
Settings (9)
Settings (9)
| Action | What it does | Slug |
|---|---|---|
| Create billing portal configuration | Create a Stripe billing portal configuration. | STRIPE_CREATE_BILLING_PORTAL_CONFIGURATION |
| Create payment method configuration | Creates a payment method configuration to control which payment methods are displayed during checkout. | STRIPE_CREATE_PAYMENT_METHOD_CONFIGURATION |
| Create terminal configuration | Creates a new Configuration object for Stripe payment terminals with customizable settings. | STRIPE_CREATE_TERMINAL_CONFIGURATION |
| Delete terminal configuration | Permanently deletes a Terminal Configuration object from your Stripe account. | STRIPE_DELETE_TERMINAL_CONFIGURATION |
| Post balance settings overview | Update balance settings for a Stripe account. | STRIPE_POST_V1_BALANCE_SETTINGS_OVERVIEW |
| Post billing portal configs overview billing | Update an existing billing portal configuration in Stripe. | STRIPE_POST_V1_BILLING_PORTAL_CONFIGS_OVERVIEW_BILLING |
| Post terminal configuration | Update a Stripe Terminal Configuration. | STRIPE_POST_TERMINAL_CONFIGURATIONS_CONFIGURATION |
| Update billing portal configuration | Update a billing portal configuration. | STRIPE_UPDATE_BILLING_PORTAL_CONFIGURATION |
| Update tax settings | Updates Stripe Tax Settings parameters used in tax calculations. | STRIPE_UPDATE_TAX_SETTINGS |
Setup intents (4)
Setup intents (4)
| Action | What it does | Slug |
|---|---|---|
| Cancel setup intent | Cancels a SetupIntent that is no longer needed. | STRIPE_CANCEL_SETUP_INTENT |
| Confirm setup intent | Confirms a SetupIntent to complete customer payment method setup. | STRIPE_CONFIRM_SETUP_INTENT |
| Create setup intent | Creates a SetupIntent object to collect payment method permissions for future payments. | STRIPE_CREATE_SETUP_INTENT |
| Process setup intent | Initiates a SetupIntent flow on a Stripe Terminal Reader to save payment details. | STRIPE_PROCESS_SETUP_INTENT |
Subscriptions (11)
Subscriptions (11)
| Action | What it does | Slug |
|---|---|---|
| Cancel subscription | Cancels a customer’s active Stripe subscription at the end of the current billing period, with options to invoice immediately for metered usage and prorate charges for unused time. | STRIPE_CANCEL_SUBSCRIPTION |
| Create customer subscription | Create a subscription for an existing customer. | STRIPE_CREATE_CUSTOMER_SUBSCRIPTION |
| Create subscription | Creates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options. | STRIPE_CREATE_SUBSCRIPTION |
| Delete customer subscription | Cancels a customer’s subscription immediately. | STRIPE_DELETE_CUSTOMER_SUBSCRIPTION |
| Deletev1 subscriptions list subscriptions | Cancel a Stripe subscription immediately. | STRIPE_DELETEV1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONS |
| Migrate subscription | Migrate a subscription from classic to flexible billing mode. | STRIPE_MIGRATE_SUBSCRIPTION |
| Post subscription exposed ID | Update an existing Stripe subscription with specified parameters. | STRIPE_POST_SUBSCRIPTIONS_SUBSCRIPTION_EXPOSED_ID |
| Post subscriptions list subscriptions | Updates an existing Stripe subscription’s properties including metadata, description, payment method, billing settings, trial periods, and cancellation behavior. | STRIPE_POST_V1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONS |
| Resume subscription | Resumes a paused Stripe subscription with billing cycle and proration options. | STRIPE_RESUME_SUBSCRIPTION |
| Update customer subscription | Update a subscription on a customer in Stripe. | STRIPE_UPDATE_CUSTOMER_SUBSCRIPTION |
| Update subscription | Updates an existing, non-canceled Stripe subscription by its ID, ensuring all referenced entity IDs (e.g., prices, coupons) are valid and automatic tax liability is correctly specified if enabled. | STRIPE_UPDATE_SUBSCRIPTION |
Tax rates (2)
Tax rates (2)
| Action | What it does | Slug |
|---|---|---|
| Create tax rate | Create a new tax rate in Stripe. | STRIPE_CREATE_TAX_RATE |
| Post tax rate2 | Update an existing Stripe tax rate. | STRIPE_POST_V1_TAX_RATES_TAX_RATE2 |
Taxes (7)
Taxes (7)
| Action | What it does | Slug |
|---|---|---|
| Create customer tax ID | Creates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats. | STRIPE_CREATE_CUSTOMER_TAX_ID |
| Create tax calculation | Creates a Tax Calculation to compute taxes for customer purchases. | STRIPE_CREATE_TAX_CALCULATION |
| Create tax ID | Creates a new tax ID for an account or customer. | STRIPE_CREATE_TAX_ID |
| Create tax registration | Creates a new Tax Registration object to enable tax collection in specified jurisdictions. | STRIPE_CREATE_TAX_REGISTRATION |
| Delete customer tax ID | Deletes a customer’s tax ID object. | STRIPE_DELETE_CUSTOMER_TAX_ID |
| Delete tax ID | Deletes an existing tax ID object. | STRIPE_DELETE_TAX_ID |
| Update tax registration | Update an existing tax registration in Stripe. | STRIPE_UPDATE_TAX_REGISTRATION |
Tokens (6)
Tokens (6)
| Action | What it does | Slug |
|---|---|---|
| Create bank account token | Create a single-use token representing bank account details. | STRIPE_CREATE_BANK_ACCOUNT_TOKEN |
| Create cvc update token | Creates a single-use token representing an updated CVC value for card payments. | STRIPE_CREATE_CVC_UPDATE_TOKEN |
| Create pii token | Create a single-use token representing PII (personally identifiable information). | STRIPE_CREATE_PII_TOKEN |
| Create terminal connection token | Creates a short-lived connection token for Stripe Terminal SDK to connect to readers. | STRIPE_CREATE_TERMINAL_CONNECTION_TOKEN |
| Create test confirmation token | Creates a test mode Confirmation Token for server-side payment integration testing. | STRIPE_CREATE_TEST_CONFIRMATION_TOKEN |
| Create token | Create a single-use CVC update token for card re-collection. | STRIPE_CREATE_TOKEN |
Transactions (3)
Transactions (3)
| Action | What it does | Slug |
|---|---|---|
| Create customer balance transaction | Create an immutable transaction that updates the customer’s credit balance. | STRIPE_CREATE_CUSTOMER_BALANCE_TRANSACTION |
| Create reversal tax transaction | Creates a reversal of an existing tax transaction. | STRIPE_CREATE_REVERSAL_TAX_TRANSACTION |
| Create tax transaction from calculation | Create a Tax Transaction from a calculation before 90-day expiration. | STRIPE_CREATE_TAX_TRANSACTION_FROM_CALCULATION |
Transfers (1)
Transfers (1)
| Action | What it does | Slug |
|---|---|---|
| Create transfer | STRIPE_CREATE_TRANSFER |
Other actions (8)
Other actions (8)
| Action | What it does | Slug |
|---|---|---|
| Advance test clock | Advance a test clock to a future timestamp. | STRIPE_ADVANCE_TEST_CLOCK |
| Create shipping rate | Creates a new shipping rate object that appears on Checkout Sessions for customer display. | STRIPE_CREATE_SHIPPING_RATE |
| Create source | Create a Stripe source object for accepting payment methods. | STRIPE_CREATE_SOURCE |
| Create test clock | Create a test clock for testing time-based scenarios in Stripe. | STRIPE_CREATE_TEST_CLOCK |
| Delete test clock | Permanently deletes a test clock from Stripe’s test environment. | STRIPE_DELETE_TEST_CLOCK |
| Post shipping rates overview2 | Update an existing Stripe shipping rate. | STRIPE_POST_V1_SHIPPING_RATES_OVERVIEW2 |
| Update source | Updates a Stripe source with specified parameters. | STRIPE_UPDATE_SOURCE |
| Verify microdeposits | Verifies microdeposits on a SetupIntent object to confirm bank account ownership. | STRIPE_VERIFY_MICRODEPOSITS |
Connect Stripe
Before you start:- You need a Stripe account that you can sign in to.
- Your Squad subscription must be active. Squad does not connect apps while the subscription is not active.
Open Integrations
Add an integration
Find Stripe
Choose an access level
Click Connect Stripe
Sign in to Stripe
Change the access level
- Under YOUR CONNECTIONS, find the Stripe account.
- Open the account menu (⋯) and click Manage scope.
- Under Default scope, choose the new level.
- Click Save access.
Set access for one agent
Every agent uses the account’s level unless you set something else for it. You can narrow one agent to a lower level, or block it.- Under YOUR CONNECTIONS, open the account menu (⋯) on the Stripe account.
- Click Manage scope.
- Under Per-agent access, find the agent.
- Choose the Default option to follow the account’s level, choose a lower level, or choose No access.
- Click Save access.
Use more than one Stripe account
Click + Account on the Stripe card to connect another account. Agents use the primary account unless they are asked to use a specific one.- After you click + Account, follow the connect steps above.
- Each account has its own access level.
- The first account you connect becomes the primary account. It shows ★ PRIMARY.
- To change the primary account, open the account menu (⋯) and click Make primary.
- To tell accounts apart, open the account menu (⋯) and click Rename.
Reconnect or disconnect
Reconnect when the connection has expired, or when you need to change what the account can reach on the Stripe side:- Open the account menu (⋯) and click Reconnect.
- Click Reauthorize on Stripe.
- Sign in to Stripe and approve the request.
Costs
Stripe actions do not use Squad credits. Connected apps never use credits. For what does use credits, see What Squad costs.Troubleshooting
An agent reports that an action is not allowed on this account.- Cause: the action is outside the account’s access level, or outside the level you set for that agent.
- Fix: choose a higher level in Manage scope, or change the agent’s row under Per-agent access.
- Cause: the agent is set to No access under Per-agent access, or the account is not connected.
- Fix: open Manage scope and change the agent’s row. If the account is missing, connect it again.
- Cause: your Squad subscription is not active.
- Fix: resubscribe. See Manage your subscription.
- Cause: the sign-in for that account is no longer valid.
- Fix: use Reconnect on the account.
Common questions
Can I limit what agents can do in Stripe?
Can I limit what agents can do in Stripe?
Can I connect more than one Stripe account?
Can I connect more than one Stripe account?
How do I disconnect Stripe?
How do I disconnect Stripe?