# Stripe on boxd

> Stripe offers online payment infrastructure, fraud prevention, and APIs enabling businesses to accept and manage payments globally.

- Page: https://boxd.sh/integrations/stripe/
- CLI: `run stripe` (432 commands, 91 marked common)
- SDK: `import { stripe } from "@boxd/run"`; every parameter and response type is at `@boxd/run/stripe`
- Triggers: 7
- Connect: `run auth stripe` (Sign in with Stripe), or https://app.boxd.sh/integrations/detail/stripe
- All integrations: https://boxd.sh/integrations/ (Markdown: https://boxd.sh/integrations/index.md)

## From the shell

```sh
run auth stripe      # once: prints a link to connect your account
run stripe           # list its commands
run stripe list-refunds
```

Parameters are flags (`--flag value`); object and array parameters take a JSON string. Output is YAML, or JSON with `--json`. Calls use your own connection; `--scope <name>` uses a connection shared with your team.

## From a script

```ts
import { stripe } from "@boxd/run";

const result = await stripe.listRefunds({});
console.log(result);

stripe.on("product-created", async (event) => {
  // Product Created Trigger: runs on this machine, once per event
  console.log(event);
});
```

Run it with `run stripe.run.ts`. A script that calls `.on()` keeps running as a job and handles each event.

## Commands

Required flags are listed; `run stripe <command> --help` lists the optional ones. "common" marks what `run stripe` shows without `--all`.

| Command | SDK method | Required flags | Optional | Description |
|---|---|---|---|---|
| `accept-quote` | `stripe.acceptQuote()` | `--quote-id` | 0 | Accept a quote in Stripe |
| `activate-billing-alert` | `stripe.activateBillingAlert()` | `--alert-id` | 0 | Reactivates a billing alert, allowing it to trigger again |
| `add-invoice-lines` ·common | `stripe.addInvoiceLines()` | `--id` `--lines` | 1 | Add multiple line items to a draft Stripe invoice |
| `advance-test-clock` | `stripe.advanceTestClock()` | `--clock-id` `--frozen-time` | 0 | Advance a test clock to a future timestamp |
| `apply-customer-balance` | `stripe.applyCustomerBalance()` | `--intent` | 2 | Manually reconciles remaining amount for a customer_balance PaymentIntent by applying funds from customer's cash balance |
| `archive-billing-alert` | `stripe.archiveBillingAlert()` | `--alert-id` | 0 | Archive a billing alert in Stripe, removing it from list views and APIs |
| `attach-customer-source` | `stripe.attachCustomerSource()` | `--customer-id` `--source` | 1 | Attach a payment source (card token or source object) to a customer for future charges |
| `attach-invoice-payment` ·common | `stripe.attachInvoicePayment()` | `--invoice` | 2 | Attaches a PaymentIntent or Out of Band Payment to an invoice's payments list |
| `attach-payment-method` ·common | `stripe.attachPaymentMethod()` | `--payment-method-id` | 2 | Attaches a PaymentMethod to a Customer |
| `attach-product-feature` | `stripe.attachProductFeature()` | `--entitlement-feature` `--product-id` | 0 | Attach a feature to a product |
| `cancel-payment-intent` ·common | `stripe.cancelPaymentIntent()` | `--payment-intent-id` | 1 | Cancels a PaymentIntent when in cancelable state |
| `cancel-quote` | `stripe.cancelQuote()` | `--quote-id` | 0 | Cancel a Stripe quote |
| `cancel-setup-intent` | `stripe.cancelSetupIntent()` | `--setup-intent-id` | 1 | Cancels a SetupIntent that is no longer needed |
| `cancel-subscription` ·common | `stripe.cancelSubscription()` | `--subscription-id` | 3 | 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 |
| `cancel-subscription-schedule` | `stripe.cancelSubscriptionSchedule()` | `--schedule` | 2 | Cancels a subscription schedule and its associated subscription immediately (if active) |
| `cancel-terminal-reader-action` | `stripe.cancelTerminalReaderAction()` | `--reader-id` | 0 | Cancel the current reader action |
| `capture-charge` | `stripe.captureCharge()` | `--charge` | 7 | Capture payment on an uncaptured charge |
| `capture-payment-intent` ·common | `stripe.capturePaymentIntent()` | `--intent` | 6 | Captures the funds of an existing uncaptured PaymentIntent |
| `close-dispute` | `stripe.closeDispute()` | `--dispute` | 0 | Close a dispute |
| `collect-terminal-reader-inputs` | `stripe.collectTerminalReaderInputs()` | `--inputs` `--reader-id` | 1 | Initiates input collection on a Terminal Reader to display forms and collect customer information |
| `collect-terminal-reader-payment-method` | `stripe.collectTerminalReaderPaymentMethod()` | `--payment-intent` `--reader` | 1 | Initiate payment method collection on a Stripe Terminal Reader |
| `confirm-payment-intent` ·common | `stripe.confirmPaymentIntent()` | `--payment-intent-id` | 12 | Confirm customer intent to pay with current or provided payment method |
| `confirm-setup-intent` | `stripe.confirmSetupIntent()` | `--setup-intent-id` | 4 | Confirms a SetupIntent to complete customer payment method setup |
| `confirm-terminal-reader-payment-intent` | `stripe.confirmTerminalReaderPaymentIntent()` | `--payment-intent` `--reader-id` | 1 | Confirm a PaymentIntent on a Terminal reader device |
| `create-account-session` | `stripe.createAccountSession()` | `--account` `--components` | 1 | Creates an Account Session for a Stripe Connect account, granting access to embedded components |
| `create-accounts-capabilities-card-payments` | `stripe.createAccountsCapabilitiesCardPayments()` | `--id` | 1 | Create or update card payments capability for a Stripe Connect account |
| `create-apple-pay-domain` | `stripe.createApplePayDomain()` | `--domain-name` | 1 | Create an Apple Pay domain registration |
| `create-apps-secret` | `stripe.createAppsSecret()` | `--name` `--payload` `--scope-type` | 2 | Create a secret in the Stripe Secret Store |
| `create-bank-account-token` | `stripe.createBankAccountToken()` | `--bank-account` | 1 | Create a single-use token representing bank account details |
| `create-billing-alert` | `stripe.createBillingAlert()` | `--alert-type` `--title` `--usage-threshold` | 0 | Create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed |
| `create-billing-credit-grant` ·common | `stripe.createBillingCreditGrant()` | `--amount` `--applicability-config` | 8 | Create a credit grant that allocates billing credits to a customer for use against metered pricing |
| `create-billing-meter` ·common | `stripe.createBillingMeter()` | `--default-aggregation` `--display-name` `--event-name` | 3 | Create a billing meter in Stripe for tracking usage events |
| `create-billing-meter-event` ·common | `stripe.createBillingMeterEvent()` | `--event-name` `--payload` | 2 | Creates a billing meter event using Stripe API v2 for usage-based billing |
| `create-billing-meter-event-adjustment` | `stripe.createBillingMeterEventAdjustment()` | `--event-name` `--type` | 1 | Creates an adjustment to cancel a billing meter event |
| `create-billing-meter-event-session` | `stripe.createBillingMeterEventSession()` | — | 0 | Creates authentication session for high-throughput meter event stream |
| `create-billing-portal-configuration` | `stripe.createBillingPortalConfiguration()` | `--features` | 5 | Create a Stripe billing portal configuration |
| `create-billing-portal-session` | `stripe.createBillingPortalSession()` | — | 7 | Create a Stripe billing portal session |
| `create-charge` ·common | `stripe.createCharge()` | `--amount` `--currency` | 14 | Create a charge to request payment from a credit or debit card |
| `create-charge-refund` ·common | `stripe.createChargeRefund()` | `--charge` | 7 | Create a refund for a charge in Stripe |
| `create-checkout-session` ·common | `stripe.createCheckoutSession()` | `--line-items` `--mode` `--success-url` | 6 | Create a Stripe Checkout Session |
| `create-coupon` | `stripe.createCoupon()` | — | 12 | Creates a new discount coupon in Stripe with percentage or fixed amount discount |
| `create-credit-note` | `stripe.createCreditNote()` | `--invoice` | 12 | Issues a credit note to adjust a finalized invoice's amount |
| `create-customer` ·common | `stripe.createCustomer()` | — | 5 | Creates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications |
| `create-customer-balance-transaction` ·common | `stripe.createCustomerBalanceTransaction()` | `--amount` `--currency` `--customer` | 2 | Create an immutable transaction that updates the customer's credit balance |
| `create-customer-bank-account` | `stripe.createCustomerBankAccount()` | `--customer` `--source` | 1 | Create a new bank account attached to a customer object |
| `create-customer-card` ·common | `stripe.createCustomerCard()` | `--customer` | 6 | Creates a card or bank account payment source for a Stripe customer |
| `create-customer-session` | `stripe.createCustomerSession()` | `--components` | 2 | Create a Stripe Customer Session granting client-side access control over a Customer |
| `create-customer-source` ·common | `stripe.createCustomerSource()` | `--customer` `--source` | 1 | Attaches a payment source to a customer for later reuse |
| `create-customer-subscription` | `stripe.createCustomerSubscription()` | `--customer` | 25 | Create a subscription for an existing customer |
| `create-customer-tax-id` ·common | `stripe.createCustomerTaxId()` | `--customer` `--type` `--value` | 0 | Creates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats |
| `create-cvc-update-token` | `stripe.createCvcUpdateToken()` | `--cvc` | 0 | Creates a single-use token representing an updated CVC value for card payments |
| `create-entitlement-feature` | `stripe.createEntitlementFeature()` | `--lookup-key` `--name` | 1 | Creates a new feature entitlement in Stripe representing a monetizable ability or functionality |
| `create-ephemeral-key` | `stripe.createEphemeralKey()` | `--stripe-version` | 5 | Create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources |
| `create-file` | `stripe.createFile()` | `--file` `--purpose` | 1 | Upload a file to Stripe for business purposes such as dispute evidence, identity verification, or business logos |
| `create-file-link` | `stripe.createFileLink()` | `--file` | 2 | Create a file link object that generates a shareable URL for accessing uploaded files |
| `create-financial-connections-session` | `stripe.createFinancialConnectionsSession()` | `--account-holder` `--permissions` | 3 | Create a Financial Connections Session to launch the authorization flow for linking financial accounts |
| `create-fx-quote` | `stripe.createFxQuote()` | `--from-currencies` `--to-currency` | 5 | Create an FX quote for currency conversion with optional rate locking |
| `create-invoice` ·common | `stripe.createInvoice()` | `--customer` | 29 | Creates a new draft Stripe invoice for a customer; use to revise an existing invoice, bill for a specific subscription (which must belong to the customer), or apply detailed customizations |
| `create-invoice-item` | `stripe.createInvoiceItem()` | — | 18 | Create an invoice item for draft invoices |
| `create-payment-intent` | `stripe.createPaymentIntent()` | `--amount` `--currency` | 16 | Creates a Stripe PaymentIntent to initiate and process a customer's payment; using `application_fee_amount` for a connected account requires the `Stripe-Account` header |
| `create-payment-link` ·common | `stripe.createPaymentLink()` | `--line-items` | 20 | Create a Stripe Payment Link |
| `create-payment-method` ·common | `stripe.createPaymentMethod()` | `--type` | 12 | Creates a PaymentMethod object representing a customer's payment instrument (card, bank account, etc.) |
| `create-payment-method-configuration` | `stripe.createPaymentMethodConfiguration()` | — | 59 | Creates a payment method configuration to control which payment methods are displayed during checkout |
| `create-payment-method-domain` | `stripe.createPaymentMethodDomain()` | `--domain-name` | 1 | Create a payment method domain object to control where payment methods are shown |
| `create-pii-token` | `stripe.createPiiToken()` | `--pii` | 0 | Create a single-use token representing PII (personally identifiable information) |
| `create-plan` | `stripe.createPlan()` | `--currency` `--interval` | 15 | Create a recurring billing plan with flexible pricing configuration |
| `create-preview-invoice` | `stripe.createPreviewInvoice()` | — | 13 | Preview an upcoming invoice without creating it |
| `create-price` ·common | `stripe.createPrice()` | `--currency` | 17 | Creates a new Stripe Price for a product, defining its charges (one-time or recurring) and billing scheme; requires either an existing `product` ID or `product_data` |
| `create-product` ·common | `stripe.createProduct()` | `--name` | 15 | Creates a new product in Stripe, encoding the request as `application/x-www-form-urlencoded` by flattening nested structures |
| `create-promotion-code` | `stripe.createPromotionCode()` | `--coupon` | 7 | Create a promotion code linked to an underlying coupon |
| `create-quote` | `stripe.createQuote()` | — | 20 | Create a Stripe quote modeling prices and services for a customer |
| `create-refund` ·common | `stripe.createRefund()` | — | 7 | Creates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID |
| `create-report-run` | `stripe.createReportRun()` | `--report-type` | 1 | Creates a new report run object and begins executing the report asynchronously |
| `create-reversal-tax-transaction` ·common | `stripe.createReversalTaxTransaction()` | `--mode` `--original-transaction` `--reference` | 4 | Creates a reversal of an existing tax transaction |
| `create-setup-intent` | `stripe.createSetupIntent()` | — | 21 | Creates a SetupIntent object to collect payment method permissions for future payments |
| `create-shipping-rate` | `stripe.createShippingRate()` | `--display-name` `--fixed-amount` | 5 | Creates a new shipping rate object that appears on Checkout Sessions for customer display |
| `create-source` | `stripe.createSource()` | — | 13 | Create a Stripe source object for accepting payment methods |
| `create-subscription` ·common | `stripe.createSubscription()` | `--customer` `--items` | 31 | Creates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options |
| `create-subscription-item` ·common | `stripe.createSubscriptionItem()` | `--subscription` | 10 | Add a new item to an existing subscription without changing existing items |
| `create-subscription-schedule` | `stripe.createSubscriptionSchedule()` | — | 9 | Create a new subscription schedule for managing subscription changes over time |
| `create-tax-calculation` | `stripe.createTaxCalculation()` | `--currency` `--line-items` | 5 | Creates a Tax Calculation to compute taxes for customer purchases |
| `create-tax-id` | `stripe.createTaxId()` | `--type` `--value` | 1 | Creates a new tax ID for an account or customer |
| `create-tax-rate` | `stripe.createTaxRate()` | `--display-name` `--inclusive` `--percentage` | 7 | Create a new tax rate in Stripe |
| `create-tax-registration` | `stripe.createTaxRegistration()` | `--active-from` `--country` `--country-options` | 1 | Creates a new Tax Registration object to enable tax collection in specified jurisdictions |
| `create-tax-transaction-from-calculation` | `stripe.createTaxTransactionFromCalculation()` | `--calculation` `--reference` | 2 | Create a Tax Transaction from a calculation before 90-day expiration |
| `create-terminal-configuration` | `stripe.createTerminalConfiguration()` | — | 10 | Creates a new Configuration object for Stripe payment terminals with customizable settings |
| `create-terminal-connection-token` | `stripe.createTerminalConnectionToken()` | — | 1 | Creates a short-lived connection token for Stripe Terminal SDK to connect to readers |
| `create-terminal-location` | `stripe.createTerminalLocation()` | `--address` | 4 | Creates a new Terminal Location for managing Stripe Terminal readers |
| `create-terminal-onboarding-link` | `stripe.createTerminalOnboardingLink()` | `--link-options` `--link-type` | 2 | Creates an onboarding link for Tap to Pay on iPhone |
| `create-terminal-reader` | `stripe.createTerminalReader()` | `--location` `--registration-code` | 2 | Creates and registers a new Terminal Reader to a Stripe account at a specified location |
| `create-test-clock` | `stripe.createTestClock()` | `--frozen-time` | 1 | Create a test clock for testing time-based scenarios in Stripe |
| `create-test-confirmation-token` | `stripe.createTestConfirmationToken()` | — | 6 | Creates a test mode Confirmation Token for server-side payment integration testing |
| `create-token` | `stripe.createToken()` | `--cvc-update` | 0 | Create a single-use CVC update token for card re-collection |
| `create-transfer` | `stripe.createTransfer()` | `--currency` `--destination` | 7 | Creates a transfer to move funds between Stripe accounts as part of Connect |
| `create-usage-record` | `stripe.createUsageRecord()` | `--quantity` `--subscription-item` `--timestamp` | 1 | Creates a usage record for a specified subscription item and timestamp |
| `deactivate-billing-alert` | `stripe.deactivateBillingAlert()` | `--id` | 0 | Deactivate a billing alert, preventing it from triggering |
| `deactivate-billing-meter` ·common | `stripe.deactivateBillingMeter()` | `--id` | 0 | Deactivates a billing meter |
| `delete-apple-pay-domain` | `stripe.deleteApplePayDomain()` | `--domain` | 0 | Delete an Apple Pay domain from a Stripe account |
| `delete-apps-secret` | `stripe.deleteAppsSecret()` | `--name` `--scope-type` | 1 | Delete a secret from the Stripe Secret Store by name and scope |
| `delete-coupon` ·common | `stripe.deleteCoupon()` | `--coupon` | 0 | Delete a coupon from Stripe |
| `delete-customer` ·deprecated | `stripe.deleteCustomer()` | `--customer-id` | 0 | Use delete-customers-customer instead |
| `delete-customer-bank-account` ·common | `stripe.deleteCustomerBankAccount()` | `--customer` `--id` | 1 | Deletes a bank account payment source from a customer |
| `delete-customer-discount` ·common | `stripe.deleteCustomerDiscount()` | `--customer` | 0 | Removes the currently applied discount on a customer |
| `delete-customer-subscription` | `stripe.deleteCustomerSubscription()` | `--customer` `--subscription-exposed-id` | 2 | Cancels a customer's subscription immediately |
| `delete-customer-subscription-discount` ·common | `stripe.deleteCustomerSubscriptionDiscount()` | `--customer` `--subscription-exposed-id` | 0 | Removes currently applied discount from a customer's subscription |
| `delete-customer-tax-id` ·common | `stripe.deleteCustomerTaxId()` | `--customer` `--id` | 0 | Deletes a customer's tax ID object |
| `delete-customers-customer` ·common | `stripe.deleteCustomersCustomer()` | `--customer` | 0 | Permanently deletes a customer and cancels active subscriptions |
| `delete-ephemeral-key` | `stripe.deleteEphemeralKey()` | `--key` | 0 | Immediately invalidate an ephemeral key |
| `delete-invoice` ·common | `stripe.deleteInvoice()` | `--invoice` | 0 | Permanently deletes a draft invoice |
| `delete-invoiceitem` ·common | `stripe.deleteInvoiceitem()` | `--invoiceitem` | 0 | Delete an invoice item from Stripe |
| `delete-plan` ·common | `stripe.deletePlan()` | `--plan` | 0 | Delete a plan from Stripe |
| `delete-product` ·common | `stripe.deleteProduct()` | `--product-id` | 0 | Delete a product |
| `delete-product-feature` | `stripe.deleteProductFeature()` | `--id` `--product` | 0 | Removes a feature from a product |
| `delete-subscription-discount` | `stripe.deleteSubscriptionDiscount()` | `--subscription-id` | 0 | Removes the currently applied discount on a subscription |
| `delete-subscription-item` ·common | `stripe.deleteSubscriptionItem()` | `--item` | 3 | Deletes a subscription item without canceling the subscription |
| `delete-tax-id` | `stripe.deleteTaxId()` | `--id` | 0 | Deletes an existing tax ID object |
| `delete-terminal-configuration` | `stripe.deleteTerminalConfiguration()` | `--configuration` | 0 | Permanently deletes a Terminal Configuration object from your Stripe account |
| `delete-terminal-location` ·common | `stripe.deleteTerminalLocation()` | `--location` | 0 | Permanently delete a Terminal Location object from your Stripe account |
| `delete-terminal-reader` | `stripe.deleteTerminalReader()` | `--reader` | 0 | Permanently deletes a Terminal Reader object from your Stripe account |
| `delete-test-clock` | `stripe.deleteTestClock()` | `--test-clock` | 0 | Permanently deletes a test clock from Stripe's test environment |
| `delete-v1-invoices-void-invoice` | `stripe.deleteV1InvoicesVoidInvoice()` | `--invoice-id` | 0 | Void a finalized Stripe invoice |
| `deletev1-subscriptions-list-subscriptions` ·common | `stripe.deletev1SubscriptionsListSubscriptions()` | `--subscription-id` | 3 | Cancel a Stripe subscription immediately |
| `detach-payment-from-invoice` | `stripe.detachPaymentFromInvoice()` | `--id` | 2 | Detach a payment from an invoice |
| `detach-payment-method` ·common | `stripe.detachPaymentMethod()` | `--payment-method-id` | 0 | Detaches a PaymentMethod object from a Customer account |
| `disable-event-destination` | `stripe.disableEventDestination()` | `--event-destination-id` | 0 | Disables a v2 Event Destination, preventing it from receiving events |
| `download-quote-pdf` ·common | `stripe.downloadQuotePdf()` | `--quote` | 0 | Download the PDF for a finalized quote from Stripe |
| `expire-billing-credit-grant` | `stripe.expireBillingCreditGrant()` | `--id` | 0 | Expires a billing credit grant immediately |
| `expire-checkout-session` | `stripe.expireCheckoutSession()` | `--session-id` | 0 | Expire an active Stripe Checkout Session |
| `finalize-invoice` ·common | `stripe.finalizeInvoice()` | `--invoice-id` | 2 | Finalize a draft invoice so it becomes open/collectable (and immutable where required) |
| `finalize-quote` | `stripe.finalizeQuote()` | `--quote` | 2 | Finalize a quote in Stripe |
| `find-apps-secret` | `stripe.findAppsSecret()` | `--name` `--scope` | 0 | Find a secret by name and scope in the Stripe Apps secret store |
| `find-tax-association` | `stripe.findTaxAssociation()` | `--payment-intent` | 0 | Find a tax association by PaymentIntent ID |
| `fund-test-cash-balance` | `stripe.fundTestCashBalance()` | `--amount` `--currency` `--customer-id` | 1 | Fund a test mode cash balance for a customer |
| `get-account` | `stripe.getAccount()` | — | 1 | Retrieves detailed information for the authenticated Stripe account |
| `get-account-capabilities` | `stripe.getAccountCapabilities()` | `--account` | 0 | Retrieves a list of all capabilities for a connected Stripe account |
| `get-account-capability` | `stripe.getAccountCapability()` | `--account-id` `--capability-id` | 1 | Retrieves information about a specific capability for a Stripe account |
| `get-account-person` | `stripe.getAccountPerson()` | `--account` `--person` | 0 | Retrieves an existing person associated with a Stripe account |
| `get-account-persons` | `stripe.getAccountPersons()` | `--account` | 9 | Retrieves a list of people associated with the account's legal entity |
| `get-account-token` | `stripe.getAccountToken()` | `--token-id` | 1 | Retrieve a v2 Account Token by its ID |
| `get-accounts-account` | `stripe.getAccountsAccount()` | `--account` | 1 | Retrieves the details of a Stripe account |
| `get-active-entitlement` | `stripe.getActiveEntitlement()` | `--id` | 1 | Retrieve an active entitlement describing customer access to a feature |
| `get-apple-pay-domain` | `stripe.getApplePayDomain()` | `--domain` | 0 | Retrieves details about a previously registered Apple Pay domain |
| `get-balance-history` ·common ·deprecated | `stripe.getBalanceHistory()` | — | 8 | Use list-balance-transactions instead |
| `get-balance-settings` | `stripe.getBalanceSettings()` | — | 1 | Retrieve balance settings for a Stripe account |
| `get-balance-transaction` | `stripe.getBalanceTransaction()` | `--id` | 1 | Retrieves the balance transaction with the given ID |
| `get-billing-alert` | `stripe.getBillingAlert()` | `--id` | 0 | Retrieves a billing alert by its unique identifier |
| `get-billing-credit-balance-summary` | `stripe.getBillingCreditBalanceSummary()` | `--filter` | 2 | Retrieves the credit balance summary for a customer in Stripe Billing |
| `get-billing-credit-balance-transactions-id` | `stripe.getBillingCreditBalanceTransactionsId()` | `--id` | 0 | Retrieves a credit balance transaction by its unique identifier |
| `get-billing-credit-grants` | `stripe.getBillingCreditGrants()` | — | 5 | Retrieve a paginated list of billing credit grants |
| `get-billing-credit-grants-id` | `stripe.getBillingCreditGrantsId()` | `--id` | 0 | Retrieves a billing credit grant by its unique identifier |
| `get-billing-meters` | `stripe.getBillingMeters()` | — | 4 | Retrieve a list of billing meters from Stripe |
| `get-billing-meters-id` | `stripe.getBillingMetersId()` | `--id` | 0 | Retrieves a billing meter by its unique identifier |
| `get-billing-portal-configurations` | `stripe.getBillingPortalConfigurations()` | — | 5 | List billing portal configurations |
| `get-billing-portal-configurations-configuration` | `stripe.getBillingPortalConfigurationsConfiguration()` | `--configuration` | 0 | Retrieve a billing portal configuration from Stripe |
| `get-charges-charge-dispute` | `stripe.getChargesChargeDispute()` | `--charge` | 0 | Retrieve a dispute for a specified charge |
| `get-charges-charge-refunds-refund` ·common | `stripe.getChargesChargeRefundsRefund()` | `--charge` `--refund` | 1 | Retrieve the details of an existing refund within a specific charge |
| `get-checkout-sessions-session-line-items` ·common | `stripe.getCheckoutSessionsSessionLineItems()` | `--session` | 3 | Retrieve line items for a Checkout Session |
| `get-climate-products-product` | `stripe.getClimateProductsProduct()` | `--product` | 0 | Retrieve details of a specific Stripe Climate product |
| `get-climate-suppliers-supplier` | `stripe.getClimateSuppliersSupplier()` | `--supplier` | 0 | Retrieves detailed information about a specific Stripe Climate carbon removal supplier |
| `get-confirmation-tokens-confirmation-token` | `stripe.getConfirmationTokensConfirmationToken()` | `--confirmation-token` | 1 | Retrieve an existing ConfirmationToken object by its ID |
| `get-country-specs-country` | `stripe.getCountrySpecsCountry()` | `--country` | 0 | Retrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies |
| `get-coupon` | `stripe.getCoupon()` | `--coupon-id` | 0 | Retrieves full details for an existing Stripe coupon using its unique ID |
| `get-credit-notes-credit-note-lines` | `stripe.getCreditNotesCreditNoteLines()` | `--credit-note` | 3 | Retrieves the paginated list of line items for a specific credit note |
| `get-credit-notes-id` | `stripe.getCreditNotesId()` | `--id` | 1 | Retrieves a credit note by its unique identifier |
| `get-credit-notes-preview` | `stripe.getCreditNotesPreview()` | `--invoice` | 12 | Preview a credit note without creating it in Stripe |
| `get-credit-notes-preview-lines` | `stripe.getCreditNotesPreviewLines()` | `--invoice` | 15 | Retrieve a credit note preview's line items from Stripe |
| `get-customers-cash-balance-transactions` | `stripe.getCustomersCashBalanceTransactions()` | `--customer` `--transaction` | 1 | Retrieve a specific cash balance transaction that updated a customer's cash balance |
| `get-customers-customer-balance-transactions` | `stripe.getCustomersCustomerBalanceTransactions()` | `--customer` | 5 | List customer balance transactions that updated a customer's balance |
| `get-customers-customer-balance-txns-txn` | `stripe.getCustomersCustomerBalanceTxnsTxn()` | `--customer` `--transaction` | 0 | Retrieves a specific customer balance transaction that updated the customer's balances |
| `get-customers-customer-bank-accounts` | `stripe.getCustomersCustomerBankAccounts()` | `--customer-id` | 3 | Fetch all bank accounts linked to a customer |
| `get-customers-customer-bank-accounts-id` ·common | `stripe.getCustomersCustomerBankAccountsId()` | `--customer` `--id` | 1 | Retrieves details about a specific bank account stored on a Stripe customer |
| `get-customers-customer-cards` | `stripe.getCustomersCustomerCards()` | `--customer` | 3 | List all cards for a customer |
| `get-customers-customer-cards-id` | `stripe.getCustomersCustomerCardsId()` | `--customer` `--id` | 0 | Retrieves details about a specific card for a customer |
| `get-customers-customer-cash-balance` ·common | `stripe.getCustomersCustomerCashBalance()` | `--customer` | 1 | Retrieve a customer's cash balance |
| `get-customers-customer-cash-balance-transactions` | `stripe.getCustomersCustomerCashBalanceTransactions()` | `--customer-id` | 3 | Retrieve a list of cash balance transactions for a customer |
| `get-customers-customer-discount` | `stripe.getCustomersCustomerDiscount()` | `--customer` | 0 | Retrieve the discount currently active on a customer |
| `get-customers-customer-payment-methods` ·common | `stripe.getCustomersCustomerPaymentMethods()` | `--customer-id` | 5 | Retrieves a list of payment methods for a given customer, supporting type filtering and pagination |
| `get-customers-customer-payment-methods-payment-method` | `stripe.getCustomersCustomerPaymentMethodsPaymentMethod()` | `--customer` `--payment-method` | 1 | Retrieve a specific PaymentMethod object for a given Customer |
| `get-customers-customer-sources` | `stripe.getCustomersCustomerSources()` | `--customer` | 3 | List sources for a specified customer |
| `get-customers-customer-sources-id` | `stripe.getCustomersCustomerSourcesId()` | `--customer` `--id` | 1 | Retrieve a specified payment source for a given customer |
| `get-customers-customer-subs-sub-exposed-id` | `stripe.getCustomersCustomerSubsSubExposedId()` | `--customer` `--subscription-exposed-id` | 0 | Retrieve a specific subscription for a customer |
| `get-customers-customer-subs-sub-exposed-id-discount` ·common | `stripe.getCustomersCustomerSubsSubExposedIdDiscount()` | `--customer` `--subscription-exposed-id` | 1 | Retrieve the discount currently applied to a customer's subscription |
| `get-customers-customer-subscriptions` ·deprecated | `stripe.getCustomersCustomerSubscriptions()` | `--customer` | 4 | Use list-subscriptions instead |
| `get-customers-customer-tax-ids` | `stripe.getCustomersCustomerTaxIds()` | `--customer` | 3 | Retrieve all tax IDs for a specific Stripe customer |
| `get-customers-customer-tax-ids-id` | `stripe.getCustomersCustomerTaxIdsId()` | `--customer` `--id` | 0 | Retrieve a specific tax ID for a customer |
| `get-entitlements-active-entitlements` | `stripe.getEntitlementsActiveEntitlements()` | `--customer` | 3 | Retrieve active entitlements for a customer |
| `get-entitlements-features-id` | `stripe.getEntitlementsFeaturesId()` | `--id` | 0 | Retrieve a feature by ID from Stripe |
| `get-events` | `stripe.getEvents()` | — | 7 | Retrieves a list of Stripe events from the past 30 days with filtering and pagination |
| `get-events-id` | `stripe.getEventsId()` | `--id` | 0 | Retrieves event details for events created within the last 30 days |
| `get-file-links-link` | `stripe.getFileLinksLink()` | `--file-link-id` | 1 | Retrieves the details of an existing file link |
| `get-files-file` | `stripe.getFilesFile()` | `--file` | 0 | Retrieve details of an existing file object by its unique identifier |
| `get-financial-connections-sessions-session` | `stripe.getFinancialConnectionsSessionsSession()` | `--session` | 0 | Retrieves the details of a Financial Connections Session |
| `get-fx-quote` | `stripe.getFxQuote()` | `--id` | 1 | Retrieve a specific FX (foreign exchange) Quote by its ID |
| `get-invoice-payments-id` | `stripe.getInvoicePaymentsId()` | `--id` | 0 | Retrieve details of a specific Stripe invoice payment by ID |
| `get-invoiceitems-invoiceitem` | `stripe.getInvoiceitemsInvoiceitem()` | `--invoiceitem` | 1 | Retrieve the details of an invoice item using its unique identifier |
| `get-invoices-invoice` ·common | `stripe.getInvoicesInvoice()` | `--invoice` | 1 | Retrieve a specific invoice by ID |
| `get-invoices-invoice-lines` ·common | `stripe.getInvoicesInvoiceLines()` | `--invoice` | 3 | Retrieve a paginated list of line items for a specific invoice |
| `get-linked-account` | `stripe.getLinkedAccount()` | `--account` | 1 | Retrieves the details of a Linked Account object by its unique identifier |
| `get-mandate` | `stripe.getMandate()` | `--mandate-id` | 1 | Retrieve a Stripe mandate by ID |
| `get-payment-attempt-records-id` | `stripe.getPaymentAttemptRecordsId()` | `--id` | 1 | Retrieve a specific Payment Attempt Record by ID |
| `get-payment-intent-amount-details-line-items` | `stripe.getPaymentIntentAmountDetailsLineItems()` | `--payment-intent-id` | 3 | Retrieve paginated line items for a PaymentIntent |
| `get-payment-link` ·common | `stripe.getPaymentLink()` | `--payment-link-id` | 1 | Retrieve details of an existing Stripe payment link by ID |
| `get-payment-links-payment-link-line-items` | `stripe.getPaymentLinksPaymentLinkLineItems()` | `--payment-link` | 3 | Retrieve paginated line items for a payment link |
| `get-payment-method` | `stripe.getPaymentMethod()` | `--payment-method-id` | 1 | Retrieves the details of a PaymentMethod object by its unique identifier |
| `get-payment-method-configuration` ·common | `stripe.getPaymentMethodConfiguration()` | `--id` | 0 | Retrieve a specific payment method configuration by its unique identifier |
| `get-payment-method-domain` | `stripe.getPaymentMethodDomain()` | `--payment-method-domain` | 0 | Retrieves details of an existing payment method domain |
| `get-payment-record` | `stripe.getPaymentRecord()` | `--id` | 1 | Retrieve a Payment Record from Stripe |
| `get-payout` | `stripe.getPayout()` | `--payout-id` | 0 | Retrieve details of an existing Stripe payout |
| `get-plan` | `stripe.getPlan()` | `--plan-id` | 0 | Retrieve a specific Stripe plan by its unique identifier |
| `get-prices-price` ·common | `stripe.getPricesPrice()` | `--price` | 0 | Retrieves detailed information for a specific Stripe price using its unique ID |
| `get-products-id` ·common | `stripe.getProductsId()` | `--id` | 1 | Retrieves detailed information for an existing Stripe product using its unique product ID |
| `get-products-product-features-id` ·common | `stripe.getProductsProductFeaturesId()` | `--id` `--product` | 0 | Retrieves a specific product feature by its ID |
| `get-promotion-codes` | `stripe.getPromotionCodes()` | — | 9 | Retrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions |
| `get-quotes-quote` | `stripe.getQuotesQuote()` | `--quote` | 1 | Retrieve a quote by ID |
| `get-quotes-quote-computed-upfront-line-items` | `stripe.getQuotesQuoteComputedUpfrontLineItems()` | `--quote` | 3 | Retrieve computed upfront line items for a quote |
| `get-quotes-quote-line-items` | `stripe.getQuotesQuoteLineItems()` | `--quote` | 3 | Retrieve a paginated list of line items for a quote |
| `get-radar-value-list` | `stripe.getRadarValueList()` | `--id` | 0 | Retrieves a specific Stripe Radar value list by its identifier |
| `get-radar-value-list-items` | `stripe.getRadarValueListItems()` | `--value-list` | 5 | List all value list items from a Stripe Radar value list |
| `get-refunds-refund` ·common | `stripe.getRefundsRefund()` | `--refund` | 0 | Retrieve details of a specific Stripe refund by ID |
| `get-reporting-report-runs-report-run` | `stripe.getReportingReportRunsReportRun()` | `--report-run` | 0 | Retrieves details of an existing Report Run object |
| `get-reporting-report-type` | `stripe.getReportingReportType()` | `--id` | 0 | Retrieve details of a specific Stripe report type by ID |
| `get-setup-attempts` | `stripe.getSetupAttempts()` | `--setup-intent` | 4 | List SetupAttempts associated with a SetupIntent |
| `get-setup-intent` | `stripe.getSetupIntent()` | `--setup-intent-id` | 1 | Retrieves details of a SetupIntent by its ID; `client_secret` is required if a publishable API key is used |
| `get-shipping-rate` | `stripe.getShippingRate()` | `--shipping-rate-id` | 0 | Retrieve details of a specific Stripe shipping rate by its unique ID |
| `get-sources-source` | `stripe.getSourcesSource()` | `--source-id` | 1 | Retrieves an existing source object |
| `get-subscription` | `stripe.getSubscription()` | `--subscription-id` | 0 | Retrieves detailed information for an existing Stripe subscription using its unique ID |
| `get-subscription-item` | `stripe.getSubscriptionItem()` | `--subscription-item-id` | 0 | Retrieves detailed information for a specific subscription item using its unique ID |
| `get-subscription-schedules-schedule` ·common | `stripe.getSubscriptionSchedulesSchedule()` | `--schedule` | 1 | Retrieve a subscription schedule using its unique identifier |
| `get-tax-calculation` | `stripe.getTaxCalculation()` | `--id` | 0 | Retrieves a Tax Calculation object by its unique ID |
| `get-tax-calculations-calculation-line-items` | `stripe.getTaxCalculationsCalculationLineItems()` | `--calculation` | 3 | Retrieves line items of a tax calculation as a paginated collection |
| `get-tax-code` | `stripe.getTaxCode()` | `--id` | 0 | Retrieves the details of an existing tax code |
| `get-tax-id` | `stripe.getTaxId()` | `--id` | 0 | Retrieves an account or customer tax ID object |
| `get-tax-rate` | `stripe.getTaxRate()` | `--tax-rate` | 0 | Retrieve the details of an existing tax rate |
| `get-tax-registration` | `stripe.getTaxRegistration()` | `--id` | 0 | Retrieve a specific tax registration configured for your Stripe account |
| `get-tax-settings` | `stripe.getTaxSettings()` | — | 1 | Retrieves Tax Settings for a merchant |
| `get-tax-transaction` | `stripe.getTaxTransaction()` | `--transaction` | 0 | Retrieves a Tax Transaction object by ID |
| `get-tax-transactions-transaction-line-items` | `stripe.getTaxTransactionsTransactionLineItems()` | `--transaction` | 4 | Retrieves the line items of a committed standalone tax transaction |
| `get-terminal-configuration` | `stripe.getTerminalConfiguration()` | `--configuration` | 0 | Retrieve a specific Terminal Configuration object from Stripe |
| `get-terminal-location` | `stripe.getTerminalLocation()` | `--location` | 0 | Retrieve a Terminal Location object by ID |
| `get-terminal-reader` | `stripe.getTerminalReader()` | `--reader` | 1 | Retrieve a Terminal Reader object by ID |
| `get-test-clock` | `stripe.getTestClock()` | `--test-clock` | 0 | Retrieve a test clock by ID |
| `get-token` | `stripe.getToken()` | `--token` | 0 | Retrieves the token with the given ID |
| `get-transfer-reversal` | `stripe.getTransferReversal()` | `--id` `--transfer` | 1 | Retrieves a transfer reversal by its ID and the associated transfer ID |
| `get-upcoming-invoice-line-items` | `stripe.getUpcomingInvoiceLineItems()` | — | 12 | Retrieve a paginated list of line items for an upcoming invoice preview |
| `get-v1-customers-search-customers` ·common | `stripe.getV1CustomersSearchCustomers()` | `--query` | 2 | Search for Stripe customers using Stripe's Search Query Language |
| `get-v1-disputes-disputes` | `stripe.getV1DisputesDisputes()` | `--id` | 1 | Retrieves detailed information for an existing Stripe dispute by ID |
| `get-v1-invoice-payments-overview2` | `stripe.getV1InvoicePaymentsOverview2()` | — | 5 | List invoice payments in Stripe with pagination and filtering options |
| `get-v1-payment-method-configs-list-payment-method2` | `stripe.getV1PaymentMethodConfigsListPaymentMethod2()` | — | 4 | List all payment method configurations in a Stripe account |
| `get-v1-payment-method-domains` | `stripe.getV1PaymentMethodDomains()` | — | 5 | Retrieve list of payment method domains registered with Stripe account |
| `get-v1-payment-methods-payment-methods2` ·common | `stripe.getV1PaymentMethodsPaymentMethods2()` | — | 7 | Retrieve a list of PaymentMethods with filtering and pagination support |
| `get-v1-radar-early-fraud-warnings-overview` | `stripe.getV1RadarEarlyFraudWarningsOverview()` | — | 6 | Returns a list of early fraud warnings |
| `get-v1-radar-value-lists-overview-radar-value-lists` | `stripe.getV1RadarValueListsOverviewRadarValueLists()` | — | 6 | Retrieve an overview of Radar value lists |
| `get-v1-reporting-report-types-overview-reporting` | `stripe.getV1ReportingReportTypesOverviewReporting()` | — | 0 | List all available Stripe report types |
| `get-v1-shipping-rates-overview2` | `stripe.getV1ShippingRatesOverview2()` | — | 5 | Retrieve an overview of shipping rates from Stripe |
| `get-v1-subscription-schedules-overview2` | `stripe.getV1SubscriptionSchedulesOverview2()` | — | 10 | Retrieves a list of subscription schedules with optional filtering and pagination capabilities |
| `get-v1-tax-codes-tax-code2` | `stripe.getV1TaxCodesTaxCode2()` | — | 3 | Retrieve all tax codes available to add to Products for specific tax calculations |
| `get-v1-tax-ids-overview2` | `stripe.getV1TaxIdsOverview2()` | — | 7 | Retrieve a list of tax IDs with pagination support |
| `get-v1-tax-rates-tax-rate2` | `stripe.getV1TaxRatesTaxRate2()` | — | 6 | Retrieve all tax rates with pagination support |
| `get-v2-core-events-retrieve-event` | `stripe.getV2CoreEventsRetrieveEvent()` | `--id` | 0 | Retrieves detailed information about a specific event from Stripe V2 Core Events API |
| `list-all-subscription-item-period-summaries` | `stripe.listAllSubscriptionItemPeriodSummaries()` | `--subscription-item` | 3 | List all subscription item period summaries |
| `list-apple-pay-domains` | `stripe.listApplePayDomains()` | — | 3 | Retrieves a list of Apple Pay domains registered with Stripe |
| `list-application-fees` | `stripe.listApplicationFees()` | — | 5 | Returns a list of application fees you've previously collected, sorted by creation date descending (newest first) |
| `list-apps-secrets` | `stripe.listAppsSecrets()` | `--scope-type` | 4 | List all secrets stored on the given scope |
| `list-balance-transactions` ·common | `stripe.listBalanceTransactions()` | — | 9 | Lists all balance transactions for the connected Stripe account |
| `list-billing-alerts` | `stripe.listBillingAlerts()` | — | 5 | Retrieve a paginated list of billing alerts |
| `list-billing-credit-balance-transactions` | `stripe.listBillingCreditBalanceTransactions()` | — | 6 | Retrieve a paginated list of credit balance transactions with optional filtering |
| `list-charge-refunds` ·common | `stripe.listChargeRefunds()` | `--charge` | 4 | Lists all refunds for a specific charge in Stripe |
| `list-charges` | `stripe.listCharges()` | — | 7 | Retrieves a list of Stripe charges with filtering and pagination; use valid cursor IDs from previous responses for pagination, and note that charges are typically returned in reverse chronological… |
| `list-checkout-sessions` ·common | `stripe.listCheckoutSessions()` | — | 11 | Retrieve a list of Stripe Checkout Sessions with pagination support |
| `list-climate-orders` | `stripe.listClimateOrders()` | — | 3 | List all Climate order objects |
| `list-climate-products` | `stripe.listClimateProducts()` | — | 3 | Retrieve a list of available Stripe Climate products |
| `list-climate-suppliers` | `stripe.listClimateSuppliers()` | — | 3 | Retrieve a list of available Stripe Climate supplier objects for carbon removal |
| `list-country-specs` | `stripe.listCountrySpecs()` | — | 3 | Retrieves a list of country specifications available in the Stripe API |
| `list-coupons` | `stripe.listCoupons()` | — | 3 | Retrieves a list of discount coupons from a Stripe account, supporting pagination via `limit`, `starting_after`, and `ending_before` |
| `list-credit-notes` | `stripe.listCreditNotes()` | — | 7 | Lists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support |
| `list-customer-subscriptions` ·common | `stripe.listCustomerSubscriptions()` | `--customer` | 4 | List all active subscriptions for a customer in Stripe |
| `list-customers` | `stripe.listCustomers()` | — | 6 | Retrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination |
| `list-disputes` | `stripe.listDisputes()` | — | 6 | List all disputes from a Stripe account |
| `list-entitlements-features` | `stripe.listEntitlementsFeatures()` | — | 5 | Retrieves a paginated list of entitlements features from Stripe |
| `list-file-links` | `stripe.listFileLinks()` | — | 6 | Retrieve a list of Stripe file links |
| `list-files` | `stripe.listFiles()` | — | 5 | Retrieve a list of files that your account has access to |
| `list-financial-connections-accounts` | `stripe.listFinancialConnectionsAccounts()` | — | 5 | List Financial Connections Account objects representing external financial accounts |
| `list-forwarding-requests` | `stripe.listForwardingRequests()` | — | 4 | Lists ForwardingRequest objects from Stripe's Vault and Forward API |
| `list-fx-quotes` | `stripe.listFxQuotes()` | — | 3 | Retrieves a list of FX quotes that have been issued, with the most recent appearing first |
| `list-invoice-payments` | `stripe.listInvoicePayments()` | — | 6 | List all payments for invoices in Stripe |
| `list-invoice-rendering-templates` ·common | `stripe.listInvoiceRenderingTemplates()` | — | 3 | List all invoice rendering templates ordered by creation date |
| `list-invoiceitems` ·common | `stripe.listInvoiceitems()` | — | 8 | Retrieves a paginated list of Stripe invoice items |
| `list-invoices` | `stripe.listInvoices()` | — | 8 | Retrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses |
| `list-meter-event-summaries` | `stripe.listMeterEventSummaries()` | `--customer` `--end-time` `--id` `--start-time` | 4 | Retrieve billing meter event summaries for a customer within a time range |
| `list-payment-attempt-records` | `stripe.listPaymentAttemptRecords()` | `--payment-record` | 3 | List payment attempt records for a specified payment record |
| `list-payment-intents` | `stripe.listPaymentIntents()` | — | 6 | List PaymentIntents from Stripe |
| `list-payment-links` ·common | `stripe.listPaymentLinks()` | — | 4 | Retrieves a list of payment links from Stripe, sorted by creation date in descending order by default |
| `list-payouts` | `stripe.listPayouts()` | — | 7 | 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… |
| `list-plans` | `stripe.listPlans()` | — | 6 | List all billing plans from Stripe account |
| `list-prices` | `stripe.listPrices()` | — | 11 | List Stripe prices |
| `list-products` | `stripe.listProducts()` | — | 8 | Retrieves a list of Stripe products, with optional filtering and pagination; `starting_after`/`ending_before` cursors must be valid product IDs from a previous response |
| `list-products-product-features` | `stripe.listProductsProductFeatures()` | `--product` | 3 | Retrieves a list of features attached to a product |
| `list-promotion-codes` | `stripe.listPromotionCodes()` | — | 9 | Retrieve a list of promotion codes from Stripe |
| `list-quotes` | `stripe.listQuotes()` | — | 7 | Retrieves a list of Stripe quotes with pagination support |
| `list-radar-early-fraud-warnings` | `stripe.listRadarEarlyFraudWarnings()` | — | 6 | List all early fraud warnings from Stripe Radar |
| `list-radar-reviews` | `stripe.listRadarReviews()` | — | 4 | Returns a list of Radar Review objects that have open set to true, sorted in descending order by creation date |
| `list-refunds` ·common | `stripe.listRefunds()` | — | 5 | Lists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support |
| `list-reporting-report-runs` | `stripe.listReportingReportRuns()` | — | 4 | Lists Stripe Report Runs, sorted by creation date descending (newest first) |
| `list-reviews` | `stripe.listReviews()` | — | 4 | Retrieves a list of open Stripe reviews with pagination support |
| `list-setup-attempts` | `stripe.listSetupAttempts()` | `--setup-intent` | 4 | List SetupAttempts associated with a SetupIntent |
| `list-setup-intents` | `stripe.listSetupIntents()` | — | 7 | List SetupIntents from Stripe |
| `list-sigma-scheduled-query-runs` | `stripe.listSigmaScheduledQueryRuns()` | — | 4 | List all Sigma scheduled query runs |
| `list-subscription-items` | `stripe.listSubscriptionItems()` | `--subscription` | 3 | List all subscription items for a given subscription |
| `list-subscriptions` | `stripe.listSubscriptions()` | — | 12 | 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 |
| `list-tax-codes` | `stripe.listTaxCodes()` | — | 3 | Retrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax |
| `list-tax-rates` ·common | `stripe.listTaxRates()` | — | 6 | Retrieves a list of tax rates, which are returned sorted by creation date in descending order |
| `list-tax-registrations` | `stripe.listTaxRegistrations()` | — | 4 | Retrieves a paginated list of tax registrations |
| `list-terminal-configurations` | `stripe.listTerminalConfigurations()` | — | 4 | Retrieve a list of Terminal Configuration objects from Stripe |
| `list-terminal-locations` | `stripe.listTerminalLocations()` | — | 3 | Retrieves a list of Stripe terminal locations with pagination support |
| `list-terminal-readers` | `stripe.listTerminalReaders()` | — | 7 | List all Stripe Terminal Readers with optional filtering |
| `list-test-clocks` | `stripe.listTestClocks()` | — | 3 | Retrieves a paginated list of test clocks |
| `list-topups` | `stripe.listTopups()` | — | 6 | Retrieve a list of existing top-ups from Stripe |
| `list-transfers` | `stripe.listTransfers()` | — | 6 | List all transfers sent to connected accounts |
| `list-v2-core-event-destinations` | `stripe.listV2CoreEventDestinations()` | — | 3 | Retrieves a list of event destinations from Stripe V2 Core Events API |
| `list-v2-core-events` | `stripe.listV2CoreEvents()` | — | 5 | List v2 core events from Stripe |
| `mark-invoice-uncollectible` | `stripe.markInvoiceUncollectible()` | `--invoice` | 0 | Mark a Stripe invoice as uncollectible for bad debt accounting purposes |
| `migrate-subscription` | `stripe.migrateSubscription()` | `--billing-mode` `--subscription` | 0 | Migrate a subscription from classic to flexible billing mode |
| `pay-invoice` | `stripe.payInvoice()` | `--invoice` | 6 | Pay an invoice manually outside the normal collection schedule |
| `post-billing-credit-grants-void-credit-grant` | `stripe.postBillingCreditGrantsVoidCreditGrant()` | `--id` | 0 | Voids a billing credit grant, preventing it from being applied to future invoices |
| `post-charges-charge` | `stripe.postChargesCharge()` | `--charge` | 7 | Updates a Stripe charge with the specified parameters; unspecified fields remain unchanged |
| `post-customers-customer-subs-sub-exposed-id` ·common | `stripe.postCustomersCustomerSubsSubExposedId()` | `--customer` `--subscription-exposed-id` | 14 | Update a customer's subscription |
| `post-customers-sources-verify-bank-account` | `stripe.postCustomersSourcesVerifyBankAccount()` | `--bank-account-id` `--customer-id` | 1 | Verifies a bank account for a customer using microdeposit amounts |
| `post-file-links-link` | `stripe.postFileLinksLink()` | `--link` | 2 | Update an existing file link in Stripe |
| `post-invoices-invoice-void` | `stripe.postInvoicesInvoiceVoid()` | `--invoice` | 0 | Voids a finalized invoice and maintains a papertrail |
| `post-payment-records-report-payment` | `stripe.postPaymentRecordsReportPayment()` | `--amount-requested` `--initiated-at` `--payment-method-details` `--processor-details` | 8 | Report a payment record in terminal state or for initialization |
| `post-setup-intents-intent` | `stripe.postSetupIntentsIntent()` | `--intent` | 9 | Updates a SetupIntent object to modify configuration parameters and metadata |
| `post-subscription-items-item` | `stripe.postSubscriptionItemsItem()` | `--item` | 11 | Update a subscription item's plan, quantity, billing thresholds, discounts, or metadata |
| `post-subscriptions-subscription-exposed-id` | `stripe.postSubscriptionsSubscriptionExposedId()` | `--subscription-exposed-id` | 30 | Update an existing Stripe subscription with specified parameters |
| `post-terminal-configurations-configuration` | `stripe.postTerminalConfigurationsConfiguration()` | `--configuration` | 10 | Update a Stripe Terminal Configuration |
| `post-terminal-readers-reader-process-payment-intent` | `stripe.postTerminalReadersReaderProcessPaymentIntent()` | `--payment-intent` `--reader` | 1 | Initiates a payment flow on a Stripe Terminal Reader to process a PaymentIntent |
| `post-terminal-readers-reader-set-reader-display` | `stripe.postTerminalReadersReaderSetReaderDisplay()` | `--cart` `--reader` `--type` | 0 | Configures a Stripe terminal reader to display cart information on screen |
| `post-terminal-readers-set-reader-display` | `stripe.postTerminalReadersSetReaderDisplay()` | `--cart` `--reader-id` `--type` | 0 | Configure a terminal reader's display to show cart details |
| `post-v1-accounts-capabilities-capabilities` | `stripe.postV1AccountsCapabilitiesCapabilities()` | `--account` `--capability` | 2 | Updates an existing account capability for a Stripe connected account |
| `post-v1-balance-settings-overview` | `stripe.postV1BalanceSettingsOverview()` | — | 2 | Update balance settings for a Stripe account |
| `post-v1-billing-portal-configs-overview-billing` | `stripe.postV1BillingPortalConfigsOverviewBilling()` | `--configuration-id` | 7 | Update an existing billing portal configuration in Stripe |
| `post-v1-checkout-sessions-retrieve-checkout` | `stripe.postV1CheckoutSessionsRetrieveCheckout()` | `--id` | 2 | Update and retrieve a Checkout Session object from Stripe |
| `post-v1-credit-notes-credit-note2` | `stripe.postV1CreditNotesCreditNote2()` | `--credit-note-id` | 2 | Update an existing credit note in Stripe by modifying its memo or metadata |
| `post-v1-customers-funding-instructions-fund-test` | `stripe.postV1CustomersFundingInstructionsFundTest()` | `--bank-transfer` `--currency` `--customer-id` `--funding-type` | 0 | Creates or retrieves funding instructions for a customer cash balance via bank transfer |
| `post-v1-customers-search-customers` ·common | `stripe.postV1CustomersSearchCustomers()` | `--query` | 2 | Search for Stripe customers using a search query |
| `post-v1-invoices-finalize-void-invoice` | `stripe.postV1InvoicesFinalizeVoidInvoice()` | `--invoice-id` | 0 | Voids a finalized invoice and maintains a papertrail |
| `post-v1-invoices-lines-overview` | `stripe.postV1InvoicesLinesOverview()` | `--invoice` `--line-item-id` | 11 | Updates an invoice's line item before finalization |
| `post-v1-invoices-remove-lines-overview` | `stripe.postV1InvoicesRemoveLinesOverview()` | `--invoice-id` `--lines` | 1 | Remove multiple line items from a draft Stripe invoice |
| `post-v1-invoices-send-void-invoice` | `stripe.postV1InvoicesSendVoidInvoice()` | `--invoice-id` | 0 | Void a finalized Stripe invoice |
| `post-v1-invoices-void-invoice` | `stripe.postV1InvoicesVoidInvoice()` | `--invoice-id` | 0 | Permanently void a finalized Stripe invoice |
| `post-v1-payment-method-configs-list-payment-method2` | `stripe.postV1PaymentMethodConfigsListPaymentMethod2()` | `--id` | 56 | Updates a payment method configuration to control which payment methods are displayed at checkout |
| `post-v1-payment-method-domains-payment-method` | `stripe.postV1PaymentMethodDomainsPaymentMethod()` | `--id` | 1 | Updates an existing payment method domain to enable or disable it |
| `post-v1-payment-records-report-attempt` | `stripe.postV1PaymentRecordsReportAttempt()` | `--initiated-at` `--outcome` `--payment-record-id` | 1 | Report a payment attempt on a Stripe Payment Record |
| `post-v1-payment-records-report-canceled` | `stripe.postV1PaymentRecordsReportCanceled()` | `--canceled-at` `--id` | 0 | Report that the most recent payment attempt was canceled |
| `post-v1-payment-records-report-guaranteed` | `stripe.postV1PaymentRecordsReportGuaranteed()` | `--guaranteed-at` `--id` | 0 | Reports that a payment attempt was guaranteed for a specific Payment Record |
| `post-v1-payment-records-report-info` | `stripe.postV1PaymentRecordsReportInfo()` | `--description` `--payment-record-id` | 0 | Report additional payment attempt information for a payment record |
| `post-v1-payment-records-report-refund-overview` | `stripe.postV1PaymentRecordsReportRefundOverview()` | `--id` `--outcome` `--processor-details` `--refunded` | 3 | Reports that the most recent payment attempt on a Payment Record was refunded |
| `post-v1-payouts-retrieve-payout` | `stripe.postV1PayoutsRetrievePayout()` | `--payout-id` | 1 | Updates a payout's metadata and returns the updated payout object |
| `post-v1-plans-overview` | `stripe.postV1PlansOverview()` | `--id` | 5 | Update a Stripe plan by setting passed parameter values |
| `post-v1-promotion-codes-promotion-code` | `stripe.postV1PromotionCodesPromotionCode()` | `--promotion-code` | 3 | Updates an existing promotion code |
| `post-v1-shipping-rates-overview2` | `stripe.postV1ShippingRatesOverview2()` | `--id` | 3 | Update an existing Stripe shipping rate |
| `post-v1-subscription-schedules-overview2` | `stripe.postV1SubscriptionSchedulesOverview2()` | `--id` | 5 | Update an existing subscription schedule with new phases, settings, metadata, and end behavior |
| `post-v1-subscription-schedules-release-overview` | `stripe.postV1SubscriptionSchedulesReleaseOverview()` | `--schedule-id` | 1 | Release a subscription schedule |
| `post-v1-subscriptions-list-subscriptions` ·common | `stripe.postV1SubscriptionsListSubscriptions()` | `--subscription-id` | 10 | Updates an existing Stripe subscription's properties including metadata, description, payment method, billing settings, trial periods, and cancellation behavior |
| `post-v1-tax-rates-tax-rate2` ·common | `stripe.postV1TaxRatesTaxRate2()` | `--tax-rate-id` | 8 | Update an existing Stripe tax rate |
| `post-v2-billing-meter-event-adjustments-meter-event` | `stripe.postV2BillingMeterEventAdjustmentsMeterEvent()` | `--cancel` `--event-name` `--type` | 0 | Creates a billing meter event adjustment to cancel a previously sent meter event |
| `present-payment-method` | `stripe.presentPaymentMethod()` | `--reader-id` | 5 | Present a payment method on a simulated terminal reader for testing purposes |
| `process-setup-intent` | `stripe.processSetupIntent()` | `--customer-consent-collected` `--reader-id` `--setup-intent` | 2 | Initiates a SetupIntent flow on a Stripe Terminal Reader to save payment details |
| `reactivate-billing-meter` | `stripe.reactivateBillingMeter()` | `--id` | 0 | Reactivates a deactivated billing meter |
| `report-payment-attempt-failed` | `stripe.reportPaymentAttemptFailed()` | `--failed-at` `--id` | 0 | Reports that a recent payment attempt on a Payment Record has failed |
| `resume-subscription` | `stripe.resumeSubscription()` | `--subscription-id` | 3 | Resumes a paused Stripe subscription with billing cycle and proration options |
| `retrieve-balance` | `stripe.retrieveBalance()` | — | 0 | Retrieves the complete current balance details for the connected Stripe account |
| `retrieve-charge` ·common | `stripe.retrieveCharge()` | `--charge-id` | 0 | Retrieves full details for an existing Stripe charge using its unique ID |
| `retrieve-checkout-session` | `stripe.retrieveCheckoutSession()` | `--session` | 1 | Retrieve a Checkout Session object from Stripe |
| `retrieve-customer` ·common | `stripe.retrieveCustomer()` | `--customer-id` | 0 | Retrieves detailed information for an existing Stripe customer using their unique customer ID |
| `retrieve-payment-intent` ·common | `stripe.retrievePaymentIntent()` | `--payment-intent-id` | 1 | Retrieves a PaymentIntent by its ID; `client_secret` is required if a publishable API key is used |
| `retrieve-promotion-code` | `stripe.retrievePromotionCode()` | `--promotion-code-id` | 0 | Retrieve a Stripe promotion code by its ID |
| `retrieve-upcoming-invoice` | `stripe.retrieveUpcomingInvoice()` | — | 26 | Preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items |
| `search-charges` | `stripe.searchCharges()` | `--query` | 2 | Search charges using Stripe's Search Query Language |
| `search-customers` ·common | `stripe.searchCustomers()` | `--query` | 2 | Retrieves a list of Stripe customers matching a search query that adheres to Stripe's Search Query Language |
| `search-invoices` | `stripe.searchInvoices()` | `--query` | 2 | Searches for invoices using Stripe's Search Query Language |
| `search-payment-intents` ·common | `stripe.searchPaymentIntents()` | `--query` | 2 | Searches for PaymentIntents using Stripe's Search Query Language |
| `search-prices` ·common | `stripe.searchPrices()` | `--query` | 2 | Search for prices using Stripe's Search Query Language |
| `search-products` ·common | `stripe.searchProducts()` | `--query` | 2 | Search for products using Stripe's Search Query Language |
| `search-subscriptions` ·common | `stripe.searchSubscriptions()` | `--query` | 2 | Searches for subscriptions using Stripe's Search Query Language |
| `send-invoice` | `stripe.sendInvoice()` | `--invoice` | 0 | Manually send a finalized Stripe invoice to the customer outside the automatic billing schedule |
| `set-reader-display` | `stripe.setReaderDisplay()` | `--cart` `--reader` | 1 | Configures a Stripe Terminal reader to display cart information on its screen |
| `set-terminal-reader-display` | `stripe.setTerminalReaderDisplay()` | `--reader-id` `--type` | 1 | Set the display on a Stripe Terminal reader to show cart details |
| `succeed-test-terminal-reader-input-collection` | `stripe.succeedTestTerminalReaderInputCollection()` | `--reader` | 2 | Simulates successful completion of an ongoing input collection on a Terminal reader |
| `timeout-test-terminal-reader-input-collection` | `stripe.timeoutTestTerminalReaderInputCollection()` | `--reader` | 1 | Simulate an input collection timeout on a Stripe Terminal reader |
| `update-application-fee-refund` | `stripe.updateApplicationFeeRefund()` | `--fee` `--id` | 2 | Updates an application fee refund by its fee ID and refund ID |
| `update-billing-credit-grant` | `stripe.updateBillingCreditGrant()` | `--id` | 2 | Updates an existing billing credit grant |
| `update-billing-meter` | `stripe.updateBillingMeter()` | `--id` | 2 | Update a billing meter's display name |
| `update-billing-portal-configuration` | `stripe.updateBillingPortalConfiguration()` | `--configuration` | 7 | Update a billing portal configuration |
| `update-cash-balance` | `stripe.updateCashBalance()` | `--customer-id` | 1 | Update a customer's cash balance settings in Stripe |
| `update-charge` | `stripe.updateCharge()` | `--charge-id` | 7 | Update a Stripe charge object with provided parameters |
| `update-charge-dispute` ·common | `stripe.updateChargeDispute()` | `--charge` | 1 | Update metadata on a charge's dispute |
| `update-charge-refund` ·common | `stripe.updateChargeRefund()` | `--refund` | 1 | Update a specified refund within a charge |
| `update-checkout-session` | `stripe.updateCheckoutSession()` | `--session` | 4 | Update a Stripe Checkout Session dynamically |
| `update-coupon` | `stripe.updateCoupon()` | `--coupon` | 3 | Updates a Stripe coupon's metadata, name, or currency options |
| `update-customer` | `stripe.updateCustomer()` | `--customer-id` | 14 | Updates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged |
| `update-customer-balance-txn` | `stripe.updateCustomerBalanceTxn()` | `--customer-id` `--transaction-id` | 2 | Updates an existing customer balance transaction's description and metadata |
| `update-customer-bank-account` | `stripe.updateCustomerBankAccount()` | `--customer` `--id` | 3 | Updates a specified bank account for a given customer |
| `update-customer-bank-account-source` | `stripe.updateCustomerBankAccountSource()` | `--customer-id` `--source-id` | 3 | Updates a bank account source attached to a customer |
| `update-customer-card` ·common | `stripe.updateCustomerCard()` | `--customer` `--id` | 10 | Update a card for a specified customer |
| `update-customer-source` ·common | `stripe.updateCustomerSource()` | `--customer` `--id` | 14 | Update a specified source for a given customer |
| `update-customer-subscription` ·common | `stripe.updateCustomerSubscription()` | `--customer` `--subscription-exposed-id` | 23 | Update a subscription on a customer in Stripe |
| `update-dispute` | `stripe.updateDispute()` | `--dispute` | 3 | Update a Stripe dispute by submitting evidence or updating metadata |
| `update-entitlement-feature` | `stripe.updateEntitlementFeature()` | `--id` | 3 | Update a feature's properties or deactivate it |
| `update-event-destination` | `stripe.updateEventDestination()` | `--event-destination-id` | 6 | Updates a v2 Event Destination with new values for specified parameters |
| `update-external-account` | `stripe.updateExternalAccount()` | `--account` `--id` | 13 | Updates the metadata, account holder name, account holder type of an external bank account or card belonging to a connected account and optionally sets it as the default for its currency |
| `update-invoice` | `stripe.updateInvoice()` | `--invoice` | 26 | Updates a draft Stripe invoice |
| `update-invoice-lines` | `stripe.updateInvoiceLines()` | `--invoice` `--lines` | 1 | Bulk update multiple line items on a draft invoice |
| `update-invoiceitem` | `stripe.updateInvoiceitem()` | `--invoiceitem-id` | 13 | Updates an invoice item on a draft invoice |
| `update-payment-intent` ·common | `stripe.updatePaymentIntent()` | `--payment-intent-id` | 11 | Updates a Stripe PaymentIntent with new values for specified parameters; note that if `currency` is updated, `amount` might also be required, and certain updates (e.g., to `payment_method`) can… |
| `update-payment-link` | `stripe.updatePaymentLink()` | `--payment-link` | 22 | Updates an existing payment link with new configuration details |
| `update-payment-method` | `stripe.updatePaymentMethod()` | `--payment-method-id` | 6 | Updates an existing PaymentMethod object in Stripe |
| `update-price` | `stripe.updatePrice()` | `--price` | 7 | Updates a Stripe price by setting passed parameter values; unspecified parameters remain unchanged |
| `update-product` | `stripe.updateProduct()` | `--id` | 13 | Update an existing product in Stripe |
| `update-promotion-code` | `stripe.updatePromotionCode()` | `--id` | 3 | Updates an existing Stripe promotion code by setting the values of the parameters passed |
| `update-quote` | `stripe.updateQuote()` | `--quote` | 18 | Update an existing Stripe quote with new values |
| `update-source` | `stripe.updateSource()` | `--source` | 5 | Updates a Stripe source with specified parameters |
| `update-subscription` ·common | `stripe.updateSubscription()` | `--subscription-id` | 10 | 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 |
| `update-subscription-schedule` | `stripe.updateSubscriptionSchedule()` | `--schedule` | 5 | Update an existing subscription schedule in Stripe |
| `update-tax-registration` | `stripe.updateTaxRegistration()` | `--id` | 2 | Update an existing tax registration in Stripe |
| `update-tax-settings` | `stripe.updateTaxSettings()` | — | 2 | Updates Stripe Tax Settings parameters used in tax calculations |
| `update-terminal-location` | `stripe.updateTerminalLocation()` | `--location` | 9 | Updates a Terminal Location by modifying specified parameters |
| `update-terminal-reader` | `stripe.updateTerminalReader()` | `--reader` | 2 | Update a Terminal Reader object by setting parameter values |
| `validate-payment-method-domain` | `stripe.validatePaymentMethodDomain()` | `--payment-method-domain` | 0 | Validate an existing payment method domain in Stripe to activate payment methods |
| `verify-microdeposits` | `stripe.verifyMicrodeposits()` | `--setup-intent-id` | 2 | Verifies microdeposits on a SetupIntent object to confirm bank account ownership |
| `verify-microdeposits-payment-intent` | `stripe.verifyMicrodepositsPaymentIntent()` | `--intent` | 2 | Verifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code |
| `void-credit-note` | `stripe.voidCreditNote()` | `--id` | 0 | Marks a credit note as void |
| `void-invoice` ·common | `stripe.voidInvoice()` | `--invoice-id` | 0 | Void a finalized Stripe invoice |

## Triggers

`stripe.on("<event>", handler)` in a script; required config goes before the handler as an object.

| Event | Name | Required config | Description |
|---|---|---|---|
| `"charge-failed"` | Charge Failed Trigger | — | Triggered when a direct charge fails in Stripe's legacy Charges API |
| `"checkout-session-completed"` | Checkout Session Completed Trigger | — | Triggered when a checkout session is completed in Stripe |
| `"invoice-payment-succeeded"` | Invoice Payment Succeeded Trigger | — | Triggered when an invoice payment is successful in Stripe |
| `"payment-failed"` | Payment Intent Failed Trigger | — | Triggered when a payment intent fails in Stripe |
| `"product-created"` | Product Created Trigger | — | Triggered when a product is created in Stripe |
| `"subscription-added"` | Subscription Added Trigger | — | Triggered when a subscription is added in Stripe |
| `"subscription-deleted"` | Subscription Deleted Trigger | — | Triggered when a subscription is deleted in Stripe |

## Docs

- [run CLI](https://docs.boxd.sh/cli/run): Call connected integrations from the shell, connect new ones, and run automations.
- [Quickstart](https://docs.boxd.sh/guides/integrations/quickstart): Connect an integration, call it from the shell, and turn a script into an automation.
- [Connections](https://docs.boxd.sh/guides/integrations/connections): Connect an account once, for yourself or for your whole organization.
- [Scripts](https://docs.boxd.sh/guides/automations/scripts): Typed integrations, triggers, schedules and state in a .run.ts file.
- [Jobs](https://docs.boxd.sh/guides/automations/jobs): How a script becomes a background job: states, retries, sleep and wake.
- [Beyond the catalog](https://docs.boxd.sh/guides/automations/beyond-the-catalog): Reach your own APIs, databases and cloud accounts from a script.