Skip to main content
Stripe logo
  • Category: payment processing
  • Auth: API_KEY, OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 435
  • Triggers: 40
  • Slug: STRIPE
  • Version: 20261101_00

Frequently Asked Questions

For a step-by-step guide on creating and configuring your own Stripe OAuth credentials with Composio, see How to create OAuth credentials for Stripe.
One possible cause is that the Stripe webhook destination was deleted in Stripe while the trigger still appears enabled. In that state, the trigger can look active, but Stripe has no active destination to send matching events to.Check the Stripe Dashboard for the webhook destination associated with the trigger. If it is missing or disabled, recreate the trigger so the Stripe webhook destination is created again, then verify new Stripe events are delivered.

Tools

Slug: STRIPE_ACCEPT_QUOTETool to accept a quote in Stripe. Use when you need to accept a finalized quote, which will create an invoice, subscription, or subscription schedule based on the quote’s configuration.

Input Parameters

string
required
The ID of the quote to accept. Must start with ‘qt_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ACTIVATE_BILLING_ALERTReactivates a billing alert, allowing it to trigger again. Use when you need to resume monitoring usage thresholds and receiving notifications for a previously deactivated alert.

Input Parameters

string
required
The unique identifier of the billing alert to reactivate (e.g., ‘alrt_12345’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ADD_INVOICE_LINESTool to add multiple line items to a draft Stripe invoice. Use when you need to add additional charges, services, or credits to an existing invoice that is still in draft status.

Input Parameters

string
required
The ID of the invoice to add lines to. Invoice must be in draft status.
array
required
Multiple line items to attach to the invoice. At least one line item is required.
object
Set of key-value pairs to attach to the invoice itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ADVANCE_TEST_CLOCKAdvance a test clock to a future timestamp. Use for testing time-based billing scenarios. Requires test mode API keys (test_helpers endpoints are only available in test mode). The advancement is asynchronous; monitor the status field to track completion (status changes from ‘advancing’ to ‘ready’).

Input Parameters

string
required
The ID of the test clock to advance (format: clock_*). Obtain this from creating a test clock or listing existing test clocks.
integer
required
Unix timestamp (seconds since epoch) to advance the clock to. Must be greater than the clock’s current frozen_time. Maximum advance: 2 subscription intervals ahead, or 2 years if no subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_APPLY_CUSTOMER_BALANCEManually reconciles remaining amount for a customer_balance PaymentIntent by applying funds from customer’s cash balance. IMPORTANT: This action only works with PaymentIntents that have ‘customer_balance’ in their payment_method_types. The customer_balance payment method type must be enabled in your Stripe account settings. Use this when you need to apply funds from a customer’s cash balance account to complete or partially fund a PaymentIntent.

Input Parameters

integer
Amount intended to apply to this PaymentIntent from the customer’s cash balance. A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents to charge $1.00 USD, or 100 to charge ¥100 JPY for zero-decimal currencies). The maximum amount is the amount of the PaymentIntent. When omitted, defaults to the remaining amount requested on the PaymentIntent.
string
required
The PaymentIntent identifier. Must be a PaymentIntent that uses ‘customer_balance’ as a payment method type.
string
Three-letter ISO currency code, in lowercase. Must be a supported currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ARCHIVE_BILLING_ALERTTool to archive a billing alert in Stripe, removing it from list views and APIs. Use when you need to permanently archive a billing alert. This action is non-reversible.

Input Parameters

string
required
The unique identifier of the billing alert to archive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ATTACH_CUSTOMER_SOURCEAttach a payment source (card token or source object) to a customer for future charges. IMPORTANT: This is a legacy API. For new integrations, use the PaymentMethods API instead (STRIPE_ATTACH_PAYMENT_METHOD). The source parameter accepts: - Card tokens (tok_xxxx) created client-side via Stripe.js or mobile SDKs - Source objects (src_xxxx) for alternative payment methods NOTE: PaymentMethod objects (pm_xxxx) cannot be used with this endpoint. Use STRIPE_ATTACH_PAYMENT_METHOD for those. In test mode, you can use test tokens like ‘tok_visa’. In live mode, tokens must be created client-side for PCI compliance.

Input Parameters

string
required
The source to attach. Can be a card token ID (tok_xxx) or source object ID (src_xxx). In test mode, you can use ‘tok_visa’ or ‘tok_mastercard’. In live mode, tokens must be created client-side using Stripe.js, Elements, or mobile SDKs. Note: Cannot use PaymentMethod IDs (pm_xxx) - use STRIPE_ATTACH_PAYMENT_METHOD for those.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string
required
The unique identifier of the Stripe customer to attach the source to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ATTACH_INVOICE_PAYMENTAttaches a PaymentIntent or Out of Band Payment to an invoice’s payments list. When the PaymentIntent status changes to succeeded, the payment is credited to the invoice. Use when you need to associate an existing payment with a specific invoice.

Input Parameters

string
required
The ID of the invoice to attach the payment to.
string
The ID of the PaymentIntent to attach to the invoice. Must be a PaymentIntent that can be attached to the invoice. Either payment_intent or payment_record must be provided, but not both.
string
The ID of the PaymentRecord to attach to the invoice. This is used for Out of Band payments. Either payment_intent or payment_record must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ATTACH_PAYMENT_METHODAttaches a PaymentMethod to a Customer. Use when you need to save a payment method for future use with a specific customer. The PaymentMethod must be in a detached state before attaching.

Input Parameters

string
The ID of the customer to which to attach the PaymentMethod. Either customer or customer_account must be provided.
string
The ID of the Account representing the customer to which to attach the PaymentMethod. Either customer or customer_account must be provided.
string
required
The unique identifier of the PaymentMethod to attach to the customer. The PaymentMethod must be in a detached state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_ATTACH_PRODUCT_FEATURETool to attach a feature to a product. Use when you need to add a feature to a product’s capabilities. This creates a product_feature object linking the feature to the product.

Input Parameters

string
required
The ID of the product to attach the feature to. Product IDs typically start with ‘prod_’.
string
required
The ID of the Feature object to attach to this product. Feature IDs typically start with ‘feat_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_PAYMENT_INTENTCancels a PaymentIntent when in cancelable state. Use when a PaymentIntent is no longer needed to prevent further charges. For PaymentIntents with status=‘requires_capture’, the remaining amount_capturable will be automatically refunded.

Input Parameters

string
required
The unique identifier of the PaymentIntent to cancel.
string ("duplicate" | "fraudulent" | "requested_by_customer" | "abandoned")
Reason for canceling this PaymentIntent. Must be one of: ‘duplicate’, ‘fraudulent’, ‘requested_by_customer’, or ‘abandoned’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_QUOTETool to cancel a Stripe quote. Use when you need to cancel an existing quote that is in ‘draft’ or ‘open’ status. Once canceled, the quote cannot be finalized or accepted by the customer.

Input Parameters

string
required
The unique identifier of the quote to cancel. Starts with ‘qt_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_SETUP_INTENTCancels a SetupIntent that is no longer needed. Use when a SetupIntent is in ‘requires_payment_method’, ‘requires_confirmation’, or ‘requires_action’ state. Note: SetupIntents linked to Checkout Sessions cannot be canceled through this method.

Input Parameters

string
required
The unique identifier of the SetupIntent to cancel.
string ("abandoned" | "requested_by_customer" | "duplicate")
Reason for cancellation. Must be one of: ‘abandoned’, ‘requested_by_customer’, or ‘duplicate’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_SUBSCRIPTIONCancels a customer’s Stripe subscription immediately, with options to invoice for metered usage and prorate charges for unused time.

Input Parameters

boolean
If true, generates a proration invoice item for unused time remaining in the current billing cycle.
boolean
If true, generates a final invoice for any un-invoiced metered usage.
string
required
Identifier of the subscription to cancel.
object
Specifies reasons for cancellation. Common keys: ‘comment’ (free-form text) and ‘feedback’ (e.g., ‘customer_service’, ‘low_usage’, ‘switched_service’). Example: {‘comment’: ‘Switching services.’, ‘feedback’: ‘switched_service’}

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_SUBSCRIPTION_SCHEDULECancels a subscription schedule and its associated subscription immediately if active. Only schedules with status ‘not_started’ or ‘active’ can be canceled.

Input Parameters

boolean
If the subscription schedule is ‘active’, indicates if the cancellation should be prorated. Defaults to true if not specified.
string
required
The unique identifier for the subscription schedule to cancel (e.g., sub_sched_1Mr3owLkdIwHu7ix38CXMudt)
boolean
If the subscription schedule is ‘active’, indicates if a final invoice will be generated that contains any un-invoiced metered usage and new/pending proration invoice items. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CANCEL_TERMINAL_READER_ACTIONTool to cancel the current reader action. Use when you need to halt any ongoing operation on a Stripe Terminal reader device such as payment collection, setup intent processing, or input collection.

Input Parameters

string
required
The unique identifier of the Reader to cancel the action on. Must start with ‘tmr_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CAPTURE_CHARGETool to capture payment on an uncaptured charge. Use when a charge was created with capture=false and you’re ready to capture the payment.

Input Parameters

integer
The amount to capture in cents (or smallest currency unit). If not specified, the full amount is captured. Cannot exceed the original, uncaptured amount of the charge.
string
required
The identifier of the charge to be captured. Typically starts with ‘ch_’.
string
The email address to send the receipt to. Overrides the charge’s receipt_email. Maximum 800 characters. Receipts are not sent in test mode.
string
Transaction group identifier. May only be provided if not previously set.
string
Statement descriptor text for non-card charges with 22-character limit. For card charges, ignored if statement_descriptor_suffix is provided.
integer
The amount to transfer to the destination account without creating an Application Fee object. Must be used with Stripe Connect.
integer
An application fee amount to add to this charge, not exceeding the original amount.
string
Suffix concatenated to account’s statement descriptor prefix for card charges.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CAPTURE_PAYMENT_INTENTCaptures the funds of an existing uncaptured PaymentIntent. Use when the PaymentIntent status is ‘requires_capture’.

Input Parameters

string
required
The unique identifier of the PaymentIntent to capture.
object
Set of key-value pairs for storing additional structured data. Individual keys can be unset by posting an empty value.
boolean
Defaults to true. Set to false to retain uncaptured funds for future captures (requires multicapture support).
integer
Amount to capture in smallest currency unit. Must be less than or equal to the original amount. Defaults to full amount_capturable if not provided.
string
Custom statement descriptor for non-card charges. Maximum 22 characters.
integer
Application fee to be transferred to the app owner’s Stripe account. Cannot exceed the captured amount.
string
Suffix appended to the account’s statement descriptor prefix for card charges. Maximum 22 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CLOSE_DISPUTETool to close a dispute. Use when you want to dismiss a dispute and acknowledge it as lost, indicating no evidence will be submitted. This action is irreversible.

Input Parameters

string
required
The unique identifier for the dispute to close. Typically starts with ‘du_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_COLLECT_TERMINAL_READER_INPUTSInitiates input collection on a Terminal Reader to display forms and collect customer information. Use when you need to gather email, phone, text, numeric, signature, or selection inputs from customers on a physical reader.

Input Parameters

array
required
List of inputs to collect from the customer. Maximum 5 inputs per request.
object
Set of key-value pairs for storing additional structured information about this input collection.
string
required
The unique identifier of the terminal reader.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_COLLECT_TERMINAL_READER_PAYMENT_METHODTool to initiate payment method collection on a Stripe Terminal Reader. Use when you need to hand off a PaymentIntent to a physical card reader device to collect payment details. The Reader action executes asynchronously with action.status showing ‘in_progress’ initially.

Input Parameters

string
required
The unique identifier of the Reader device.
object
Configuration overrides for payment collection behavior.
string
required
The ID of the PaymentIntent to collect a payment method for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CONFIRM_PAYMENT_INTENTTool to confirm customer intent to pay with current or provided payment method. Use when ready to finalize a PaymentIntent and initiate the payment attempt. A return_url is required if confirmation needs customer action like 3D Secure authentication.

Input Parameters

string
ID of the mandate to use for this payment.
object
Shipping information for this PaymentIntent.
string
The URL to redirect your customer back to after they authenticate or cancel their payment. Required if confirmation requires customer action (e.g., 3D Secure).
string
Set to true to indicate customer is not in checkout flow, or use ‘one_off’ or ‘recurring’ for specific off-session types.
string ("automatic" | "automatic_async" | "manual")
Controls fund capture timing. Can be ‘automatic’, ‘automatic_async’ (default), or ‘manual’.
string
ID of the PaymentMethod to attach to this PaymentIntent.
boolean
Set to true when confirming client-side with Stripe.js or mobile SDKs.
string
required
The ID of the PaymentIntent to confirm.
string
ID of the ConfirmationToken to use for confirmation.
string ("on_session" | "off_session")
Indicates intent to reuse payment method. Use ‘on_session’ if customer is present, ‘off_session’ for future charges.
object
Hash to create new PaymentMethod with type-specific details. Must include ‘type’ field (e.g., ‘card’, ‘acss_debit’, etc.).
object
Payment method-specific configuration (e.g., card installments, 3D Secure, BNPL options).
boolean
When true, fails payment if PaymentIntent transitions to ‘requires_action’. Default is false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CONFIRM_SETUP_INTENTConfirms a SetupIntent to complete customer payment method setup. Use when you need to finalize credential collection after creating a SetupIntent.

Input Parameters

string
URL to redirect customer after authentication. Required for redirect-based payment methods.
string
ID of the PaymentMethod to attach to this SetupIntent.
boolean
Set to true when confirming server-side with Stripe.js or mobile SDKs.
string
required
The unique identifier of the SetupIntent to confirm.
string
ID of the ConfirmationToken used to confirm this SetupIntent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CONFIRM_TERMINAL_READER_PAYMENT_INTENTTool to confirm a PaymentIntent on a Terminal reader device. Use when you need to finalize a payment transaction on a card reader after the PaymentIntent has been collected on the reader hardware.

Input Parameters

string
required
The unique identifier of the Terminal reader. Must start with ‘tmr_’ followed by alphanumeric characters.
object
Optional configuration for confirming the payment intent.
string
required
The unique identifier of the PaymentIntent to be finalized on the reader.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_ACCOUNTS_CAPABILITIES_CARD_PAYMENTSUpdates the card payments capability for a Stripe Connect account, requesting or removing the capability. The response includes its status and requirements.

Input Parameters

string
required
The account ID for which to enable card_payments capability. Typically starts with ‘acct_’.
boolean
To request the card_payments capability for an account, pass true. Pass false to remove this non-permanent capability that was previously requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_ACCOUNT_SESSIONCreates an Account Session for a Stripe Connect account, granting access to embedded components. Use when you need to provide temporary, client-side access to a connected account’s dashboard features such as account management, onboarding, payments, and payouts. The Account Session expires relatively quickly and cannot be used more than once. We recommend creating a new Account Session each time you need to display an embedded component to your user.

Input Parameters

array
Specifies which fields in the response should be expanded.
string
required
The identifier of the account to create an Account Session for. Starts with ‘acct_’.
object
required
Configuration for embedded components. Each key represents a component, and each value contains the component configuration (e.g., enabled status).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_APPLE_PAY_DOMAINTool to create an Apple Pay domain registration. Use when registering your domain with Apple Pay to accept Apple Pay payments on your website. Stripe handles the Apple merchant validation process.

Input Parameters

array
Specifies which fields in the response should be expanded.
string
required
The domain name to register for Apple Pay (e.g., ‘example.com’). Must be a valid domain. Both top-level domains and subdomains need to be registered separately. Note that www is considered a subdomain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_APPS_SECRETTool to create a secret in the Stripe Secret Store. Use when you need to securely persist secrets for use by UI Extensions and app backends.

Input Parameters

string
required
A name for the secret that’s unique within the scope. This describes the secret’s identifier within your application.
string
required
The plaintext secret value to be encrypted and stored. The encrypted secret value that gets stored securely.
integer
Unix timestamp indicating when the secret should expire and become inaccessible. Enables automatic secret expiration for enhanced security.
string ("account" | "user")
required
The scope type - either ‘account’ (makes secrets accessible to all dashboard users and app backends) or ‘user’ (restricts access to one specific dashboard user plus the app backend).
string
User ID - required when scope_type is ‘user’, omitted for ‘account’ type. The user whose secret to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BANK_ACCOUNT_TOKENTool to create a single-use token representing bank account details. Use when you need to securely collect bank account information for ACH payments, direct debits, or adding a bank account to a customer or recipient.

Input Parameters

string
Create a token for the customer, which is owned by the application’s account. Can only be used with an OAuth access token or Stripe-Account header.
object
required
The bank account this token will represent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_ALERTTool to create a billing alert that monitors usage on a billing meter and triggers notifications when a specified threshold is crossed. Use when you need to set up usage-based billing alerts.

Input Parameters

string
required
The title/name of the alert. Maximum 256 characters.
string
required
The type of alert to create. Currently only ‘usage_threshold’ is supported.
object
required
Configuration for usage threshold alerts that monitors a billing meter and triggers when the threshold is crossed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_CREDIT_GRANTTool to create a credit grant that allocates billing credits to a customer for use against metered pricing. Use when you need to provide promotional or paid credits to customers.

Input Parameters

string
Descriptive name for the credit grant displayed in the dashboard (max 100 characters).
object
required
Container for the credit grant amount configuration.
string ("paid" | "promotional")
Classification of the credit grant. Use ‘paid’ for customer-purchased credits or ‘promotional’ for complimentary credits. Defaults to ‘paid’.
string
Customer ID receiving the credits. Must provide either customer or customer_account.
object
Key-value pairs for storing additional structured data about the credit grant.
integer
Application priority (0=highest, 100=lowest). Controls the order in which credits are applied. Defaults to 50.
integer
Unix timestamp when credits expire. Credits never expire if omitted.
integer
Unix timestamp when credits become usable. Defaults to current time if not specified.
string
Account ID representing the customer. Must provide either customer or customer_account.
object
required
Defines what the credit grant applies to (metered pricing, specific prices, or billable items).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_METERTool to create a billing meter in Stripe for tracking usage events. Use when you need to set up a new meter to track API calls, storage usage, or other measurable customer actions that form the basis of billing calculations.

Input Parameters

string
required
The name of the meter event to track (max 100 characters). This should match the event name you’ll use when reporting usage events to Stripe.
string
required
The human-readable name for this billing meter (max 250 characters). This name is for internal use and is not visible to customers.
object
Configuration for extracting numeric values from meter events.
object
Maps meter events to specific customer accounts.
string ("hour" | "day")
Pre-aggregation time window for events. Use ‘hour’ or ‘day’ if your events are pre-aggregated at those intervals. Leave as None for real-time event tracking.
object
required
Defines how meter events are aggregated over a billing period. Required to specify the aggregation formula.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_METER_EVENTCreates a billing meter event using Stripe API v2 for usage-based billing. Use when recording customer usage that will be metered and billed according to configured billing meters.

Input Parameters

object
required
The payload of the event containing fields corresponding to a meter’s customer mapping. Must include stripe_customer_id and value fields that align with the meter’s configuration.
string
The time of the event in ISO 8601 format. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to the current time if not specified.
string
required
The name of the meter event that corresponds with the meter. Must match the event_name configured on your billing meter. Maximum length is 100 characters.
string
A unique identifier for the event used for deduplication. If not provided, one is auto-generated. We recommend using UUID-like identifiers. Uniqueness is enforced within a rolling 24-hour period. Maximum length is 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_METER_EVENT_ADJUSTMENTCreates an adjustment to cancel a billing meter event. Use when you need to correct errors or remove events attached to the wrong customer within 24 hours of Stripe receiving them.

Input Parameters

string
required
Specifies whether to cancel a single event or a range of events. Currently only ‘cancel’ is supported.
object
Specifies which event to cancel.
string
required
The name of the meter event. Corresponds with the event_name field on a meter. Maximum 100 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_METER_EVENT_SESSIONCreates authentication session for high-throughput meter event stream. Use when you need to send meter events to Stripe’s billing system; tokens are valid for 15 minutes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_PORTAL_CONFIGURATIONTool to create a Stripe billing portal configuration. Use when you need to define the functionality and behavior of a customer portal session, including which features customers can access.

Input Parameters

string
A descriptive name for the configuration, displayed in the Stripe Dashboard (max 256 characters).
object
required
Information about the features available in the portal.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object
The hosted login page for this configuration. If enabled, a shareable URL will be generated.
object
The business information shown to customers in the portal.
string
The default URL to redirect customers to when they click on the portal’s link to return to your website. This can be overridden when creating a portal session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_BILLING_PORTAL_SESSIONTool to create a Stripe billing portal session. Use when you need to provide customers with a secure URL to manage their subscriptions, payment methods, and invoices.

Input Parameters

string
The IETF language tag of the locale to display the customer portal in. If blank or ‘auto’, the customer’s preferred_locales or browser locale is used.
string
The ID of an existing customer. One of ‘customer’ or ‘customer_account’ is required.
object
Configuration for guided customer flows in the portal.
string
The default URL to redirect customers to when they click on the portal’s link to return to your website.
string
The account for which the session is being created. Used for filtering subscriptions and invoices.
string
The ID of an existing portal configuration. If not specified, the default configuration is used.
string
The ID of an existing account. One of ‘customer’ or ‘customer_account’ is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CHARGETool to create a charge to request payment from a credit or debit card. Use when you need to charge a payment source directly. Note: This method is deprecated; Stripe recommends using the Payment Intents API instead for new integrations.

Input Parameters

integer
required
A positive integer representing how much to charge in the smallest currency unit (e.g., 100 cents for $1.00). Minimum $0.50 USD equivalent; supports up to eight digits.
string
Payment source to charge (card ID, bank account, source, token, or connected account). Customer ID required for certain source types.
boolean
Whether to immediately capture charge (defaults to true). When false, authorizes charge for later capture; uncaptured charges expire after set period.
string
required
Three-letter ISO currency code, in lowercase. Must be a supported currency.
string
ID of existing customer to charge. Maximum 500 characters.
object
Key-value pairs for storing additional structured information about the object. Individual or all keys can be unset.
object
Shipping information for the charge.
string
An arbitrary string which you can attach to a Charge object. Displayed in web interface and included in automatic receipt emails.
string
Stripe account ID for funds destination; specifies business of record as connected account.
object
Options to configure Radar fraud detection.
string
Email address for charge receipt delivery. Maximum 800 characters. Overrides customer email if specified.
object
Dictionary for automatic account transfer as destination charge.
string
String identifying transaction as part of a group for grouping transactions.
string
Text on customer statement for non-card charges (22-character limit). Ignored for card charges if suffix specified.
integer
Fee in cents applied to charge and transferred to application owner’s account. Requires OAuth key or Stripe-Account header.
string
Information concatenated to account prefix for card charges; forms complete statement descriptor.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CHARGE_REFUNDTool to create a refund for a charge in Stripe. Use when you need to refund a previously created charge fully or partially.

Input Parameters

integer
Amount in smallest currency unit (e.g., cents) to refund. If omitted, the entire charge is refunded.
string
required
Identifier of the charge to refund.
string ("duplicate" | "fraudulent" | "requested_by_customer")
Reasons for issuing a refund in Stripe.
object
Set of key-value pairs to attach to the refund for storing additional information.
string
Identifier of the PaymentIntent to refund.
boolean
Whether to reverse the transfer. Reversal is proportional to the refund amount.
string
Email address to send refund instructions for payment methods lacking native refund support.
boolean
Whether to refund the application fee. Full refunds refund the entire fee; partial refunds refund proportionally.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CHECKOUT_SESSIONTool to create a Stripe Checkout Session. Use when you need a secure, hosted URL to collect payments or subscriptions via Stripe Checkout.

Input Parameters

string ("payment" | "setup" | "subscription")
required
Session mode. Note: ‘setup’ mode does not use line_items.
string
ID of existing Customer to attach or prefill.
object
Key-value pairs to attach to the session.
string
URL to redirect customers if they cancel payment.
array
required
List of items the customer is purchasing. Each item must have either ‘price’ (ID of existing Price) or ‘price_data’ (inline price). Required for ‘payment’ and ‘subscription’ modes, not used in ‘setup’ mode.
string
required
URL to redirect customers after successful payment or setup.
string
Your unique reference for the session.
array
Payment methods to accept (e.g., [‘card’, ‘ideal’, ‘sepa_debit’]). Defaults to [‘card’] if not specified. Stripe recommends managing payment methods in the Dashboard and omitting this parameter to use dynamic payment methods, but a default is provided for convenience.
boolean
Whether to allow promotion codes in the session.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_COUPONCreates a new discount coupon in Stripe with percentage or fixed amount discount. Use when creating promotional discounts for customers.

Input Parameters

string
Unique identifier for the coupon. If not provided, Stripe will generate one automatically.
string
Name of the coupon displayed to customers on invoices or receipts. Maximum 40 characters.
string
Three-letter ISO currency code in lowercase (e.g., ‘usd’, ‘eur’). Required if amount_off is passed.
string ("once" | "forever" | "repeating")
Specifies how long the discount applies. ‘once’ applies to a single invoice, ‘forever’ applies to all invoices indefinitely, ‘repeating’ applies to invoices for a specified number of months.
object
Set of key-value pairs for storing additional structured information about the coupon.
integer
Unix timestamp specifying the last time at which the coupon can be redeemed.
integer
A positive integer representing the amount to subtract from an invoice total in the smallest currency unit (e.g., cents for USD). Required if percent_off is not passed.
object
Specifies which products this coupon applies to.
number
A positive float larger than 0 and smaller or equal to 100 that represents the discount percentage. Required if amount_off is not passed.
integer
A positive integer specifying the maximum number of times this coupon can be redeemed before it becomes invalid.
object
Coupons defined in each available currency option. Each key must be a three-letter ISO currency code.
integer
Required only if duration is ‘repeating’. Must be a positive integer specifying the number of months the discount is valid.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CREDIT_NOTEIssues a credit note to adjust a finalized invoice’s amount. Use when you need to credit an invoice after finalization, either for refunds, customer balance credits, or out-of-band adjustments.

Input Parameters

string
The credit note’s memo appears on the credit note PDF. Use this field to provide additional context or explanation for the credit note.
array
Line items that make up the credit note. One of amount, lines, or shipping_cost is required.
integer
The integer amount in cents representing the total amount of the credit note. This is the amount that will be credited to the customer. One of amount, lines, or shipping_cost is required.
string ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory")
Reason for issuing this credit note. Must be one of: duplicate, fraudulent, order_change, or product_unsatisfactory.
string
required
ID of the invoice to be credited. The invoice must be finalized.
array
An array of existing refund IDs to link to this credit note.
object
Set of key-value pairs that you can attach to an object for storing additional information in a structured format.
string ("credit_note" | "none")
The email type to send to the customer. One of: credit_note or none. Default is credit_note.
integer
The date when this credit note is in effect. Same as created unless overwritten. When defined, this value replaces the system-generated ‘Date of issue’ printed on the credit note PDF. Unix timestamp in seconds.
integer
The integer amount in cents representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.
integer
The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
object
When shipping_cost contains the shipping_rate from the invoice, the shipping_cost is added to the credit note. One of amount, lines, or shipping_cost is required.
integer
The integer amount in cents representing the amount that was credited outside of Stripe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMERCreates a new customer in Stripe, required for creating charges or subscriptions; an email is highly recommended for customer communications.

Input Parameters

string
The customer’s full name or the name of the business.
string
The customer’s primary email address, used by Stripe for sending invoices, receipts, and other important communications.
string
The customer’s primary phone number. Include the country code for international numbers (e.g., +1 for the USA).
object
The customer’s billing address, provided as a dictionary where both keys and values are strings. This address can be used for tax calculation, shipping, and fraud prevention. Common keys include: line1 (street address, P.O. box, or c/o), line2 (apartment, suite, unit, or building), city, state (state, province, or region), postal_code (ZIP or postal code), and country (a two-letter ISO country code, e.g., ‘US’, ‘GB’). All keys are optional. Can be provided as either a dictionary or a JSON string.
string
An arbitrary string that you can attach to a customer object for your internal reference (e.g., notes about the customer). This is not visible to the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_BALANCE_TRANSACTIONTool to create an immutable transaction that updates the customer’s credit balance. Use when you need to manually adjust a customer’s balance, such as issuing credits or debits.

Input Parameters

integer
required
The integer amount in cents (or smallest currency unit) to apply to the customer’s credit balance. Use a negative value to credit the customer (reduce their owed amount) or a positive value to debit them (increase their owed amount). For example, -500 credits $5.00 USD.
string
required
Three-letter ISO currency code, in lowercase. Must be a supported currency. Determines which balance this transaction applies to.
string
required
The ID of the customer whose balance will be updated. Use the customer ID format like ‘cus_xxxxx’.
object
Set of key-value pairs that you can attach to an object for storing additional structured information. Keys and values must be strings.
string
An arbitrary string attached to the object. Often useful for displaying to users. Maximum 350 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_BANK_ACCOUNTTool to create a new bank account attached to a customer object. Use when you need to add a bank account as a payment source for an existing Stripe customer.

Input Parameters

object
required
Bank account details to attach to the customer. Must include all required fields for creating a bank account.
string
required
The unique identifier of the customer object to which the bank account will be attached.
object
Set of key-value pairs that you can attach to the bank account object. This can be useful for storing additional information about the bank account in a structured format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_CARDCreates a card or bank account payment source for a Stripe customer. Use when you need to add a new payment method to a customer for future use. Supports both card and bank account creation. Note: To use bank accounts, the customer must be verified and have the bank_account capability enabled in their country.

Input Parameters

object
Card details for creating a card payment source.
array
Specifies which fields in the response should be expanded.
string
A token returned by Stripe.js representing the user’s payment source. Either bank_account, card, or source must be provided.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.
object
Set of key-value pairs for storing additional information about the object in a structured format.
object
Bank account details for creating a bank account payment source.
string
A token returned by Stripe.js representing the user’s Alipay account details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_SESSIONCreates a Stripe Customer Session for client-side access to configured components, such as the Payment Element or customer sheet.

Input Parameters

string
ID of an existing customer for which to create the session. Required unless customer_account is provided.
object
required
Configuration for each component. At least 1 component must be enabled.
string
ID of an existing Account for which to create the session. Required unless customer is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_SOURCEAttaches a payment source to a customer for later reuse. Use when you need to save a card, bank account, or other payment source for future charges.

Input Parameters

string
required
A token ID (e.g., from Stripe.js like ‘tok_visa’) or an existing source ID to attach to the customer. The source must be in a chargeable or pending state.
string
required
The ID of the customer to attach the source to.
object
Set of key-value pairs for storing additional structured information about the source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_SUBSCRIPTIONTool to create a subscription for an existing customer. Use when creating a new subscription with items and prices for a specific customer.

Input Parameters

array
List of up to 20 subscription items with attached prices.
array
Fields to expand in response.
string
Three-letter ISO currency code in lowercase.
string
required
ID of the customer for whom to create the subscription.
object
Key-value pairs for additional information.
integer
Unix timestamp when subscription should cancel.
array
Coupons to redeem as subscription discounts with coupon, discount, or promotion_code.
string
Unix timestamp for trial end or ‘now’ to end immediately.
boolean
Whether customer is off-session.
string
Account to charge for subscription invoices.
object
Automatic tax calculation settings.
object
Fund transfer configuration with destination and amount_percent.
integer
Days for customer to pay invoices when using send_invoice collection method.
object
Settings for generated invoices.
string ("allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete")
Payment behavior for incomplete payments.
object
Payment settings for invoices.
array
Up to 20 items appended to next invoice.
string ("charge_automatically" | "send_invoice")
Either charge_automatically or send_invoice.
array
Tax rate IDs applying to items without specific rates.
integer
Number of trial days before first charge.
object
Thresholds at which invoice is sent.
string ("always_invoice" | "create_prorations" | "none")
How to handle prorations.
integer
Unix timestamp to anchor subscription billing cycle.
boolean
Cancel subscription at end of current period.
string
ID of default payment method for the subscription.
number
Percentage transferred to application owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CUSTOMER_TAX_IDCreates a new tax ID for a customer, used for tax compliance and invoicing across 100+ supported country-specific tax ID formats. Use when you need to add tax identification to a customer account.

Input Parameters

string
required
Type of the tax ID. Supported values include over 100 country-specific formats such as: eu_vat (European VAT number), us_ein (US Employer Identification Number), gb_vat (United Kingdom VAT number), ca_bn (Canadian Business Number), br_cpf (Brazilian CPF number), in_gst (Indian GST number), jp_cn (Japanese Corporate Number), ad_nrt, ae_trn, ar_cuit, au_abn, au_arn, bg_uic, bh_vat, bo_tin, br_cnpj, ch_vat, cl_tin, cn_tin, co_nit, cr_tin, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, eu_oss_vat, ge_vat, hk_br, hu_tin, id_npwp, il_vat, is_vat, ke_pin, kr_brn, kz_bin, li_uid, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sv_nit, th_vat, tr_tin, tw_vat, ua_vat, uy_ruc, ve_rif, vn_tin, za_vat and many more.
string
required
The value of the tax ID number.
string
required
The ID of the customer for whom to create the tax ID. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_CVC_UPDATE_TOKENCreates a single-use token representing an updated CVC value for card payments. Use when you need to update the CVC for an existing card without collecting the full card details again.

Input Parameters

string
required
The card verification code (CVC) as a string. This is typically a 3 or 4 digit number found on the back of credit cards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_ENTITLEMENT_FEATURECreates a new feature entitlement in Stripe representing a monetizable ability or functionality. Use when defining features that can be assigned to products and customers.

Input Parameters

string
required
The feature’s name, for your own purpose, not meant to be displayable to the customer. Maximum 80 characters.
object
Set of key-value pairs for storing additional structured information about the feature.
string
required
A unique key you provide as your own system identifier. This may be up to 80 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_EPHEMERAL_KEYTool to create a short-lived ephemeral API key for secure mobile SDK access to specific Stripe resources. Use when integrating with Stripe iOS, Android SDKs, or Stripe.js for Issuing Cards.

Input Parameters

string
A single-use token, created by Stripe.js, used for creating ephemeral keys for Issuing Cards without exchanging sensitive information.
array
Specifies which fields in the response should be expanded. Note: Ephemeral keys have limited expansion support compared to other Stripe objects.
string
The ID of the Customer you’d like to modify using the resulting ephemeral key. At least one resource identifier (customer, issuing_card, nonce, or verification_session) is typically required.
string
The ID of the Issuing Card you’d like to access using the resulting ephemeral key.
string
required
The API version to use for the ephemeral key. This determines the structure of the ephemeral key that will be sent to the mobile SDK. Minimum version: 2020-03-02. Examples: ‘2025-11-17.clover’, ‘2020-03-02’.
string
The ID of the Identity VerificationSession you’d like to access using the resulting ephemeral key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_FILETool to upload a file to Stripe for business purposes such as dispute evidence, identity verification, or business logos. Use when you need to store files that can be attached to other Stripe objects.

Input Parameters

object
required
File to upload to Stripe. The file must follow RFC 2388 specifications for multipart/form-data protocol.
string ("account_requirement" | "additional_verification" | "business_icon" | "business_logo" | "customer_signature" | "dispute_evidence" | "finance_report_run" | "financial_account_statement" | "identity_document" | "identity_document_downloadable" | "issuing_regulatory_reporting" | "pci_document" | "platform_terms_of_service" | "selfie" | "sigma_scheduled_query" | "tax_document_user_upload" | "terminal_android_apk" | "terminal_reader_splashscreen")
required
The purpose of the uploaded file. Categorizes the file’s intended use. Options include dispute_evidence, identity_document, business_logo, customer_signature, and others.
Optional parameters to create a shareable link for the newly uploaded file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_FINANCIAL_CONNECTIONS_SESSIONTool to create a Financial Connections Session to launch the authorization flow for linking financial accounts. Use when you need to collect customer bank account information for payments or data access.

Input Parameters

object
Restrictions on the types of accounts that can be linked.
array
List of data features to retrieve upon account creation. Allowed values: ‘balances’, ‘ownership’, ‘transactions’.
string
For webview integrations only. Upon completing OAuth login in the native browser, the user will be redirected to this URL to return to your app.
array
required
List of data features requested to access. Allowed values: ‘balances’, ‘transactions’, ‘ownership’, ‘payment_method’.
object
required
The account holder to link accounts for. Specifies whether linking for a customer or account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_FX_QUOTETool to create an FX quote for currency conversion with optional rate locking. Use when you need to view current exchange rates for currency pairs or extend quoted rates for 5 minutes to 24 hours to reduce FX fluctuation uncertainty.

Input Parameters

string
Transaction type. Valid values: ‘payment’, ‘transfer’.
string
required
Three-letter ISO currency code in lowercase. The target currency for conversion, typically the currency you want to settle to your Stripe balance. Must be a supported currency.
string
The duration that you wish the quote to be locked for. The quote will be usable for the specified duration. Valid values: ‘none’ (current live rate, no fee), ‘five_minutes’ (5-minute locked rate), ‘hour’ (1-hour locked rate), ‘day’ (24-hour locked rate). Default: ‘none’. Maximum: 1 day. Duration premiums vary by currency group and time period (0.07%-0.30%).
array
required
Array of three-letter ISO currency codes in lowercase. Source currencies to convert from. Must be supported currencies.
string
Connected account ID for destination charges. Only used when usage_type is ‘payment’.
string
Connected account ID for charges made on behalf of. Only used when usage_type is ‘payment’.
string
Connected account ID for transfers. Only used when usage_type is ‘transfer’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_INVOICECreates 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. Note: Stripe API enforces a maximum value of 99,999,999 (in smallest currency unit) for amount fields including unit_amount in invoice items, application_fee_amount, and transfer_data.amount. Values exceeding this limit will be rejected.

Input Parameters

A custom footer text to display on the invoice PDF.
object
Details about the entity that is issuing the invoice. Applicable for Stripe Connect.
string
A custom number to identify this invoice. If not provided, Stripe will generate one. It must be unique.
string
The three-letter ISO currency code (e.g., usd, eur). Must be a supported currency. Defaults to the customer’s currency. IMPORTANT: Cannot be used together with ‘subscription’ - these parameters are mutually exclusive. When billing for a subscription, the currency is automatically derived from the subscription.
string
required
The ID of the customer to be billed.
integer
Unix timestamp (seconds) for the invoice due date. Must be a future date. Only applicable when collection_method=‘send_invoice’. Mutually exclusive with days_until_due — provide only one. Prefer days_until_due for natural-language date inputs to avoid timestamp conversion errors.
object
A set of key-value pairs to store additional information about the object. This is useful for storing custom data.
array
The discounts to apply to the invoice. This can include coupon IDs or discount IDs.
object
Options for customizing the invoice PDF appearance.
string
An arbitrary string attached to the invoice, often visible to the customer.
boolean
Controls whether Stripe automatically finalizes and attempts payment on this invoice. When false, the invoice remains a draft. Defaults to true for collection_method='charge_automatically', and false for collection_method='send_invoice'.
object
Details for revising an existing invoice.
string
The Stripe account ID on behalf of which to charge. Used with Stripe Connect.
string
The ID of the subscription to which this invoice belongs. If provided, the invoice will bill for the subscription’s items. IMPORTANT: Cannot be used together with ‘currency’ - when billing for a subscription, the currency is automatically derived from the subscription.
object
Configuration for Stripe’s automatic tax calculation on the invoice.
array
A list of custom fields to display on the invoice. Each field consists of a name and a value.
object
Shipping cost for the invoice. Provide an existing shipping_rate ID or define shipping_rate_data.
object
For Stripe Connect, details of the destination account for transferring funds from this invoice.
integer
The number of days from when the invoice is finalized until it is due. Only applicable if collection_method is ‘send_invoice’. MUTUALLY EXCLUSIVE: Cannot be used together with due_date. Provide only ONE of these parameters - if both are provided, a validation error will be raised. RECOMMENDED APPROACH: When users specify future dates in natural language (like “due in 30 days” or “due next month”), using days_until_due is safer than converting to Unix timestamps with due_date, as it avoids potential timestamp conversion errors. EXAMPLES: - “Due in 30 days” → days_until_due: 30 - “Due next month” → days_until_due: 30 - “Due in two weeks” → days_until_due: 14 - “Net 15 terms” → days_until_due: 15
string
ID of the default payment source (e.g., card) to be used for this invoice. Deprecated in favor of default_payment_method.
array
A list of tax IDs that apply to this invoice. These IDs will override the default_tax_rates on the Customer.
object
Settings for the invoice payment process.
object
Shipping details for the invoice recipient.
string
Specifies how the invoice payment is collected. Can be ‘charge_automatically’ to attempt payment immediately or ‘send_invoice’ to email the invoice to the customer for manual payment. Defaults to ‘charge_automatically’.
array
A list of IDs of tax rates that will apply to any line item on the invoice for which tax rates are not explicitly defined.
string
An arbitrary string to be displayed on the customer’s credit card statement. This may be truncated to 22 characters.
integer
A non-negative integer in cents (or the smallest currency unit) representing the fee amount for the application that will be applied to the invoice. This is used for Stripe Connect. Maximum value: 99,999,999.
string
ID of the default payment method to be used for this invoice.
integer
A Unix timestamp representing the date and time when this draft invoice will be automatically finalized.
string
Determines how pending invoice items are handled during invoice finalization. Can be ‘include’ to include all pending items, or ‘exclude’ to ignore them. Defaults to ‘include’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_INVOICE_ITEMTool to create an invoice item for draft invoices. Use when adding line items to customer invoices before finalization.

Input Parameters

integer
Amount in cents to charge. Use negative values to reduce amount_due on invoice.
object
Period associated with the invoice item.
string
Existing draft invoice ID. Maximum 250 items per invoice.
object
Pricing information for the invoice item.
string
Three-letter ISO currency code in lowercase. Must be a supported currency.
string
Customer ID to bill for this item.
object
Key-value pairs for storing additional information.
integer
Non-negative quantity of units.
string
Tax code ID. Recommended to set for accurate tax calculation.
array
List of coupons and promotion codes to apply.
array
Tax rate IDs. Overrides invoice default tax rates.
object
Data to generate a new Price object inline.
string
Arbitrary string displayed on the invoice.
boolean
Controls whether discounts apply. Defaults to false for prorations/negative items.
string
Subscription ID to add this item to.
string
Tax behavior: exclusive, inclusive, or unspecified. Recommended to set.
string
Account ID representing the customer.
string
Decimal unit amount (up to 12 decimal places). Alternative to amount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PAYMENT_INTENTCreates a Stripe PaymentIntent to initiate and process a customer’s payment; using application_fee_amount for a connected account requires the Stripe-Account header.

Input Parameters

integer
required
Amount intended to be collected, specified in the smallest currency unit (e.g., 5000 for $50.00 USD).
boolean
Set to true to attempt to confirm this PaymentIntent immediately after creation. If the payment method requires any follow-up actions (e.g., 3D Secure authentication), this PaymentIntent will transition to a status requiring further action.
string
required
Three-letter ISO currency code (e.g., ‘usd’, ‘eur’).
string
ID of the Customer for this PaymentIntent, if one exists. Allows attaching payment method to Customer for future use.
object
Key-value pairs to attach to the PaymentIntent for storing additional structured information.
object
Shipping information for this PaymentIntent. Required for certain payment methods or if calculating tax.
string
URL to redirect customer to after external authentication (e.g., 3D Secure). Required if confirm is true and payment method requires redirection.
string
Arbitrary string for the PaymentIntent, displayed in Stripe dashboard and may be shown to customers.
string
Indicates if customer is absent (off-session, e.g., for renewals). If true, payment_method must be provided and confirm must be true.
string
Email address for receipt; if specified in live mode, receipt sent regardless of account email settings.
string
ID of PaymentMethod, Card, or compatible Source to attach. Required if confirm is true and automatic_payment_methods is not enabled, or if off_session is true.
string
Indicates intent to save payment method for future use: ‘on_session’ (customer present) or ‘off_session’ (customer absent).
array
List of payment method types (e.g., ‘card’, ‘alipay’) this PaymentIntent can use. Required if automatic_payment_methods is disabled.
string
String on customer’s card statement (max 22 chars; no ’<’, ’>’, ’”’, ”’”). Used as prefix if statement_descriptor_suffix is set.
integer
Application fee (smallest currency unit) for the application owner. Requires platform authentication and Stripe-Account header for the connected account.
object
Payment-method-specific configuration for this PaymentIntent.
object
Settings to configure compatible payment methods from the Stripe Dashboard. If disabled, payment_method_types must be provided.
string
Dynamic suffix for card statement (max 22 chars; no ’<’, ’>’, ’”’, ”’”). Appended to main descriptor or account’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PAYMENT_METHODCreates a PaymentMethod object representing a customer’s payment instrument (card, bank account, etc.). PaymentMethods can be: - Attached to a Customer for future use - Used directly with PaymentIntents to collect payments - Stored for recurring payments or subscriptions The ‘type’ parameter determines which payment-specific fields are required: - type=‘card’: requires card object with number, exp_month, exp_year - type=‘sepa_debit’: requires sepa_debit object with iban - type=‘us_bank_account’: requires us_bank_account object with account details - And many other payment method types (acss_debit, au_becs_debit, bacs_debit, boleto, etc.) IMPORTANT: For card payments, collecting card numbers directly via API requires PCI compliance and special account permissions. Consider using Stripe.js, Stripe Elements, or mobile SDKs instead for better security and easier PCI compliance. This action is most useful for non-card payment methods or when you have explicit authorization for raw card data access.

Input Parameters

object
Card payment method details.
string
required
Payment method type. Examples: card, sepa_debit, us_bank_account, paypal, klarna, acss_debit, au_becs_debit, bacs_debit, boleto, fpx, ideal, p24, etc.
object
Boleto payment method details.
object
Klarna payment method details.
object
Key-value pairs for storing custom information.
object
Canadian pre-authorized debit payment method details.
object
UK Bacs Direct Debit payment method details.
object
SEPA Direct Debit payment method details.
object
Australian BECS Direct Debit payment method details.
object
Radar fraud detection options.
string ("always" | "limited" | "unspecified")
Controls display in future checkout flows. Default: unspecified.
object
Billing information associated with the PaymentMethod.
object
US Bank Account payment method details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PAYMENT_METHOD_CONFIGURATIONCreates a payment method configuration to control which payment methods are displayed during checkout. Use when setting up payment options for customers.

Input Parameters

object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
Configuration for a specific payment method.
string
Configuration name (max 100 characters). Required unless ‘parent’ is provided.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
string
Parent configuration ID for creating child configurations (max 100 characters). Required unless ‘name’ is provided.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PAYMENT_METHOD_DOMAINTool to create a payment method domain object to control where payment methods are shown. Use when registering a new web domain with Stripe to enable payment processing capabilities.

Input Parameters

boolean
Whether this payment method domain is enabled. If the domain is not enabled, payment methods that require a payment method domain will not appear in Elements or Embedded Checkout. Defaults to true when not specified.
string
required
The domain name that this payment method domain object represents. This is the web domain you want to register with Stripe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PII_TOKENTool to create a single-use token representing PII (personally identifiable information). Use when you need to securely tokenize sensitive personal information like ID numbers for compliance or security purposes.

Input Parameters

object
required
Container object for the PII information to tokenize.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PLANTool to create a recurring billing plan with flexible pricing configuration. Use when setting up subscription plans with defined pricing, currency, and billing intervals.

Input Parameters

string
Custom plan identifier. Must be unique across account.
string
Meter ID tracking metered price usage.
array
Pricing tiers. Required if billing_scheme is ‘tiered’.
boolean
Whether the plan is available for new subscriptions. Defaults to true.
integer
A positive integer in cents (or 0 for a free plan) representing how much to charge. Required for standard billing unless using tiered billing.
string
Product ID (string) or inline product object containing product details. Required if amount is provided.
string
required
Three-letter ISO currency code in lowercase. Must be a supported currency.
string ("day" | "week" | "month" | "year")
required
Billing frequency. Must be one of: day, week, month, or year.
object
Custom key-value pairs for storing additional information.
string
Brief description of the plan, hidden from customers.
string ("graduated" | "volume")
Tiering mode. Required if billing_scheme is ‘tiered’. Either ‘graduated’ or ‘volume’.
string ("licensed" | "metered")
Usage billing mode. Either ‘licensed’ (default) or ‘metered’.
string
Decimal alternative to amount (max 12 decimal places). Mutually exclusive with amount.
string ("per_unit" | "tiered")
Pricing computation method. Either ‘per_unit’ (default) or ‘tiered’.
integer
Billing frequency multiplier. Maximum 3-year interval.
object
Usage transformation rules for the plan.
integer
Default trial duration in days for new subscriptions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PREVIEW_INVOICETool to preview an upcoming invoice without creating it. Use when you need to show pending charges, renewal fees, discounts, and prorations before finalizing an invoice.

Input Parameters

object
Connected account issuing invoice.
string
Three-letter ISO currency code (e.g., usd, eur)
string
Customer ID for the invoice preview. Required when using invoice_items, subscription_details.items, or schedule_details.phases. You must also provide at least one of: subscription, subscription_details.items, schedule, schedule_details.phases, or invoice_items.
string
Subscription schedule ID to preview
array
Discounts to apply to the invoice preview
string
Connected account ID for invoice presentation
string
Preview mode: next (default) or recurring
string
Subscription ID to preview
object
Configuration for automatic tax calculation.
array
Invoice items to include in preview (up to 250)
string
Account representing the customer
object
Explicit customer details for preview.
object
Subscription configuration for preview.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PRICECreates 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.

Input Parameters

array
A list of pricing tiers. Required if billing_scheme is ‘tiered’.
boolean
Whether the price can be used for new purchases. Defaults to true.
string
The ID of the product this price is for. Required if product_data is not provided.
string
required
Three-letter ISO currency code (e.g., ‘usd’, ‘eur’). Must be a supported currency.
object
A set of key-value pairs to store additional information about the price.
string
A brief, internal-facing description of the price. Useful for distinguishing prices in listings.
object
Specifies recurring components of a price, such as billing interval and usage type.
string
A unique, user-defined key to retrieve this price. Case-sensitive.
string
Defines how the quantity is applied to the tiers. Either ‘graduated’ (price is sum of costs from applicable tiers) or ‘volume’ (price is determined by the tier corresponding to the total quantity). Required if billing_scheme is ‘tiered’.
integer
The base charge amount in the smallest currency unit (e.g., cents for USD). Required if not using tiers, custom_unit_amount, or currency_options with a unit amount for the primary currency.
object
Fields for creating a new product if a product ID is not provided with the price.
string
Specifies how tax is applied to the price. Options are ‘inclusive’ (tax is included), ‘exclusive’ (tax is added), or ‘unspecified’.
string
Describes how to compute the price per period. Either ‘per_unit’ (default, for fixed price per unit) or ‘tiered’ (for volume-based or graduated tiers).
object
Prices defined in each supported currency. Useful for multi-currency pricing. The primary currency’s pricing can also be defined here.
object
Configuration for a price where the unit amount is set by the customer at checkout.
object
Contains information about how the quantity should be transformed before calculating the price.
boolean
If true, allows this price to overwrite an existing price with the same lookup_key. Defaults to false.
string
Same as unit_amount, but accepts a decimal string with up to 12 decimal places for higher precision. Required if not using tiers, custom_unit_amount, or currency_options with a unit amount for the primary currency and unit_amount is not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PRODUCTCreates a new product in Stripe, encoding the request as application/x-www-form-urlencoded by flattening nested structures.

Input Parameters

string
Optional unique product identifier. Stripe generates one if omitted. Useful for idempotency or migrating existing IDs.
string
Publicly accessible URL for the product’s webpage or landing page.
string
required
Product’s name, displayed to customers.
boolean
Indicates if the product is available for purchase. Set to false to archive.
array
Up to 8 image URLs for display on product pages or checkout.
object
Key-value pairs for storing additional structured information.
string
Stripe tax code ID for determining tax rates on sales.
boolean
Indicates if the product is a physical good requiring shipping.
string
Label for product units to clarify quantity-based pricing.
string
Product description, displayed to customers, providing more details.
array
Custom fields displayed on invoices for sales (e.g., PO numbers).
object
Defines the shipping cost for the product, either by referencing an existing shipping rate or creating a new one.
object
Data used to create a new Price object as the default price for this product.
array
List of marketing features; short, benefit-oriented statements for pricing pages.
object
The dimensions of the product for shipping purposes. Required if the product is shippable and you use a shipping rate that calculates shipping costs based on dimensions.
string
String (max 22 chars) for customer credit card statements for charge recognition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_PROMOTION_CODETool to create a promotion code linked to an underlying coupon. Use when you need to generate customer-redeemable codes with optional restrictions.

Input Parameters

string
The customer-facing code (alphanumeric only: a-z, A-Z, 0-9). Maximum 500 characters. Auto-generated if omitted. Must be unique across all active promotion codes.
boolean
Whether the promotion code is currently active. Defaults to true if not specified.
string
required
ID of the coupon that this promotion code will apply. This is required.
string
ID of the customer that this promotion code can be used by. If not set, the promotion code can be used by all customers.
object
Set of key-value pairs that you can attach to an object. Useful for storing additional information in a structured format.
integer
Unix timestamp specifying when the promotion code will expire. Cannot exceed the coupon’s redeems_by timestamp if specified.
object
Settings for restricting the promotion code’s redemption.
integer
A positive integer specifying the number of times the promotion code can be redeemed. Cannot exceed the coupon’s max_redemptions if set.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_QUOTETool to create a Stripe quote modeling prices and services for a customer. Use when you need to generate a formal quote for a customer before finalizing payment.

Input Parameters

Footer text for quote PDF. Maximum 500 characters.
string
Header text for quote PDF. Maximum 50 characters.
string
Customer ID the quote belongs to. Customer or customer_account required before finalizing.
object
Key-value pairs for storing additional structured information.
array
Discounts to apply to the quote.
integer
Future Unix timestamp when open/draft quote will be automatically canceled.
object
Clone an existing quote.
array
Line items being quoted.
string
Test clock ID for testing time-dependent functionality.
string
Description text for quote PDF. Maximum 500 characters.
string
Account ID to charge on behalf of.
object
Configuration for Stripe’s automatic tax calculation on the quote.
object
Transfer data for Stripe Connect.
string
Account ID for the quote. Customer or customer_account required before finalizing.
object
Invoice settings for the quote.
string
Payment collection method. One of: charge_automatically, send_invoice. Defaults to charge_automatically.
array
Tax rate IDs applying to line items without specific rates.
object
Configuration for subscription when quote is accepted.
integer
Application fee amount in cents. Incompatible with recurring prices.
number
Fee percentage (0-100, two decimals max). Requires recurring prices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_REFUNDCreates a full or partial refund in Stripe, targeting either a specific charge ID or a payment intent ID.

Input Parameters

integer
Amount in smallest currency unit (e.g., 1000 for $10.00 USD) to refund. If omitted, a full refund is issued. Cannot exceed the charge’s remaining refundable amount.
string
Identifier of the charge to refund. Required if payment_intent is not provided.
string ("duplicate" | "fraudulent" | "requested_by_customer")
Reasons for issuing a refund in Stripe.
object
Key-value pairs to attach to the refund, for storing structured information like order numbers or internal IDs.
string
Identifier of the PaymentIntent to refund. Required if charge is not provided.
boolean
Reverse an associated transfer? Reversal is proportional to refund amount. Applies if the original charge had a reversible transfer.
boolean
Refund the application fee? If true, full refunds refund the entire fee; partials refund proportionally. Applies if the original charge had an application fee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_REPORT_RUNCreates a new report run object and begins executing the report asynchronously. Use when you need to generate Stripe reports such as balance summaries or itemized transaction reports.

Input Parameters

object
Parameters for the report run configuration.
string
required
The ID of the desired report type to run (e.g., ‘balance.summary.1’). This determines what data the report will contain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_REVERSAL_TAX_TRANSACTIONCreates a reversal of an existing tax transaction. Use when you need to fully or partially reverse tax calculations, either for full refunds or specific line items.

Input Parameters

string ("full" | "partial")
required
Reversal mode: ‘full’ to fully reverse the original transaction, or ‘partial’ to reverse specified line items, shipping cost, or a flat amount.
object
Set of key-value pairs for storing additional information about the reversal.
string
required
Custom unique identifier for this reversal (max 500 characters). Must be unique across all transactions.
array
Array of line item reversals for partial mode. Required for partial mode if flat_amount and shipping_cost are not provided.
integer
Single amount to reverse across the entire transaction in smallest currency unit (must be negative). Required for partial mode if line_items and shipping_cost are not provided.
object
Shipping cost reversal details for partial reversals.
string
required
ID of the Tax Transaction to reverse.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SETUP_INTENTCreates a SetupIntent object to collect payment method permissions for future payments. Use when setting up payment methods for subscriptions or saving cards for later use.

Input Parameters

string ("off_session" | "on_session")
Indicates future payment method use. Values: off_session (default), on_session.
boolean
Set to true to immediately confirm this SetupIntent. Defaults to false. When confirming, you should provide return_url for card authentication.
string
Customer ID this SetupIntent belongs to. Payment method will be attached to Customer on successful setup.
object
Key-value pairs for storing structured additional information.
string
URL to redirect customer after authentication/cancellation. Only with confirm=true.
object
Configuration for single-use mandates.
string
Arbitrary string attached to the object, useful for displaying to users.
object
Mandate creation details for the SetupIntent.
string
Stripe Account ID created for this SetupIntent.
boolean
Attaches payment method to in-context Stripe Account for InboundTransfer/OutboundTransfers only. Cannot be true when setting up for a Customer.
string
ID of payment method (PaymentMethod, Card, or saved Source) to attach.
boolean
Set true when confirming server-side with Stripe.js, iOS, or Android SDKs.
array
Indicates money movement direction. Values: inbound (pull funds from), outbound (send funds to).
string
Account ID this SetupIntent belongs to. Payment method attaches to Account on successful setup.
string
ID of ConfirmationToken used to confirm this SetupIntent.
object
Creates PaymentMethod set as payment_method value. Must include ‘type’ field (e.g., ‘card’, ‘sepa_debit’).
array
List of payment method types (e.g., ‘card’, ‘sepa_debit’) to accept. Stripe dynamically shows relevant methods if omitted and automatic_payment_methods is enabled.
object
Payment method-specific configuration with subkeys for: acss_debit, bacs_debit, card, klarna, paypal, payto, sepa_debit, us_bank_account.
object
Configuration for automatic payment methods.
string
ID of payment method configuration. Maximum length: 100 characters.
array
Payment method types to exclude from this SetupIntent. Examples: ‘card’, ‘sepa_debit’, ‘us_bank_account’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SHIPPING_RATECreates a fixed-amount Stripe shipping rate for defining shipping costs, with a customer-facing display name.

Input Parameters

string
The type of calculation to use on the shipping rate. Currently only supports fixed_amount.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string
A tax code ID. The Shipping tax code is txcd_92010001.
string
required
Customer-facing name of the shipping rate, meant to be displayable to the customer. Maximum 100 characters.
object
required
Describes a fixed amount to charge for shipping. Required when type is fixed_amount.
string ("inclusive" | "exclusive" | "unspecified")
Specifies whether the rate is considered inclusive of taxes or exclusive of taxes. One of: inclusive, exclusive, or unspecified. Once specified, it cannot be changed.
object
Model for estimated delivery timeframe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SOURCETool to create a Stripe source object for accepting payment methods. Use when you need to process payments through various payment methods like cards, bank transfers, or redirect-based payment systems.

Input Parameters

string
Authentication flow type: ‘redirect’, ‘receiver’, ‘code_verification’, or ‘none’.
string
Source type to create (e.g., ‘card’, ‘ach_credit_transfer’). Required unless customer and original_source are provided for cloning.
object
Payment instrument owner information.
string
Token for source creation (e.g., from Stripe.js).
string
Source usage type: ‘reusable’ or ‘single_use’.
integer
Transaction amount in smallest currency unit (e.g., cents). Mandatory for single_use sources; unsupported for receiver type sources.
object
Bank debit mandate details for recurring payments.
string
Three-letter ISO currency code (e.g., ‘usd’, ‘eur’).
object
Key-value pairs for storing additional structured information.
object
Receiver flow parameters (required if flow is ‘receiver’).
object
Redirect flow parameters (required if flow is ‘redirect’).
object
Order items and shipping details.
string
Text displayed on customer’s bank or card statement.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SUBSCRIPTIONCreates a new, highly configurable subscription for an existing Stripe customer, supporting multiple items, trials, discounts, and various billing/payment options.

Input Parameters

array
required
List of items (products/services and pricing) for the subscription.
string
Three-letter ISO currency code (lowercase) for the subscription.
string
required
ID of the existing Stripe customer.
object
Key-value pairs for additional information about the subscription.
integer
Unix timestamp to schedule subscription cancellation.
array
List of discounts for the entire subscription.
integer
Unix timestamp for trial end. Overrides plan trial period. During the trial, no payment is required - this allows creating subscriptions without a payment method. Can be up to two years from billing cycle anchor.
string
Arbitrary string describing the subscription.
boolean
Allow initial payment attempt off-session (without direct customer interaction).
string
Stripe Connect account ID for attributing payments (if charging on behalf of).
object
Settings for Stripe’s automatic tax calculation.
object
Data to specify a funds transfer to a connected Stripe account as part of this subscription.
integer
Days until invoice is due (for send_invoice collection method).
string
ID of default payment source (deprecated; use default_payment_method).
string
ID of the promotion code to apply.
object
Settings related to the subscription’s trial period, specifically how it should end.
boolean
Inherit trial period from the plan of the first item.
object
Custom settings for invoices generated for this subscription.
string ("allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete")
Behavior when initial payment fails or requires SCA (e.g., 3D Secure authentication). Options: ‘allow_incomplete’ (default) - creates subscription with status=‘incomplete’ if the first invoice can’t be paid; ‘default_incomplete’ - creates subscription with status=‘incomplete’ when payment is required, otherwise starts as active; ‘error_if_incomplete’ - returns HTTP 402 error if payment fails; ‘pending_if_incomplete’ - only valid for updates. Note: This parameter controls payment failure handling, not whether a payment method is required. To create subscriptions without a payment method, use trial_period_days or collection_method=‘send_invoice’.
object
Advanced payment settings for the subscription, including payment method options.
array
One-time invoice items for the first invoice.
string ("charge_automatically" | "send_invoice")
How to collect payment. ‘charge_automatically’ (default) attempts to charge customer’s payment method at billing cycle end. ‘send_invoice’ emails an invoice with payment instructions - subscriptions using this method activate regardless of first invoice status and don’t require a payment method.
array
List of default tax rate IDs, overridable at item level.
integer
Number of days for the trial period. During the trial, no payment is required - this allows creating subscriptions without a payment method attached. Payment will be collected when the trial ends.
object
Subscription-level billing thresholds for metered billing.
string ("always_invoice" | "create_prorations" | "none")
How to handle prorations on subscription changes.
integer
Unix timestamp to backdate the subscription’s start.
integer
Unix timestamp to anchor the subscription’s billing cycle.
boolean
Cancel the subscription at the end of the current billing period.
string
ID of the default payment method for this subscription (must be attached to customer). Not required if: (1) using trial_period_days or trial_end for trial subscriptions, or (2) using collection_method=‘send_invoice’ for invoice-based billing.
number
Percentage (0-100) of subscription amount as an application fee for the platform.
object
Configure the billing cycle anchor using a specific day, hour, minute, etc.
object
Configuration for generating pending invoice items for usage-based billing.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SUBSCRIPTION_ITEMTool to add a new item to an existing subscription without changing existing items. Use when adding a product or service to a customer’s subscription.

Input Parameters

string
The ID of the price object. Either price or price_data is required.
object
Set of key-value pairs for storing structured data.
integer
The quantity you’d like to apply to the subscription item.
array
The coupons or promotion codes to redeem.
array
List of Tax Rate IDs to override subscription default.
object
Data for generating a new Price object inline.
string
required
The identifier of the subscription to modify.
integer
Unix timestamp used to calculate proration amounts.
string ("allow_incomplete" | "default_incomplete" | "pending_if_incomplete" | "error_if_incomplete")
Payment behavior options for handling incomplete payments.
object
Billing threshold configuration.
string ("always_invoice" | "create_prorations" | "none")
Determines how to handle prorations. Default is create_prorations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_SUBSCRIPTION_SCHEDULETool to create a new subscription schedule for managing subscription changes over time. Use when you need to schedule future subscription modifications, phase transitions, or automate subscription lifecycle management.

Input Parameters

array
Billing phase configurations
string
Customer identifier for the schedule
object
Custom key-value data
string
Schedule start time; use ‘now’ for immediate start or Unix timestamp
object
Controls prorations and invoice calculation.
string
End behavior. Values: ‘release’ (continue subscription) or ‘cancel’ (terminate)
string
Account identifier for the schedule
object
Schedule-wide defaults.
string
Migrate existing subscription to schedule

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TAX_CALCULATIONCreates a Tax Calculation to compute taxes for customer purchases. Use when you need to calculate taxes for a transaction before finalizing it, such as displaying tax amounts in a shopping cart.

Input Parameters

string
required
Three-letter ISO currency code in lowercase. Must be a supported currency. All amounts in the calculation must use this currency.
string
ID of an existing Stripe Customer. If provided, the customer’s address and tax IDs will be used. Cannot be used together with ‘customer_details’.
integer
Unix timestamp specifying the date for which tax rules and rates should apply. Defaults to the current date if not provided.
array
required
List of line items the customer is purchasing. At least one line item is required. Each line item must have a unique ‘reference’.
object
Shipping cost for tax calculation.
object
Extended customer details including tax IDs.
object
Shipping origin details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TAX_IDCreates a new tax ID for an account or customer. Use when you need to add tax identification for compliance and invoicing purposes.

Input Parameters

string
required
Type of the tax ID. Supports 100+ types including: ad_nrt, ae_trn, al_tin, am_tin, ao_tin, ar_cuit, au_abn, au_arn, aw_tin, az_tin, ba_tin, bb_tin, bd_bin, bf_ifu, bg_uic, bh_vat, bj_ifu, bo_tin, br_cnpj, br_cpf, bs_tin, by_tin, ca_bn, ca_gst_hst, ca_pst_bc, ca_pst_mb, ca_pst_sk, ca_qst, cd_nif, ch_uid, ch_vat, cl_tin, cm_niu, cn_tin, co_nit, cr_tin, cv_nif, de_stn, do_rcn, ec_ruc, eg_tin, es_cif, et_tin, eu_oss_vat, eu_vat, gb_vat, ge_vat, gn_nif, hk_br, hr_oib, hu_tin, id_npwp, il_vat, in_gst, is_vat, jp_cn, jp_rn, jp_trn, ke_pin, kg_tin, kh_tin, kr_brn, kz_bin, la_tin, li_uid, li_vat, ma_vat, md_vat, me_pib, mk_vat, mr_nif, mx_rfc, my_frp, my_itn, my_sst, ng_tin, no_vat, no_voec, np_pan, nz_gst, om_vat, pe_ruc, ph_tin, ro_tin, rs_pib, ru_inn, ru_kpp, sa_vat, sg_gst, sg_uen, si_tin, sn_ninea, sr_fin, sv_nit, th_vat, tj_tin, tr_tin, tw_vat, tz_vat, ua_vat, ug_tin, us_ein, uy_ruc, uz_tin, uz_vat, ve_rif, vn_tin, za_vat, zm_tin, zw_tin
object
Owner information for the tax ID.
string
required
The value of the tax ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TAX_RATETool to create a new tax rate in Stripe. Use when you need to define a tax rate for invoices, subscriptions, or checkout sessions.

Input Parameters

string
ISO 3166-2 subdivision code without country prefix (e.g., ‘NY’ for New York).
boolean
Whether the tax rate is active. Inactive rates cannot be used with new applications but continue to work for existing subscriptions. Defaults to true.
string
Two-letter ISO 3166-1 alpha-2 country code (e.g., ‘US’, ‘CA’).
object
Set of key-value pairs for storing additional structured information.
string
The type of tax. One of: amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, retail_delivery_fee, rst, sales_tax, service_tax, or vat.
boolean
required
Whether the tax is included in the price (true) or added on top (false).
number
required
The tax percentage value (e.g., 8.5 for 8.5%). This value is out of 100.
string
An arbitrary string for internal use only. Not displayed to customers.
string
required
The display name of the tax rate shown to users. Maximum 50 characters.
string
The jurisdiction for the tax rate. Maximum 50 characters. Displayed on customer invoices for reporting purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TAX_REGISTRATIONCreates a new Tax Registration object to enable tax collection in specified jurisdictions. Use when setting up tax collection for a new country, state, or province.

Input Parameters

string
required
Two-letter ISO 3166-1 alpha-2 country code where tax collection will be enabled (e.g., ‘US’, ‘CA’, ‘GB’, ‘DE’).
integer
Optional Unix timestamp in seconds when the registration becomes inactive. Omit for indefinite validity.
string
required
Activation time for the registration. Use ‘now’ for immediate activation or provide a future Unix timestamp in seconds for scheduled activation.
object
required
Country-specific configuration object. The key must match the country code. Value contains type-specific configuration (e.g., for US: includes ‘state’ and ‘type’; for EU: includes ‘type’ and ‘standard’ config when type=‘standard’; for CA: includes ‘type’ and optional nested configs).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TAX_TRANSACTION_FROM_CALCULATIONTool to create a Tax Transaction from a calculation before 90-day expiration. Use when you need to finalize tax calculations and create a permanent transaction record.

Input Parameters

object
Key-value pairs for storing additional information. Individual or all keys can be cleared by posting empty values.
integer
Unix timestamp when tax liability is assumed/reduced. Must be between tax_date and current time. Defaults to current time if not specified.
string
required
Custom order/sale identifier (e.g., ‘myOrder_123’). Must be unique across all transactions and reversals. Maximum length: 500 characters.
string
required
The ID of the Tax Calculation to use as input. Must be a valid, non-expired calculation (expires after 90 days).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TERMINAL_CONFIGURATIONCreates a new Configuration object for Stripe payment terminals with customizable settings. Use when setting up terminal readers with specific device configurations, offline settings, tipping options, or WiFi credentials.

Input Parameters

string
Configuration identifier name (max 100 characters).
string
WiFi network connection credentials. The structure varies based on the security type (personal_psk, enterprise_eap_peap, or enterprise_eap_tls).
object
Transaction collection settings when reader is offline.
object
On-reader tipping configuration by currency. Keys are three-letter currency codes (e.g., ‘usd’, ‘eur’). Each value contains tipping options for that currency.
object
Device-specific settings for terminal readers.
object
Customized reboot time settings.
object
Device-specific settings for terminal readers.
object
Device-specific settings for terminal readers.
object
Device-specific settings for terminal readers.
object
Reader security configuration settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TERMINAL_CONNECTION_TOKENCreates a short-lived connection token for Stripe Terminal SDK to connect to readers. Use when initializing a Terminal connection with the Stripe Terminal SDK.

Input Parameters

string
The id of the location that this connection token is scoped to. If specified the connection token will only be usable with readers assigned to that location, otherwise the connection token will be usable with all readers. Note that location scoping only applies to internet-connected readers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TERMINAL_LOCATIONCreates a new Terminal Location for managing Stripe Terminal readers. Use when you need to register a physical location where Terminal readers will be deployed.

Input Parameters

string
Phone number for the location.
object
required
The full address of the location. Country and line1 are required; city, state, and postal_code are conditionally required based on the country.
object
Set of key-value pairs that you can attach to an object for storing additional structured information.
string
A name for the location. Maximum 1000 characters.
string
The ID of a configuration that will be used to customize all readers at this location. Maximum 500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TERMINAL_READERCreates and registers a new Terminal Reader to a Stripe account at a specified location. Use this to add physical card reader devices (like Stripe S700, WisePOS E) for accepting in-person payments. The reader must first generate a registration code (enter 0-7-1-3-9 on the device) before registering via this API. For testing purposes, use simulated readers with codes ‘simulated-wpe’ or ‘simulated-s700’ in test mode only.

Input Parameters

string
Custom label given to the reader for easier identification. If no label is specified, the registration code will be used as the label.
string
required
The location ID to assign this reader to. Must be a valid Stripe Location ID.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be cleared by setting them to empty values.
string
required
A code generated by the reader used for registering to an account. For physical readers, enter the key sequence 0-7-1-3-9 on the reader to display the registration code. For testing in test mode, use ‘simulated-wpe’ or ‘simulated-s700’. Note: Simulated readers can only be registered in test mode, not live mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TEST_CLOCKTool to create a test clock for testing time-based scenarios in Stripe. Use when you need to simulate the passage of time for testing subscriptions, trials, or other time-dependent features.

Input Parameters

string
The name for this test clock. Maximum length is 300 characters.
integer
required
The initial frozen time for this test clock. Unix timestamp representing the starting point in time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TEST_CONFIRMATION_TOKENCreates a test mode Confirmation Token for server-side payment integration testing. Confirmation Tokens securely transport payment method details collected client-side to your server for confirming PaymentIntents or SetupIntents. This test helper allows you to create these tokens server-side for testing without using Stripe.js. IMPORTANT: This endpoint requires TEST MODE API keys (sk_test_…). It will fail with live mode keys. Use this only for integration testing in test mode environments. Provide either ‘payment_method’ (existing PM ID) or ‘payment_method_data’ (to create new PM).

Input Parameters

object
Shipping address and recipient information for physical goods.
string
URL to redirect customer after authenticating the payment (required for some payment methods).
string
ID of an existing PaymentMethod to attach (e.g., ‘pm_1ABC…’). Provide either this OR payment_method_data, not both.
string
Indicates how the payment method should be saved for future use. ‘off_session’ = save for future automatic charges, ‘on_session’ = save for future customer-initiated charges.
object
Data to create a new PaymentMethod inline. Only used if ‘payment_method’ is not provided. Must include ‘type’ field at minimum.
object
Payment-method-specific configuration (e.g., installment plans for cards).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TOKENTool to create a single-use CVC update token for card re-collection. Use when you need to collect an updated CVC value for a saved card, typically during payment confirmation with manual confirmation_method on a PaymentIntent.

Input Parameters

object
required
Container object for the updated CVC information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_TRANSFERCreates a transfer to move funds between Stripe accounts as part of Connect. Use when you need to move money from your platform’s balance to a connected Stripe account, such as paying out to sellers or distributing funds to connected accounts.

Input Parameters

integer
A positive integer in cents (or local equivalent) representing how much to transfer.
array
Specifies which fields in the response should be expanded.
string
required
Three-letter ISO code for currency in lowercase. Must be a supported currency.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string
An arbitrary string attached to the object. Often useful for displaying to users.
string
required
The ID of a connected Stripe account. See the Connect documentation for details.
string ("bank_account" | "card" | "fpx")
The source balance to use for this transfer.
string
A string that identifies this transaction as part of a group. See the Connect documentation for details.
string
You can use this parameter to transfer funds from a charge before they are added to your available balance.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_CREATE_USAGE_RECORDCreates a legacy usage record for a specified subscription item and timestamp. The legacy UsageRecords API requires a pre-Basil Stripe API version; availability depends on the account’s API version.

Input Parameters

string ("increment" | "set")
How to handle the usage value. ‘increment’ (default) adds to the sum (assumes aggregate_usage=sum). ‘set’ overwrites the value for aggregation modes using last_during_period or last_ever.
integer
required
The usage quantity for the specified timestamp. Must be a positive integer.
integer
required
Unix timestamp (in seconds) indicating when the usage occurred. Must fall within the current billing period, or the call will fail. A short grace period exists at billing period boundaries to account for clock drift.
string
required
The ID of the subscription item for which to create the usage record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DEACTIVATE_BILLING_ALERTTool to deactivate a billing alert, preventing it from triggering. Use when you need to stop a billing alert from monitoring usage thresholds.

Input Parameters

string
required
The unique identifier of the billing alert to deactivate. Must start with ‘alrt_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DEACTIVATE_BILLING_METERDeactivates a billing meter. Use when you need to stop a meter from accepting new events and prevent it from being attached to prices.

Input Parameters

string
required
Unique identifier for the billing meter to deactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_APPLE_PAY_DOMAINTool to delete an Apple Pay domain from a Stripe account. Use when you need to remove a previously registered Apple Pay domain. This operation is permanent and cannot be undone.

Input Parameters

string
required
The identifier of the Apple Pay domain to delete. This ID typically starts with ‘apwc_’. Maximum length: 5000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_APPS_SECRETTool to delete a secret from the Stripe Secret Store by name and scope. Use when you need to permanently remove a secret. Requests from UI extensions can only access account-scoped secrets or secrets scoped to their own user.

Input Parameters

string
required
A name for the secret that’s unique within the scope. The identifier used when the secret was created.
string ("account" | "user")
required
The scope type - either ‘account’ (accessible to all UI contexts within the account) or ‘user’ (per-user secrets). Required parameter.
string
User ID - required when scope_type is ‘user’, omitted for ‘account’ type. The user whose secret to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_COUPONTool to delete a coupon from Stripe. Use when you need to remove a coupon code, preventing new redemptions while preserving existing customer discounts.

Input Parameters

string
required
The identifier of the coupon to be deleted. Deleting a coupon removes it from the Stripe system, preventing new customers from redeeming it. Customers who have already applied the coupon retain their discount.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMERDEPRECATED: Use STRIPE_DELETE_CUSTOMERS_CUSTOMER instead. Permanently deletes an existing Stripe customer; this irreversible action also cancels their active subscriptions and removes all associated data.

Input Parameters

string
required
The ID of the customer to delete. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMER_BANK_ACCOUNTDeletes a bank account payment source from a customer. This action is irreversible — the bank account cannot be recovered once deleted. Use when you need to remove a bank account from a customer’s payment methods.

Input Parameters

string
required
The unique identifier for the bank account source to delete. Must start with ‘ba_’ followed by alphanumeric characters.
array
Specifies which fields in the response should be expanded.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMER_DISCOUNTRemoves the currently applied discount on a customer. Use when you need to remove a coupon or promotion code discount from a customer’s account.

Input Parameters

string
required
The ID of the customer whose discount will be removed. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMERS_CUSTOMERPermanently deletes a customer and cancels active subscriptions. Use when you need to remove a customer record from your Stripe account. This operation is irreversible and automatically terminates any active subscriptions.

Input Parameters

string
required
The identifier of the customer to be deleted. Must be a valid Stripe customer ID starting with ‘cus_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMER_SUBSCRIPTIONCancels a customer’s subscription immediately. Customer won’t be charged again, and subscription status becomes ‘canceled’.

Input Parameters

boolean
If true, creates a proration credit for unused time in the billing period. Default is false.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.
boolean
If true, generates a final invoice for any uninvoiced metered usage and pending proration items. Default is false.
string
required
The unique identifier of the subscription to cancel. Must start with ‘sub_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMER_SUBSCRIPTION_DISCOUNTRemoves currently applied discount from a customer’s subscription. Use when you need to remove a discount code or promotion from a specific subscription belonging to a customer.

Input Parameters

string
required
The ID of the customer. Must start with ‘cus_’ followed by alphanumeric characters.
string
required
The unique identifier of the subscription from which to remove the discount. This is the subscription ID starting with ‘sub_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_CUSTOMER_TAX_IDDeletes a customer’s tax ID object. Use when you need to remove a specific tax identification from a customer’s account.

Input Parameters

string
required
The ID of the tax ID object to delete. Must start with ‘txi_’ followed by alphanumeric characters.
string
required
The ID of the customer whose tax ID will be deleted. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_EPHEMERAL_KEYImmediately invalidate an ephemeral key. Use when you need to manually expire a short-lived API key before its automatic expiration time.

Input Parameters

string
required
The ID of the ephemeral key to invalidate. Must start with ‘ephkey_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_INVOICEPermanently deletes a draft invoice. This action cannot be undone. Use when you need to remove a draft invoice. Finalized or subscription invoices must be voided instead.

Input Parameters

string
required
The identifier of the invoice to be deleted. Must start with ‘in_’ followed by alphanumeric characters. Only draft invoices can be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_INVOICEITEMTool to delete an invoice item from Stripe. Use when removing invoice items that are not attached to invoices or attached to draft invoices.

Input Parameters

string
required
The identifier of the invoice item to be deleted. Deleting invoice items is only possible when they’re not attached to invoices, or if it’s attached to a draft invoice.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_PLANTool to delete a plan from Stripe. Use when you need to permanently remove a pricing plan. Prevents new subscribers from being added to the plan, but existing subscribers remain unaffected.

Input Parameters

string
required
The unique identifier of the plan to be deleted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_PRODUCTDelete a product. Deleting a product is only possible if it has no prices associated with it. Products with type=good cannot be deleted if they have SKUs.

Input Parameters

string
required
The ID of the product to delete. Must start with ‘prod_’ followed by alphanumeric characters. Only products with no associated prices can be deleted. Products with type=good cannot be deleted if they have SKUs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_PRODUCT_FEATURERemoves a feature from a product. Use when you need to delete a specific product feature attachment.

Input Parameters

string
required
The unique identifier for the feature to be removed (e.g., prodft_BcMBZUWCIOEgEc).
string
required
The unique identifier for the product (e.g., prod_NWjs8kKbJWmuuc).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_SUBSCRIPTION_DISCOUNTRemoves the currently applied discount on a subscription, such as a discount code or promotion. The response may include a deletion confirmation flag.

Input Parameters

string
required
The ID of the subscription from which to remove the discount. Must start with ‘sub_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_SUBSCRIPTION_ITEMDeletes a subscription item without canceling the subscription. Use when you need to remove a specific item from a customer’s subscription while keeping the subscription active.

Input Parameters

string
required
The identifier of the subscription item to be deleted.
boolean
Delete all usage records for the subscription item. Only applicable when the plan’s usage_type is metered.
integer
Sets the calculation date for proration as a Unix timestamp. Useful for matching previewed amounts from the upcoming invoice endpoint.
string ("always_invoice" | "create_prorations" | "none")
Handles proration adjustments during billing changes. Default: create_prorations. Options: always_invoice (invoice immediately), create_prorations (add proration items to next invoice), none (disable proration).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_TAX_IDDeletes an existing tax ID object. Use when you need to permanently remove a tax identification from Stripe.

Input Parameters

string
required
The ID of the tax ID to delete. Must start with ‘txi_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_TERMINAL_CONFIGURATIONPermanently deletes a Terminal Configuration object from your Stripe account. Use when you need to remove a configuration that defines how features should be configured for terminal readers.

Input Parameters

string
required
The identifier of the Configuration object to delete. Must start with ‘tmc_’ followed by alphanumeric characters or underscores.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_TERMINAL_LOCATIONTool to permanently delete a Terminal Location object from your Stripe account. Use when you need to remove a physical location where Terminal readers are no longer deployed. This operation is permanent and irreversible.

Input Parameters

string
required
The unique identifier of the Terminal Location to delete. Must start with ‘tml_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_TERMINAL_READERPermanently deletes a Terminal Reader object from your Stripe account. Use when you need to remove a reader device that is no longer in use.

Input Parameters

string
required
The ID of the Terminal Reader to delete. Must start with ‘tmr_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_TEST_CLOCKPermanently deletes a test clock from Stripe’s test environment. Use when you need to remove test clocks used for simulating time-based features.

Input Parameters

string
required
The identifier of the test clock to delete. Must start with ‘clock_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETE_V1_INVOICES_VOID_AN_INVOICETool to void a finalized Stripe invoice. Use when you need to permanently mark an invoice as void to prevent any further collection attempts. This action cannot be undone.

Input Parameters

string
required
The ID of the invoice to void. Must start with ‘in_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DELETEV1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONSTool to cancel a Stripe subscription immediately. Use when you need to permanently cancel a customer’s subscription and prevent future charges.

Input Parameters

boolean
If true, generates a proration credit for remaining unused subscription time. Defaults to false.
boolean
If true, creates a final invoice covering uninvoiced metered usage and pending proration items. Defaults to false.
string
required
The identifier of the subscription to cancel.
object
Details about the reason for cancellation. Can include ‘comment’ (string) for additional context and ‘feedback’ (enum) for customer-provided reason.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DETACH_PAYMENT_FROM_INVOICETool to detach a payment from an invoice. Use when you need to remove a payment from an invoice’s list of payments. Only works with paid or canceled PaymentIntents.

Input Parameters

string
required
The ID of the invoice from which to detach the payment.
string
The ID of the PaymentIntent to detach from the invoice. Either payment_intent or payment_record must be provided.
string
The ID of the payment record to detach from the invoice. Either payment_intent or payment_record must be provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DETACH_PAYMENT_METHODDetaches a PaymentMethod object from a Customer account. Use when you need to remove a payment method from a customer without deleting it entirely.

Input Parameters

string
required
The unique identifier of the payment method to detach from the customer. Must start with ‘pm_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DISABLE_EVENT_DESTINATIONDisables a v2 Event Destination, preventing it from receiving events. Use when you need to stop routing events to a webhook endpoint, Amazon EventBridge, or Azure Event Grid destination. This action is reversible by enabling the destination again.

Input Parameters

string
required
Unique identifier for the event destination to disable (e.g., ‘edstest_123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DOWNLOAD_FILE_CONTENTSDownload authenticated file contents when the file purpose permits it.

Input Parameters

string
required
The Stripe file ID to download. This ID typically starts with ‘file_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_DOWNLOAD_QUOTE_PDFTool to download the PDF for a finalized quote from Stripe. Use when you need to retrieve the PDF document of a quote that has been finalized.

Input Parameters

string
required
The ID of the finalized quote to download as PDF. Must start with ‘qt_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_EXPIRE_BILLING_CREDIT_GRANTExpires a billing credit grant immediately. Use when you need to terminate a credit grant before its natural expiration date.

Input Parameters

string
required
Unique identifier for the credit grant object to expire. Typically starts with ‘credgr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_EXPIRE_CHECKOUT_SESSIONTool to expire an active Stripe Checkout Session. Use when you need to prevent customers from completing an open checkout session.

Input Parameters

string
required
The ID of the checkout session to expire. Must be an active session with ‘open’ status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_FINALIZE_INVOICEFinalize a draft invoice so it becomes open/collectable (and immutable where required). Use when you need to transition an invoice from draft to open status for payment collection.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansions up to 4 levels deep.
string
required
The ID of the draft invoice to finalize. Once finalized, the invoice transitions from draft to open status, becomes immutable, and is ready for payment collection.
boolean
Controls whether Stripe performs automatic collection of the invoice. If false, the invoice’s state doesn’t automatically advance without an explicit action. Defaults to the invoice’s current auto_advance value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_FINALIZE_QUOTETool to finalize a quote in Stripe. Use when you need to transition a quote from draft status to open status, making it ready to be sent to the customer for acceptance. The quote must have a customer attached before it can be finalized.

Input Parameters

string
required
The ID of the quote to finalize. Must start with ‘qt_’.
array
Specifies which fields in the response should be expanded. For example, [‘line_items’, ‘customer’] to expand those nested objects.
integer
A future timestamp (in seconds since Unix epoch) on which the quote will be canceled if in open or draft status. If provided, this sets when the finalized quote will automatically expire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_FIND_APPS_SECRETTool to find a secret by name and scope in the Stripe Apps secret store. Use when you need to retrieve a specific secret’s details based on its name and scope.

Input Parameters

string
required
A name for the secret that’s unique within the scope.
object
required
Specifies the scoping of the secret.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_FIND_TAX_ASSOCIATIONTool to find a tax association by PaymentIntent ID. Use when you need to retrieve tax calculation and transaction details linked to a specific payment.

Input Parameters

string
required
A valid PaymentIntent identifier that links to the tax association being retrieved.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_FUND_TEST_CASH_BALANCETool to fund a test mode cash balance for a customer. Use when you need to simulate incoming bank transfers in test mode. This endpoint creates a test mode bank transfer that funds a customer’s cash balance without processing real money.

Input Parameters

integer
required
A positive integer in the smallest currency unit (e.g., 1000 for $10.00 USD). Represents the amount to fund the cash balance.
string
required
Three-letter ISO currency code in lowercase (e.g., ‘eur’, ‘usd’).
string
A description of the test funding. This simulates free-text references supplied by customers when making bank transfers.
string
required
The ID of the customer whose cash balance should be funded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNTRetrieves detailed information for the authenticated Stripe account. Use when you need to access account capabilities, requirements, settings, or business profile.

Input Parameters

array
Specifies which fields in the response should be expanded. Each item can be up to 5000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNT_CAPABILITIESRetrieves a list of capabilities for a connected Stripe account, including their statuses and requirements. The response indicates whether more capabilities are available.

Input Parameters

string
required
The unique identifier of the Stripe account for which to retrieve capabilities. Typically starts with ‘acct_’. Use ‘self’ to retrieve capabilities for the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNT_CAPABILITYRetrieves information about a specific capability for a Stripe account. Use when you need to check the status, requirements, or configuration of a capability such as card payments, transfers, or ACH payments.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansions up to 4 levels deep.
string
required
The unique identifier of the Stripe account for which to retrieve the capability. Typically starts with ‘acct_’.
string
required
The specific capability identifier to retrieve (e.g., card_payments, transfers, us_bank_account_ach_payments).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNT_PERSONRetrieves an existing person associated with a Stripe account. Use when you need to check the details, verification status, or requirements of a specific person on an account.

Input Parameters

string
required
The unique identifier of the person to retrieve. Typically starts with ‘person_’.
string
required
The unique identifier of the Stripe account. Typically starts with ‘acct_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNT_PERSONSRetrieves a list of people associated with the account’s legal entity. Use when you need to list all persons for an account, with optional filtering by relationship type.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the account whose persons will be retrieved.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ending_before=obj_foo in order to fetch the previous page of the list.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include starting_after=obj_bar in order to fetch the next page of the list.
boolean
A filter on the list of people returned based on whether these people are owners on the account.
boolean
A filter on the list of people returned based on whether these people are directors on the account.
boolean
A filter on the list of people returned based on whether these people are executives on the account.
boolean
A filter on the list of people returned based on whether these people are authorizers on the account.
A filter on the list of people returned based on whether these people are legal guardians on the account.
boolean
A filter on the list of people returned based on whether these people are the representative of the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNTS_ACCOUNTRetrieves the details of a Stripe account. Use when you need to check account properties like current requirements, live charge capability, payout eligibility, business details, or verification status.

Input Parameters

array
Specifies which fields to expand in the response. Can expand related objects and nested fields up to 4 levels deep using dot notation (e.g., ‘capabilities’, ‘external_accounts’, ‘business_profile’). Maximum depth of 4 levels.
string
required
The unique identifier of the Stripe account to retrieve. Typically starts with ‘acct_’. Use ‘self’ to retrieve the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACCOUNT_TOKENTool to retrieve a v2 Account Token by its ID. Use when you need to fetch details about a specific account token, including its creation time, expiration, and usage status. Account tokens are single-use tokens which tokenize company/individual/business information.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansions.
string
required
The unique identifier of the Account Token to retrieve. This ID typically starts with ‘tok_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ACTIVE_ENTITLEMENTTool to retrieve an active entitlement describing customer access to a feature. Use when you need to check specific entitlement details for a customer.

Input Parameters

string
required
The unique identifier of the active entitlement to retrieve.
array
Specifies which fields in the response should be expanded. The ‘feature’ field can be expanded to retrieve the full Feature object instead of just the ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_APPLE_PAY_DOMAINRetrieves details about a previously registered Apple Pay domain. Use when you need to fetch information about a specific Apple Pay domain that was registered with Stripe.

Input Parameters

string
required
The unique identifier of the Apple Pay domain object to retrieve. This ID typically starts with ‘apwc_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BALANCE_HISTORYDeprecated. Lists a page of Stripe account balance transactions, including charges, refunds, payouts, and fees, with filtering by date, currency, type, or source and cursor-based pagination.

Input Parameters

string
Filter by transaction type. Common types include: charge, refund, payout, transfer, application_fee, stripe_fee, adjustment.
integer
Maximum number of balance transactions to return (1-100). Stripe defaults to 10 if not specified.
string
Filter to only include transactions from a specific automatic payout. Provide the payout ID.
string
Filter to only include transactions associated with a specific source object ID (e.g., charge, refund, payout).
object
Filter by creation date using Unix timestamps. Accepted keys: ‘gt’, ‘gte’, ‘lt’, ‘lte’.
string
Three-letter ISO 4217 currency code in lowercase (e.g., ‘usd’, ‘eur’). Filters results to transactions in the specified currency only.
string
Cursor for pagination. A balance transaction ID that defines your place in the list; returns transactions listed before this one. Cannot be used with starting_after.
string
Cursor for pagination. A balance transaction ID that defines your place in the list; returns transactions listed after this one. Cannot be used with ending_before.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BALANCE_SETTINGSTool to retrieve balance settings for a Stripe account. Use when you need to fetch configuration options for customizing account balances and payout settings for a connected account or the authenticated account.

Input Parameters

string
The connected account ID for which to retrieve balance settings. If not provided, retrieves settings for the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BALANCE_TRANSACTIONRetrieves the balance transaction with the given ID. Use when you need detailed information about a specific balance transaction including amounts, fees, availability dates, and transaction sources.

Input Parameters

string
required
The unique identifier for the balance transaction to retrieve. Balance transaction IDs typically start with ‘txn_’.
array
Specifies which fields in the response should be expanded. For example, use [‘source’] to expand the source field to retrieve full details of the Stripe object that triggered the balance transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_ALERTRetrieves a billing alert by its unique identifier. Use when you need to fetch details of a specific billing alert that notifies when a certain usage threshold on a meter is crossed.

Input Parameters

string
required
The unique identifier of the billing alert to retrieve (e.g., alrt_12345).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_CREDIT_BALANCE_SUMMARYRetrieves the credit balance summary for a customer in Stripe Billing. This action returns the available and ledger balances for billing credits granted to a customer. You can filter by a specific credit grant, price type (metered), specific prices, or billable items. The balance summary includes one entry per currency used in the credit grants. Use Cases: - Check remaining billing credits for a customer - View credit balances for specific metered prices or products - Monitor available vs. ledger balance for billing credits - Track credit usage across different currencies

Input Parameters

object
required
Filtering criteria for the credit balance summary. Specify either ‘credit_grant’ to get balance for a specific grant, or ‘applicability_scope’ to filter by price type, specific prices, or billable items.
string
The Stripe customer ID whose credit balance summary is being retrieved. Either ‘customer’ or ‘customer_account’ must be specified. Starts with ‘cus_’.
string
The Stripe account ID representing the customer. Either ‘customer’ or ‘customer_account’ must be specified. Use this for multi-entity accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_CREDIT_BALANCE_TRANSACTIONS_IDRetrieves a credit balance transaction by its unique identifier. Use when you need to get details about a specific credit or debit transaction against a credit grant.

Input Parameters

string
required
Unique identifier for the credit balance transaction object. Typically starts with ‘cbtxn_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_CREDIT_GRANTSTool to retrieve a paginated list of billing credit grants. Use when you need to view credit allocations for customers, track promotional credits, or manage billing credits.

Input Parameters

integer
Number of objects to return per page (range: 1-100, default: 10).
string
Filter results to only include credit grants for a specific customer ID.
string
Cursor for backward pagination - credit grant ID to end before. Use for fetching the previous page.
string
Cursor for forward pagination - credit grant ID to start after. Use for fetching the next page.
string
Filter results to only include credit grants for a specific customer account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_CREDIT_GRANTS_IDRetrieves a billing credit grant by its unique identifier. Use when you need to get details about a specific credit grant allocation for a customer.

Input Parameters

string
required
Unique identifier for the credit grant object. Typically starts with ‘credgr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_METERSTool to retrieve a list of billing meters from Stripe. Use when you need to list meters with optional filtering by status and pagination support.

Input Parameters

integer
A limit on the number of billing meter objects to be returned. The value must be an integer between 1 and 100, inclusive. If not specified, the default is 10.
string ("active" | "inactive")
Filter results by meter status. Valid values are ‘active’ to return only active meters or ‘inactive’ to return only inactive meters. If not specified, returns meters of all statuses.
string
A cursor for use in pagination to fetch the previous page of results. This is an object ID that defines your place in the list. For instance, if a list request returns objects starting with ‘meter_XYZ’, your subsequent call can include ending_before=‘meter_XYZ’ to fetch the previous page.
string
A cursor for use in pagination to fetch the next page of results. This is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object’s ID is ‘meter_ABC’, your subsequent call can include starting_after=‘meter_ABC’ to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_METERS_IDRetrieves a billing meter by its unique identifier. Use when you need to fetch configuration details and settings for a specific billing meter.

Input Parameters

string
required
Unique identifier for the billing meter to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_PORTAL_CONFIGURATIONSTool to list billing portal configurations. Use when you need to retrieve portal configurations that describe the functionality and settings of the customer portal.

Input Parameters

integer
Maximum number of configuration objects to return. Value must be between 1 and 100. Defaults to 10 if not specified.
boolean
Filter configurations by active status. Set to True to return only active configurations, or False for inactive ones.
boolean
Filter by default configuration. Set to True to return only the default configuration, or False for non-default configurations.
string
Cursor for pagination to fetch the previous page. Provide the ID of the configuration that should end the list.
string
Cursor for pagination to fetch the next page. Provide the ID of the configuration that should start the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_BILLING_PORTAL_CONFIGURATIONS_CONFIGURATIONTool to retrieve a billing portal configuration from Stripe. Use when you need to fetch details about a specific portal configuration including branding, features, and settings.

Input Parameters

string
required
The unique identifier for the billing portal configuration, typically starting with ‘bpc_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CHARGES_CHARGE_DISPUTETool to retrieve a dispute for a specified charge. Use when you need to get dispute details associated with a specific charge ID.

Input Parameters

string
required
Identifier for the charge, typically starting with ‘ch_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CHARGES_CHARGE_REFUNDS_REFUNDTool to retrieve the details of an existing refund within a specific charge. Use when you need to get refund information using both the charge ID and refund ID.

Input Parameters

string
required
The identifier of the charge that contains the refund. This ID typically starts with ‘ch_’.
array
Specifies which fields in the response should be expanded. Expandable fields include: balance_transaction, charge, destination_details, failure_balance_transaction, next_action, payment_intent, presentment_details, source_transfer_reversal, transfer_reversal.
string
required
The identifier of the refund to retrieve. This ID typically starts with ‘re_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CHECKOUT_SESSIONS_SESSION_LINE_ITEMSTool to retrieve line items for a Checkout Session. Use when you need to view the items, pricing, quantities, and totals for a specific checkout session.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the Checkout Session.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CLIMATE_PRODUCTS_PRODUCTTool to retrieve details of a specific Stripe Climate product. Use when you need to get information about a particular carbon removal product including pricing and supplier details.

Input Parameters

string
required
The unique identifier of the Climate product to retrieve (e.g., ‘climsku_planetary_2027’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CLIMATE_SUPPLIERS_SUPPLIERRetrieves detailed information about a specific Stripe Climate carbon removal supplier. Returns supplier details including name, carbon removal pathway (biomass, direct air capture, or enhanced weathering), operational locations with geographic coordinates, and additional information URL. Use this to get comprehensive details about a specific supplier after obtaining supplier IDs from the list suppliers endpoint. Note: Requires Stripe Climate access. If you receive an error about submitting an account application, the Stripe account needs to apply for Climate feature access.

Input Parameters

string
required
Unique identifier of the climate supplier to retrieve. Format: ‘climsup_’ followed by supplier name. Obtain supplier IDs using the list climate suppliers endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CONFIRMATION_TOKENS_CONFIRMATION_TOKENTool to retrieve an existing ConfirmationToken object by its ID. Use when you need to access payment method details and customer information that were securely passed during the payment confirmation flow.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansions (e.g., ‘payment_intent.customer’). Maximum of four nesting levels allowed.
string
required
The unique identifier of the ConfirmationToken to retrieve. This ID typically starts with ‘ctoken_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_COUNTRY_SPECS_COUNTRYRetrieves configuration details for a specific country, including supported payment methods, required verification fields, and supported currencies. Use when you need country-specific payment capabilities.

Input Parameters

string
required
An ISO 3166-1 alpha-2 country code. Available country codes can be listed with the List Country Specs endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_COUPONRetrieves full details for an existing Stripe coupon using its unique ID. Use when you need to check coupon validity, discount details, or redemption limits.

Input Parameters

string
required
Unique identifier for the coupon to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CREDIT_NOTES_CREDIT_NOTE_LINESRetrieves the paginated list of line items for a specific credit note. Use when you need complete details of all line items associated with a credit note.

Input Parameters

integer
Maximum number of line items to return (1-100). Defaults to 10 if not specified.
string
required
The unique identifier of the credit note whose line items to retrieve.
string
Cursor for backward pagination; an object ID that defines your place in the list. Returns the page of results before this object ID.
string
Cursor for forward pagination; an object ID that defines your place in the list. Returns the page of results after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CREDIT_NOTES_IDRetrieves a credit note by its unique identifier. Use when you need to get detailed information about a specific credit note.

Input Parameters

string
required
The identifier of the credit note to be retrieved. Typically starts with ‘cn_’.
array
Specifies which fields in the response should be expanded. Supports nested expansion up to 4 levels deep (e.g., [‘customer’, ‘invoice.subscription’]). Expandable fields include: customer, invoice, refunds, lines.data.invoice_line_item, customer_balance_transaction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CREDIT_NOTES_PREVIEWTool to preview a credit note without creating it in Stripe. Use when you need to see what a credit note will contain before issuing it.

Input Parameters

string
The credit note’s memo appears on the credit note PDF. This can be useful for providing additional information to the customer.
array
Line items that make up the credit note. Each line item object can contain: type (required, one of ‘invoice_line_item’ or ‘custom_line_item’), amount, description, invoice_line_item, quantity, tax_amounts, tax_rates, unit_amount, unit_amount_decimal. At least one of amount, lines, or shipping_cost must be provided.
integer
The integer amount in cents representing the total amount of the credit note. At least one of amount, lines, or shipping_cost must be provided.
string
Reason for issuing this credit note. Possible values: ‘duplicate’, ‘fraudulent’, ‘order_change’, ‘product_unsatisfactory’.
string
required
ID of the invoice for which the credit note is being previewed. This is required to preview a credit note.
array
IDs of existing refunds to link to this credit note.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string
The type of email that should be sent for this credit note. Possible values: ‘credit_note’, ‘none’. Default is ‘credit_note’.
integer
The date when this credit note is in effect. Specified as a Unix timestamp.
integer
The integer amount in cents representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.
integer
The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
object
The shipping cost to credit. Contains shipping_rate (required if shipping_cost is provided): the ID of the shipping rate to use for this order. At least one of amount, lines, or shipping_cost must be provided.
integer
The integer amount in cents representing the amount that is credited outside of Stripe. This is used when a credit is issued via a means other than Stripe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CREDIT_NOTES_PREVIEW_LINESTool to retrieve a credit note preview’s line items from Stripe. Use when you need to see what line items would be included in a credit note before creating it.

Input Parameters

string
The credit note’s memo appears on the credit note PDF.
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
array
Line items that make up the credit note. One of amount, lines, or shipping_cost is required.
integer
The integer amount in cents representing the total amount of the credit note.
string ("duplicate" | "fraudulent" | "order_change" | "product_unsatisfactory")
Reason for issuing this credit note, one of duplicate, fraudulent, order_change, or product_unsatisfactory.
string
ID of an existing refund to link to this credit note.
string
required
ID of the invoice for which to preview credit note line items.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string ("credit_note" | "none")
The email type to send to the customer. Defaults to ‘credit_note’.
integer
The date when the credit note is in effect. Same as created unless overwritten. Unix timestamp.
integer
The integer amount in cents representing the amount to credit the customer’s balance, which will be automatically applied to their next invoice.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
integer
The integer amount in cents representing the amount to refund. If set, a refund will be created for the charge associated with the invoice.
object
Shipping cost to include in the credit note. One of amount, lines, or shipping_cost is required.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
integer
The integer amount in cents representing the amount that is credited outside of Stripe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CASH_BALANCE_TRANSACTIONSTool to retrieve a specific cash balance transaction that updated a customer’s cash balance. Use when you need to get details about a particular cash balance transaction for a customer.

Input Parameters

array
Specifies which fields in the response should be expanded. Can expand related objects.
string
required
The unique identifier for the customer. Typically starts with ‘cus_’.
string
required
The unique identifier for the cash balance transaction. Typically starts with ‘ccsbtxn_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TRANSACTIONSTool to list customer balance transactions that updated a customer’s balance. Use when you need to retrieve the history of balance changes for a specific customer.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100.
object
A filter on the list based on the object created field. The value can be a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Only return transactions that are related to the specified invoice.
string
required
The unique identifier for the customer whose balance transactions you wish to retrieve.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_BALANCE_TXNS_TXNRetrieves a specific customer balance transaction that updated the customer’s balances. Use this when you need to fetch details about a particular balance transaction for a customer.

Input Parameters

string
required
The unique identifier of the customer. Customer IDs typically start with ‘cus_’.
string
required
The unique identifier of the customer balance transaction to retrieve. Transaction IDs typically start with ‘cbtxn_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTSLists a page of bank accounts linked to a customer, with cursor-based pagination.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the customer whose bank accounts will be retrieved.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 10 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 10 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_BANK_ACCOUNTS_IDRetrieves details about a specific bank account stored on a Stripe customer. Use when you need to view bank account information for a customer.

Input Parameters

string
required
The unique identifier for the bank account to retrieve. Must start with ‘ba_’ followed by alphanumeric characters.
array
Specifies which fields in the response should be expanded. Supports expansion of related objects and nested fields up to 4 levels deep.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_CARDSLists a page of cards for a specific customer, with cursor pagination.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the customer whose cards will be retrieved.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_CARDS_IDRetrieves details about a specific card for a customer. Use when you need to view card information stored on a customer account.

Input Parameters

string
required
The ID of the card to retrieve. Must start with ‘card_’ followed by alphanumeric characters.
string
required
The ID of the customer who owns the card. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCETool to retrieve a customer’s cash balance. Use when you need to check the current cash balance for a specific Stripe customer, including available funds by currency.

Input Parameters

array
Specifies which fields in the response should be expanded. Each string in the array can be a field path to expand.
string
required
The unique identifier of the customer whose cash balance to retrieve (e.g., cus_TepEFWlTGw5ves).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_CASH_BALANCE_TRANSACTIONSTool to retrieve a list of cash balance transactions for a customer. Use when you need to view the history of cash balance changes for a specific Stripe customer, including funds added and payments applied.

Input Parameters

integer
Limit on the number of objects to return. Range: 1-100. Defaults to 10 if not specified.
string
required
The unique identifier of the customer whose cash balance transactions to retrieve. This ID typically starts with ‘cus_’.
string
Object ID for backward pagination. Retrieves the previous page of transactions before this object ID.
string
Object ID for forward pagination. Retrieves the next page of transactions after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_DISCOUNTTool to retrieve the discount currently active on a customer. Use when you need to check a customer’s active discount details.

Input Parameters

string
required
The ID of the customer whose discount should be retrieved. Must start with ‘cus_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODSRetrieves a list of payment methods for a given customer, supporting type filtering and pagination.

Input Parameters

string
Filters the list by payment method type (e.g., ‘card’, ‘sepa_debit’).
integer
Limit on the number of payment methods returned. If not specified, Stripe’s default limit (typically 10) applies.
string
required
The unique identifier of the customer whose payment methods are to be retrieved.
string
Pagination cursor; ID of the first object from a previous request to fetch the preceding page.
string
Pagination cursor; ID of the last object from a previous request to fetch the next page.
string ("always" | "limited" | "unspecified")
Filter results by the value of allow_redisplay on the payment methods.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_PAYMENT_METHODS_PAYMENT_METHODTool to retrieve a specific PaymentMethod object for a given Customer. Use when you need to get detailed information about a particular payment method associated with a customer.

Input Parameters

array
Specifies which fields in the response should be expanded. Can expand related objects like ‘customer’ or nested references. Maximum expansion depth is four levels.
string
required
The unique identifier of the customer (e.g., ‘cus_TepEFWlTGw5ves’).
string
required
The unique identifier of the payment method (e.g., ‘pm_1ShVbgQvM72TjFrbs0uPksaA’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCESTool to list sources for a specified customer. Use when you need to retrieve payment sources (cards) stored on a customer account.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the customer whose sources will be retrieved.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_SOURCES_IDTool to retrieve a specified payment source for a given customer. Use when you need to get details about a specific card, bank account, or payment source attached to a customer. Note: The Sources API is deprecated; consider using PaymentMethods API for new integrations.

Input Parameters

string
required
The ID of the source to retrieve. Can be a Card ID (starts with ‘card_’), Bank Account ID (starts with ‘ba_’), or Source ID (starts with ‘src_’).
array
Specifies which fields in the response should be expanded. For example, to expand the customer field, use [‘customer’].
string
required
The ID of the customer who owns the source. Must start with ‘cus_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_SUBSCRIPTIONSDEPRECATED: Use STRIPE_LIST_SUBSCRIPTIONS instead. List subscriptions for a specific Stripe customer. By default returns subscriptions that have not been canceled. Use the ‘status’ parameter to filter by subscription status (e.g., ‘active’, ‘all’, ‘canceled’, ‘trialing’). Returns paginated results with subscription details including items, pricing, billing cycles, and payment settings.

Input Parameters

integer
Limit on the number of subscription objects to return (1-100). Default is 10.
string
Filter subscriptions by status (e.g., ‘active’, ‘all’, ‘canceled’, ‘incomplete’, ‘incomplete_expired’, ‘trialing’, ‘past_due’, ‘unpaid’, ‘paused’, ‘ended’). By default, returns active subscriptions and excludes canceled ones.
string
required
ID of the customer whose subscriptions will be retrieved. Required.
string
Cursor for paginating backwards; provide the ID of the subscription that should end the list.
string
Cursor for paginating forwards; provide the ID of the subscription that should start the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_IDTool to retrieve a specific subscription for a customer. Use when you need to get detailed information about a customer’s subscription using both customer ID and subscription ID.

Input Parameters

string
required
The ID of the customer. Must start with ‘cus_’ followed by alphanumeric characters.
string
required
The unique identifier of the subscription to retrieve. This is the subscription ID starting with ‘sub_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_ID_DISCOUNTTool to retrieve the discount currently applied to a customer’s subscription. Use when you need to check if a subscription has an active discount and get details about the coupon or promotion code.

Input Parameters

array
Specifies which fields in the response should be expanded. For example, use ‘coupon’ to expand the coupon details within the discount object.
string
required
The ID of the customer. Must start with ‘cus_’ followed by alphanumeric characters.
string
required
The unique identifier of the subscription. This is the subscription ID starting with ‘sub_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_TAX_IDSLists a page of tax IDs, such as VAT or GST identifiers, associated with a specific Stripe customer, with cursor pagination.

Input Parameters

integer
Controls result set size, ranging from 1–100 with a default of 10.
string
required
The unique identifier for the customer whose tax IDs should be retrieved.
string
Pagination cursor. Pass a tax ID object ID to retrieve records appearing before that position in the list.
string
Pagination cursor. Pass a tax ID object ID to retrieve records appearing after that position in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_CUSTOMERS_CUSTOMER_TAX_IDS_IDTool to retrieve a specific tax ID for a customer. Use when you need to fetch details about a customer’s tax identification number.

Input Parameters

string
required
The unique identifier of the tax ID object to retrieve. This ID typically starts with ‘txi_’.
string
required
The unique identifier of the customer. This ID typically starts with ‘cus_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ENTITLEMENTS_ACTIVE_ENTITLEMENTSTool to retrieve active entitlements for a customer. Use when you need to check which features a customer currently has access to.

Input Parameters

integer
Maximum number of objects to return. Range: 1-100. Defaults to 10 if not specified.
string
required
The ID of the customer whose entitlements to retrieve. This parameter is required.
string
A cursor for use in pagination. Defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. Defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_ENTITLEMENTS_FEATURES_IDTool to retrieve a feature by ID from Stripe. Use when you need to get details about a specific entitlements feature.

Input Parameters

string
required
The unique identifier of the feature to retrieve. This ID typically starts with ‘feat_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_EVENTSRetrieves a list of Stripe events from the past 30 days with filtering and pagination. Use to track API activity and monitor webhook deliveries.

Input Parameters

string
Filter by specific event name or wildcard pattern (e.g., ‘charge.*’). Mutually exclusive with ‘types’ parameter.
integer
Maximum number of events to return (1-100). Defaults to 10 if not specified.
array
Array of up to 20 event names for filtering. Mutually exclusive with ‘type’ parameter.
object
Filter by creation date range. Use a dictionary with keys ‘gt’ (exclusive minimum), ‘gte’ (inclusive minimum), ‘lt’ (exclusive maximum), ‘lte’ (inclusive maximum) and Unix timestamp values.
string
Pagination cursor; retrieves events created before the specified event ID to fetch the previous page.
string
Pagination cursor; retrieves events created after the specified event ID to fetch the next page.
boolean
Filter by webhook delivery status. True returns successful deliveries, false returns pending or failed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_EVENTS_IDRetrieves event details for events created within the last 30 days. Use when you need to fetch webhook event information or verify event data.

Input Parameters

string
required
The unique identifier of the event to retrieve. Event IDs typically start with ‘evt_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_FILES_FILETool to retrieve details of an existing file object by its unique identifier. Use when you need to get information about a previously uploaded file.

Input Parameters

string
required
The unique identifier for the file to retrieve. This ID typically starts with ‘file_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_FINANCIAL_CONNECTIONS_SESSIONS_SESSIONRetrieves details of a Financial Connections Session by ID, including its collected accounts and requested permissions.

Input Parameters

string
required
The ID of the Financial Connections Session to retrieve (e.g., fcsess_1ShVb5QvM72TjFrbiN8vvi03).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_FX_QUOTERetrieve a specific FX (foreign exchange) Quote by its ID. FX Quotes provide exchange rates between currencies that can be locked for a period (5 minutes to 24 hours) to protect against rate fluctuations. Use this to view exchange rate details, lock status, and rate breakdowns including base rates, FX fees, and duration premiums.

Input Parameters

string
required
The unique identifier of the FX Quote to retrieve. Typically starts with ‘fxq_’.
array
Specifies which fields in the response should be expanded. Expandable fields are returned as IDs by default, but can be expanded into full objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_INVOICEITEMS_INVOICEITEMTool to retrieve the details of an invoice item using its unique identifier. Use when you need to fetch information about a specific invoice item.

Input Parameters

array
Specifies which fields in the response should be expanded. Available expandable fields include: discounts. Use dot notation for nested expansions (max depth: 4 levels).
string
required
The unique identifier for the invoice item (e.g., ii_1MtGUtLkdIwHu7ixBYwjAM00).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_INVOICE_PAYMENTS_IDTool to retrieve details of a specific Stripe invoice payment by ID. Use when you need to get information about an existing invoice payment.

Input Parameters

string
required
The unique identifier for the invoice payment to retrieve. This ID typically starts with ‘inpay_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_INVOICES_INVOICETool to retrieve a specific invoice by ID. Use when you need to get detailed information about an existing invoice.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansion up to 4 levels deep (e.g., ‘customer’, ‘subscription.default_payment_method’).
string
required
The unique identifier of the invoice to retrieve. Typically starts with ‘in_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_INVOICES_INVOICE_LINESTool to retrieve a paginated list of line items for a specific invoice. Use when you need to see the individual charges, products, or services included in an invoice.

Input Parameters

integer
Maximum number of line items to return (1-100). Defaults to 10 if not specified.
string
required
The unique identifier of the invoice whose line items to retrieve (e.g., in_1NpHok2eZvKYlo2CyeiBref0).
string
Cursor for backward pagination; a line item ID from a previous response that defines the end of the current page, used to fetch the preceding page.
string
Cursor for forward pagination; a line item ID from a previous response that defines the end of the current page, used to fetch the subsequent page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_LINKED_ACCOUNTRetrieves the details of a Linked Account object by its unique identifier. A Financial Connections Account represents an account that exists outside of Stripe, to which you have been granted some degree of access. Use this action when you need to view the configuration, balance, ownership, and other details of an existing Financial Connections account linked through Stripe.

Input Parameters

array
Optional list of fields to expand in the response. For example, pass [‘balance’] to expand the balance field into a full balance object instead of just an ID.
string
required
The ID of the Linked Account to retrieve. Must start with ‘fca_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_MANDATETool to retrieve a Stripe mandate by ID. Use when you need to get authorization details for recurring or single-use payments.

Input Parameters

array
Specifies which fields in the response should be expanded. Options include ‘payment_method’ and ‘on_behalf_of’.
string
required
Unique identifier for the mandate, typically starting with ‘mandate_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_MONTHLY_RECURRING_REVENUEReturn Stripe-defined MRR from active and past-due subscriptions as a historical time series. Requires Stripe Analytics API preview access; restricted API keys also need Data > Metrics > Read permission.

Input Parameters

string
required
End of the MRR time range as an ISO 8601 datetime with a timezone. It cannot be in the future.
object
Filter MRR by at most two supported dimensions, with at most 10 IDs per dimension.
string
Currency for monetary results, such as usd. Stripe returns values in the currency’s minor unit.
string ("price" | "product" | "customer" | "subscription")
One dimension by which to group the MRR time series.
string
IANA timezone used to determine time bucket boundaries.
string
required
Beginning of the MRR time range as an ISO 8601 datetime with a timezone. It cannot be in the future.
string ("day" | "week" | "month" | "year")
required
Time bucket size for the MRR series: day (maximum 92-day range), week (maximum 397-day range), month, or year. Month and year have no fixed range limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_ATTEMPT_RECORDS_IDTool to retrieve a specific Payment Attempt Record by ID. Use when you need to get detailed information about a particular payment attempt.

Input Parameters

string
required
The ID of the Payment Attempt Record to retrieve. Typically starts with ‘par_’.
array
Specifies which fields in the response should be expanded. Multiple fields can be specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_INTENT_AMOUNT_DETAILS_LINE_ITEMSTool to retrieve paginated line items for a PaymentIntent. Use when you need to get detailed product and service information including quantities, prices, discounts, and taxes for a specific payment intent.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, defaults to 10.
string
Cursor for backward pagination. A line item ID that defines your place in the list; returns results before this line item.
string
Cursor for forward pagination. A line item ID that defines your place in the list; returns results after this line item.
string
required
The unique identifier of the PaymentIntent to retrieve line items for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_METHODRetrieves the details of a PaymentMethod object by its unique identifier. Returns information including the payment method type (card, us_bank_account, sepa_debit, etc.), billing details, and type-specific payment information. Use this when you need to view the configuration and details of an existing payment method.

Input Parameters

array
Optional list of fields to expand in the response. For example, pass [‘customer’] to expand the customer field into a full Customer object instead of just an ID. Supports nested expansion using dot notation (e.g., [‘customer.default_source’]).
string
required
The ID of the PaymentMethod to retrieve. Must start with ‘pm_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_METHOD_CONFIGURATIONTool to retrieve a specific payment method configuration by its unique identifier. Use when you need to inspect the settings and availability of payment methods for a given configuration.

Input Parameters

string
required
The unique identifier of the payment method configuration to retrieve. This ID typically starts with ‘pmc_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_METHOD_DOMAINRetrieves details of an existing payment method domain. Use when you need to fetch information about a specific payment method domain registered with Stripe.

Input Parameters

string
required
The unique identifier of the payment method domain object to retrieve. This ID typically starts with ‘pmd_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYMENT_RECORDTool to retrieve a Payment Record from Stripe. Use when you need to access details about payments that occur on- or off-Stripe, including payment attempts and status information.

Input Parameters

string
required
The ID of the Payment Record to retrieve.
array
Specifies which fields in the response should be expanded.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PAYOUTTool to retrieve details of an existing Stripe payout. Use when you need to get information about a specific payout by its ID.

Input Parameters

string
required
The unique identifier for the payout to retrieve. This ID typically starts with ‘po_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PLANTool to retrieve a specific Stripe plan by its unique identifier. Use when you need to view plan details including pricing, billing frequency, and configuration.

Input Parameters

string
required
The unique identifier of the plan to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PRICES_PRICERetrieves detailed information for a specific Stripe price using its unique ID. Use when you need to fetch price details.

Input Parameters

string
required
The unique identifier of the price to retrieve. This ID typically starts with ‘price_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PRODUCTS_IDRetrieves detailed information for an existing Stripe product using its unique product ID. Use when you need to fetch details about a specific product.

Input Parameters

string
required
The unique identifier of the product to retrieve. This ID typically starts with ‘prod_’.
array
Specifies which fields in the response should be expanded. Supports nested expansions using dot notation (e.g., ‘default_price’). Maximum depth of four levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PRODUCTS_PRODUCT_FEATURES_IDRetrieves a specific product feature by its ID. Use when you need to get details about a particular feature attached to a product.

Input Parameters

string
required
The unique identifier for the product feature to retrieve (e.g., prodft_1ShVbUQvM72TjFrbPe5SHg0L).
string
required
The unique identifier for the product (e.g., prod_NWjs8kKbJWmuuc).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_PROMOTION_CODESRetrieves a list of promotion codes from a Stripe account with optional filters for active status, code value, coupon association, and customer restrictions. Supports cursor-based pagination.

Input Parameters

string
Only return promotion codes that have this case-insensitive code.
integer
Maximum number of promotion code objects to return (1-100). Default is 10.
boolean
Filter promotion codes by active status. If true, returns only active codes; if false, returns only inactive codes.
string
Only return promotion codes for this coupon ID.
object
Filter based on creation timestamp. Supports sub-parameters: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal) with Unix timestamp values.
string
Only return promotion codes that are restricted to this customer ID.
string
Cursor for pagination - returns objects before this object ID.
string
Cursor for pagination - returns objects after this object ID.
string
Only return promotion codes that are restricted to this account representing the customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_QUOTES_QUOTETool to retrieve a quote by ID. Use when you need to get detailed information about a specific Stripe quote, including line items, pricing, and status.

Input Parameters

string
required
The unique identifier of the quote to retrieve (e.g., qt_1ShRXLQvM72TjFrb5qBWihJc).
array
Specifies which fields in the response should be expanded as full objects. Supports nested expansion using dot notation (e.g., ‘customer’, ‘line_items.data.price’). Maximum expansion depth is 4 levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_QUOTES_QUOTE_COMPUTED_UPFRONT_LINE_ITEMSTool to retrieve computed upfront line items for a quote. Use when you need the full paginated list of upfront line items with detailed pricing information including amounts, taxes, and discounts.

Input Parameters

integer
Maximum number of line items to return (range 1-100). Defaults to 10 if not specified.
string
required
The ID of the quote to retrieve computed upfront line items for.
string
Cursor for pagination. A line item ID that defines your place in the list. Returns line items listed before this item.
string
Cursor for pagination. A line item ID that defines your place in the list. Returns line items listed after this item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_QUOTES_QUOTE_LINE_ITEMSTool to retrieve a paginated list of line items for a quote. Use when you need to get details about the items included in a specific Stripe quote.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The unique identifier of the quote (e.g., qt_1Mr7wVLkdIwHu7ixJYSiPTGq)
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_RADAR_VALUE_LISTRetrieves a specific Stripe Radar value list by its identifier. Use when you need to fetch detailed information about a value list used in Radar rules.

Input Parameters

string
required
The unique identifier of the value list to retrieve (e.g., rsl_1MrQSwLkdIwHu7ixWOGS5c8M).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_RADAR_VALUE_LIST_ITEMSTool to list all value list items from a Stripe Radar value list. Use when you need to retrieve items from a specific value list for fraud detection rules. Returns items sorted by creation date in descending order with pagination support.

Input Parameters

integer
Number of results to return per request. Range: 1-100. Defaults to 10 if not specified.
string
Filter to match items with values ‘like’ this string. Maximum length: 800 characters.
object
Filters value list items by creation date using a dictionary with keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), or ‘lte’ (less than or equal to) and Unix timestamp values (seconds since epoch).
string
required
The identifier of the parent value list to retrieve items from. Required.
string
Pagination cursor for backward navigation. Object ID to end before, used for fetching the previous page of results.
string
Pagination cursor for forward navigation. Object ID to start after, used for fetching the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_REFUNDS_REFUNDTool to retrieve details of a specific Stripe refund by ID. Use when you need to get information about an existing refund.

Input Parameters

string
required
The unique identifier for the refund to retrieve. This ID typically starts with ‘re_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_REPORTING_REPORT_RUNS_REPORT_RUNRetrieves details of an existing Report Run object. Use when you need to check the status or retrieve results of a report run.

Input Parameters

string
required
The unique identifier of the report run to retrieve. This ID typically starts with ‘frr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_REPORTING_REPORT_TYPETool to retrieve details of a specific Stripe report type by ID. Use when you need to get information about a specific reporting report type.

Input Parameters

string
required
The unique identifier for the report type to retrieve (e.g., ‘balance.summary.1’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SETUP_ATTEMPTSLists a page of SetupAttempts associated with a specific SetupIntent, with pagination support. Use it to examine the payment method setup process and any errors.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
Filter by creation date using Unix timestamps. Supported keys: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal).
string
required
Filter results to only SetupAttempts created by the specified SetupIntent ID. This parameter is required.
string
A cursor for use in pagination. Object ID that defines your place in the list to fetch the previous page.
string
A cursor for use in pagination. Object ID that defines your place in the list to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SETUP_INTENTRetrieves details of a SetupIntent by its ID; client_secret is required if a publishable API key is used.

Input Parameters

string
Client secret for the SetupIntent. Required if using a publishable key for authentication.
string
required
The unique identifier of the SetupIntent to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SHIPPING_RATETool to retrieve details of a specific Stripe shipping rate by its unique ID. Use when you need to fetch information about a particular shipping rate.

Input Parameters

string
required
Unique identifier for the shipping rate object, typically starting with ‘shr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SOURCES_SOURCERetrieves an existing source object. DEPRECATED: The Stripe Sources API has been deprecated. This action can only retrieve existing sources created before the API deprecation. For new integrations, use the Payment Methods API instead. Use this action when you need to fetch up-to-date information about a specific source that was previously created (e.g., to check its status, view owner information, or access transaction details).

Input Parameters

string
required
The unique identifier of the source to retrieve. Typically starts with ‘src_’.
string
The client secret of the source. Required if a publishable key is used to retrieve the source.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SUBSCRIPTIONRetrieves detailed information for an existing Stripe subscription using its unique ID.

Input Parameters

string
required
Unique identifier of the Stripe subscription to retrieve, typically starting with ‘sub_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SUBSCRIPTION_ITEMRetrieves detailed information for a specific subscription item using its unique ID. Use when you need to fetch subscription item details, pricing, or billing information.

Input Parameters

string
required
The identifier of the subscription item to retrieve, typically starting with ‘si_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_SUBSCRIPTION_SCHEDULES_SCHEDULERetrieve a subscription schedule using its unique identifier. Use when you need to view details of an existing schedule including phases, settings, and status.

Input Parameters

array
Specifies which fields to expand into full objects. Supports up to 4 levels of nesting. Expandable fields include: application, customer, subscription, test_clock.
string
required
The unique identifier for the subscription schedule (e.g., sub_sched_1ShRYjQvM72TjFrbIeqKLj55)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_CALCULATIONRetrieves a Tax Calculation object by its unique ID. Use when you need to access tax calculation details.

Input Parameters

string
required
Unique identifier for the Tax Calculation object to retrieve (e.g., taxcalc_1OduxkBUZ691iUZ4iWvpMApI).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_CALCULATIONS_CALCULATION_LINE_ITEMSRetrieves line items of a tax calculation as a paginated collection. Use this to see detailed tax information for each item in the calculation, including amounts, tax breakdowns, and tax rates.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the tax calculation whose line items you want to retrieve. Typically starts with ‘taxcalc_’.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ending_before=obj_foo in order to fetch the previous page of the list. Maximum 500 characters.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include starting_after=obj_bar in order to fetch the next page of the list. Maximum 500 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_CODERetrieves the details of an existing tax code. Use when you need to get information about a specific tax code by its ID.

Input Parameters

string
required
Unique identifier for the tax code object to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_IDRetrieves an account or customer tax ID object. Use when you need to get details about a specific tax identification number stored in Stripe.

Input Parameters

string
required
Unique identifier for the tax ID object to retrieve. Must start with ‘txi_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_RATETool to retrieve the details of an existing tax rate. Use when you need to fetch information about a specific tax rate by its ID.

Input Parameters

string
required
Unique identifier for the tax rate to retrieve. Typically starts with ‘txr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_REGISTRATIONTool to retrieve a specific tax registration configured for your Stripe account. Use when you need to get details about where and how taxes are collected across different jurisdictions.

Input Parameters

string
required
Unique identifier for the tax registration, typically starting with ‘taxreg_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_SETTINGSRetrieves Tax Settings for a merchant. Use when you need to fetch the tax configuration for a Stripe account.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansion (e.g., ‘data.customer’). Maximum depth of four levels for expansions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_TRANSACTIONRetrieves a Tax Transaction object by ID. Use when you need to fetch details about a specific tax transaction.

Input Parameters

string
required
The unique identifier for the tax transaction. Typically starts with ‘tax_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TAX_TRANSACTIONS_TRANSACTION_LINE_ITEMSRetrieves the line items of a committed standalone tax transaction. Use when you need to view detailed line-by-line breakdown of a tax transaction.

Input Parameters

integer
Maximum number of line items to return (1-100, default is 10 if not specified).
array
Specifies which fields in the response should be expanded to show full objects instead of IDs. Examples: ‘data.product’ to expand product details, ‘data.reversal’ to expand reversal information.
string
required
The tax transaction ID to retrieve line items for.
string
Cursor for pagination. A line item ID that defines your place in the list; returns items listed before this item. Use to fetch the previous page.
string
Cursor for pagination. A line item ID that defines your place in the list; returns items listed after this item. Use to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TERMINAL_CONFIGURATIONTool to retrieve a specific Terminal Configuration object from Stripe. Use when you need to view the detailed settings for a specific terminal configuration by its ID.

Input Parameters

string
required
The unique identifier for the terminal configuration to retrieve (e.g., ‘tmc_test_61TqpHTmP4zMHAj9T41QvM72TjFrb6To’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TERMINAL_LOCATIONTool to retrieve a Terminal Location object by ID. Use when you need to get details about a specific terminal location for managing card readers.

Input Parameters

string
required
The ID of the Terminal Location to retrieve. Typically starts with ‘tml_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TERMINAL_READERTool to retrieve a Terminal Reader object by ID. Use when you need to get details about a specific reader device for accepting payment details in Stripe Terminal.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports expandable fields like ‘location’. Maximum expansion depth is 4 levels.
string
required
The ID of the Terminal Reader to retrieve. Must start with ‘tmr_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TEST_CLOCKTool to retrieve a test clock by ID. Use when testing billing integrations by simulating time advancement in sandbox environments.

Input Parameters

string
required
The test clock identifier to retrieve. Typically starts with ‘clock_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TOKENRetrieves the token with the given ID. Use when you need to verify token details or check if a token has been used.

Input Parameters

string
required
The ID of the desired token. Card tokens start with ‘tok_’, bank tokens with ‘btok_’, and CVC update tokens with ‘cvctok_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_TRANSFER_REVERSALRetrieves a transfer reversal by its ID and the associated transfer ID. Use to inspect its amount and other details.

Input Parameters

string
required
The ID of the reversal to retrieve. This is the reversal object ID that starts with ‘trr_’.
array
Specifies which fields in the response should be expanded. Expandable fields include ‘balance_transaction’, ‘destination_payment_refund’, ‘source_refund’, and ‘transfer’.
string
required
The ID of the transfer that was reversed. This is the transfer object ID that starts with ‘tr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_UPCOMING_INVOICE_LINE_ITEMSTool to retrieve a paginated list of line items for an upcoming invoice preview. Use when you need to see detailed line items before an invoice is finalized.

Input Parameters

integer
Maximum number of line items to return (range: 1-100, default: 10).
string
Coupon ID to apply (deprecated - use discounts instead).
string
Three-letter ISO currency code for preview (defaults to customer’s currency).
string
Customer ID whose upcoming invoice line items to retrieve. Either customer, subscription, or schedule is required.
string
Schedule ID for upcoming invoice line items. Cannot be used with subscription.
array
List of discount objects to apply. Each object must contain one of: coupon, discount, or promotion_code.
string
Preview calculation type: ‘next’ for next invoice or ‘recurring’ for recurring totals.
string
Subscription ID for upcoming invoice line items. Cannot be used with schedule.
object
Settings for automatic tax lookup. Must include ‘enabled’ boolean.
string
Cursor for backward pagination; returns line items before this ID. Mutually exclusive with starting_after.
array
Invoice items to add or update (max 250 items).
string
Cursor for forward pagination; returns line items after this ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_CUSTOMERS_SEARCH_CUSTOMERSSearch Stripe customers using Stripe’s Search Query Language, including queries for email, metadata, and other attributes. Nonempty queries must contain a colon or tilde; this restriction also applies to creation-date comparisons.

Input Parameters

string
Pagination cursor for retrieving a specific page. Omit for the first page. Use the next_page value from a previous response for subsequent pages.
integer
Maximum number of results per page. Range: 1-100. Defaults to 10 if not specified.
string
required
Search query using Stripe’s Search Query Language. REQUIRED FORMAT: queries MUST use field:value or fieldvalue syntax with a supported field prefix. Bare strings without field prefixes are invalid. Searchable fields: ‘name’ (customer name), ‘email’ (email address), ‘phone’ (phone number), ‘metadata[“key”]’ (metadata values), ‘created’ (Unix timestamp). Operators: ’:’ (exact match, case insensitive), '' (substring match, min 3 chars), ’>’, ’<’, ’>=’, ’<=’ (numeric comparison for created field). Combine clauses with ‘AND’ or ‘OR’ (max 10 clauses, cannot mix AND/OR). Use ’-’ to negate. Quote string values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_DISPUTES_DISPUTESRetrieves detailed information for an existing Stripe dispute by ID. Use when you need to get complete dispute details including evidence, status, and payment information.

Input Parameters

string
required
Unique identifier for the dispute object, typically starting with ‘du_’.
array
Specifies which fields in the response should be expanded. Supports dot notation for nested expansions (e.g., ‘charge’, ‘payment_intent.customer’). Maximum nesting depth is 4 levels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_INVOICE_PAYMENTS_OVERVIEW2Tool to list invoice payments in Stripe with pagination and filtering options. Use when you need to retrieve payment records associated with invoices.

Input Parameters

integer
Maximum number of objects to return (1-100). Defaults to 10 if not specified.
string
Filter by payment status. Possible values: ‘paid’, ‘open’, or ‘canceled’.
string
The identifier of the specific invoice whose payments to retrieve.
string
Cursor for backward pagination using an object ID from a previous response.
string
Cursor for forward pagination using an object ID from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_PAYMENT_METHOD_CONFIGS_LIST_PAYMENT_METHOD2Tool to list all payment method configurations in a Stripe account. Use when you need to retrieve available payment method settings with optional pagination and filtering.

Input Parameters

integer
Number of objects to return (1-100). Default: 10.
string
Filter results by Connect application identifier. Maximum 100 characters.
string
Cursor for backward pagination. Object ID for ending point.
string
Cursor for forward pagination. Object ID for starting point.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_PAYMENT_METHOD_DOMAINSList payment method domains registered with a Stripe account, with optional filtering by domain name and enabled status. Results are paginated.

Input Parameters

integer
Limit on number of objects to return. Range: 1-100. Defaults to 10 if unspecified.
boolean
Filter by domain activation status. Disabled domains won’t display payment methods in Elements or Embedded Checkout.
string
The domain name that this payment method domain object represents. Used to filter results by specific domain.
string
Cursor for pagination. Object ID that defines your place in the list to fetch previous pages.
string
Cursor for pagination. Object ID that defines your place in the list to fetch subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_PAYMENT_METHODS_PAYMENT_METHODS2Tool to retrieve a list of PaymentMethods with filtering and pagination support. Use when you need to list payment methods, optionally filtering by customer, type, or redisplay settings.

Input Parameters

string
Filters results by payment method type (e.g., card, us_bank_account, sepa_debit). Excludes ‘custom’ type when unfiltered.
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100. Default is 10.
string
The ID of the customer whose PaymentMethods will be retrieved.
string
A cursor for reverse pagination, following similar mechanics to starting_after.
string
A cursor for pagination. If you receive 100 objects ending with obj_foo, your subsequent call can include starting_after=obj_foo to fetch the next page.
string ("always" | "limited" | "unspecified")
Filters by whether payment method can display in checkout flows. Values: ‘always’, ‘limited’, ‘unspecified’.
string
ID for retrieving Account-specific PaymentMethods.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_RADAR_EARLY_FRAUD_WARNINGS_OVERVIEWReturns a list of early fraud warnings. An early fraud warning indicates that the card issuer has notified Stripe that a charge may be fraudulent. Use when you need to review potentially fraudulent charges to decide whether to refund them proactively.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100. Default is 10.
string
Only return early fraud warnings for the charge specified by this charge ID.
object
A filter on the list based on the object created field. The value can be a timestamp, or it can be a dictionary with operators: gt, gte, lt, lte for filtering by timestamp boundaries.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_RADAR_VALUE_LISTS_OVERVIEW_RADAR_VALUE_LISTSTool to retrieve an overview of Radar value lists. Use when you need to get a list of value lists used in Stripe Radar for fraud prevention.

Input Parameters

string
The alias used to reference the value list in rules. Maximum 100 characters.
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
Filters by creation date. Use a dictionary with keys like ‘gte’, ‘lte’, ‘gt’, ‘lt’ and Unix timestamp values (e.g., {‘gte’: 1609459200, ‘lte’: 1640995200}).
string
A value contained within a value list - returns all value lists containing this value. Maximum 800 characters.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_REPORTING_REPORT_TYPES_OVERVIEW_REPORTINGLists Stripe report types available for generating reports. The response indicates whether more report types are available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_SHIPPING_RATES_OVERVIEW2Tool to retrieve an overview of shipping rates from Stripe. Use when you need a quick summary of recent shipping rates with default limit of 3.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 3 for overview.
boolean
Only return shipping rates that are active or inactive.
string
Only return shipping rates for the given three-letter ISO currency code (e.g., usd), in lowercase.
string
A cursor for use in pagination. Returns objects listed before this object ID.
string
A cursor for use in pagination. Returns objects listed after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_SUBSCRIPTION_SCHEDULES_OVERVIEW2Retrieves a list of subscription schedules with optional filtering and pagination capabilities. Use to view scheduled subscription changes for customers.

Input Parameters

integer
Number of objects to return (1-100, default: 10).
object
Filter by creation date interval using operators: gt, gte, lt, lte. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Filter results to a specific customer ID.
boolean
Returns only schedules that have not yet started.
object
Filter by cancellation date interval using operators: gt, gte, lt, lte. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
object
Filter by release date interval using operators: gt, gte, lt, lte. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
object
Filter by completion date interval using operators: gt, gte, lt, lte. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Pagination cursor for fetching previous pages. Provide the ID of the subscription schedule that should end the list.
string
Pagination cursor for fetching subsequent pages. Provide the ID of the subscription schedule that should start the list.
string
Filter results to a specific account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_TAX_CODES_TAX_CODE2Lists available Stripe tax codes for product classification, with pagination support.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_TAX_IDS_OVERVIEW2Tool to retrieve a list of tax IDs with pagination support. Use when you need to list tax IDs for accounts or customers in Stripe.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
Type of owner. One of: account, application, customer, or self. Required if filtering by owner.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
The ID of the connected account (required if owner_type=account).
string
The ID of the customer (required if owner_type=customer).
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
string
The ID of the account representing the customer (alternative to owner_customer).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V1_TAX_RATES_TAX_RATE2Tool to retrieve all tax rates with pagination support. Use when you need to list Stripe tax rates with optional filters for active status, inclusive/exclusive type, and creation date.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
boolean
Filters results to only active or inactive (archived) tax rates. When true, returns only active tax rates. When false, returns only inactive tax rates.
object
A filter on the list based on the object created field. The value can be a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ with Unix timestamp values.
boolean
Filters results for tax rates that are inclusive (tax included in price) or non-inclusive (tax added to price). When true, returns only inclusive tax rates. When false, returns only non-inclusive tax rates.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_GET_V2_CORE_EVENTS_RETRIEVE_AN_EVENTRetrieves a specific event from the Stripe V2 Core Events API, including its event details and related object reference when available.

Input Parameters

string
required
Unique identifier for the event object to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_ALL_SUBSCRIPTION_ITEM_PERIOD_SUMMARIESLists a page of legacy usage record summaries for a subscription item across billing periods, with cursor pagination. DEPRECATED: Stripe removed this endpoint in Basil; legacy usage requires a pre-Basil API version. Migrate to Stripe meters for usage-based billing.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
string
required
The ID of the subscription item whose usage record summaries to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_APPLE_PAY_DOMAINSRetrieves a list of Apple Pay domains registered with Stripe. Use when you need to fetch all registered Apple Pay domains with pagination support.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100. Defaults to 10 if not specified.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 10 objects, starting with apd_bar, your subsequent call can include ending_before=apd_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 10 objects, ending with apd_foo, your subsequent call can include starting_after=apd_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_APPLICATION_FEESReturns a list of application fees you’ve previously collected, sorted by creation date descending (newest first). Use when you need to retrieve application fees with optional filtering by charge and pagination support.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
Only return application fees for the charge specified by this charge ID.
object
A filter on the list based on the object created field. The value can be a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_APPS_SECRETSLists Stripe Apps Secret Store secrets in a specified scope, with cursor-based pagination.

Input Parameters

integer
Number of objects to return (1-100). Defaults to 10 if not specified.
string ("account" | "user")
required
The scope type - either ‘account’ (accessible to all UI contexts within the account) or ‘user’ (per-user secrets). Required parameter.
string
User ID - required when scope_type is ‘user’, omitted for ‘account’ type. The user whose secrets to retrieve.
string
A cursor for pagination - an object ID that defines your place in the list for backward navigation. Used to fetch the previous page of results.
string
A cursor for pagination - an object ID that defines your place in the list for forward navigation. Used to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_BALANCE_TRANSACTIONSLists a page of balance transactions for the connected Stripe account. Supports filtering by date range, currency, type, payout, or source, as well as cursor-based pagination.

Input Parameters

string
Only returns transactions of the given type. One of: adjustment, advance, advance_funding, anticipation_repayment, application_fee, application_fee_refund, charge, climate_order_purchase, climate_order_refund, connect_collection_transfer, contribution, inbound_transfer, inbound_transfer_reversal, issuing_authorization_hold, issuing_authorization_release, issuing_dispute, issuing_transaction, obligation_outbound, obligation_reversal_inbound, payment, payment_failure_refund, payment_network_reserve_hold, payment_network_reserve_release, payment_refund, payment_reversal, payment_unreconciled, payout, payout_cancel, payout_failure, payout_minimum_balance_hold, payout_minimum_balance_release, refund, refund_failure, reserve_transaction, reserved_funds, reserve_hold, reserve_release, stripe_fee, stripe_fx_fee, stripe_balance_payment_debit, stripe_balance_payment_debit_reversal, tax_fee, topup, topup_reversal, transfer, transfer_cancel, transfer_failure, transfer_refund, or fee_credit_funding.
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
array
Specifies which fields in the response should be expanded.
string
For automatic Stripe payouts only, only returns transactions that were paid out on the specified payout ID.
string
Only returns transactions associated with the given object.
object
Only return transactions that were created during the given date interval. Use Unix timestamps as keys: ‘gt’, ‘gte’, ‘lt’, ‘lte’.
string
Only return transactions in a certain currency. Three-letter ISO 4217 currency code, in lowercase.
string
A cursor for pagination. Returns only transactions created before this object ID.
string
A cursor for pagination. Returns only transactions created after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_BILLING_ALERTSTool to retrieve a paginated list of billing alerts. Use when you need to view billing alerts that notify when usage thresholds on meters are crossed.

Input Parameters

integer
Controls result count; ranges from 1-100 with a default of 10.
string
Filters alerts associated with a particular meter identifier.
string
Restricts results to a specific alert category. Currently supports ‘usage_threshold’ for alerts that trigger when usage on a meter exceeds a threshold.
string
Pagination cursor for retrieving prior pages using an object ID from the current response.
string
Pagination cursor for fetching subsequent pages using an object ID from the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_BILLING_CREDIT_BALANCE_TRANSACTIONSList billing credit balance transactions for a customer or customer account, with pagination and optional credit grant filtering. Use to view credit and debit transactions and track billing credit activity.

Input Parameters

integer
Number of objects to return per page (range: 1-100, default: 10).
string
Filter transactions to only include those belonging to a particular customer ID.
string
Filter transactions to only include those for a specific credit grant ID.
string
Cursor for backward pagination - object ID to end before. Use for fetching the previous page.
string
Cursor for forward pagination - object ID to start after. Use for fetching the next page.
string
Filter transactions to only include those for a specific customer account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CHARGE_REFUNDSLists refunds for a specific Stripe charge, ordered by creation time descending. Results are paginated and can be used to track refund history and audit transactions.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the charge to list refunds for. This ID typically starts with ‘ch_’.
array
Specifies which fields in the response should be expanded.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CHARGESRetrieves 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 order.

Input Parameters

integer
Maximum number of charges to return (default: 10).
object
Filters charges by creation date using a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Filters charges by the specified customer ID.
string
Cursor for pagination. A charge ID that defines your place in the list; returns charges listed before this charge. Use a charge ID from a previous response to fetch the previous page.
string
Filters charges by the specified PaymentIntent ID.
string
Cursor for pagination. A charge ID that defines your place in the list; returns charges listed after this charge. Use a charge ID from a previous response to fetch the next page.
string
Filters charges by the specified transfer group ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CHECKOUT_SESSIONSTool to retrieve a list of Stripe Checkout Sessions with pagination support. Use when you need to list checkout sessions, optionally filtering by customer, status, payment intent, or other criteria.

Input Parameters

integer
Number of results to return per page (range 1-100). Defaults to 10 if not specified.
string ("open" | "complete" | "expired")
Filter by session status.
object
Filter by creation date range using gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal) for timestamp bounds.
string
Restrict results to a specific Customer ID.
Filter by Payment Link ID that created the session.
string
Filter by associated subscription ID.
string
Pagination cursor for retrieving the previous page of results.
string
Filter by associated PaymentIntent ID.
string
Pagination cursor for retrieving the next page of results.
string
Restrict results to a specific Account ID.
string
Filter by customer email address (maximum 800 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CLIMATE_ORDERSLists Stripe Climate carbon removal orders, sorted by creation date with the most recent first. Results are paginated.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
An object ID that defines your place in the list for backward pagination. Use the ID of the first order from a previous request to fetch the previous page.
string
An object ID that defines your place in the list for forward pagination. Use the ID of the last order from a previous request to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CLIMATE_PRODUCTSLists Stripe Climate carbon removal products with supplier information and USD pricing per metric ton. Results are paginated.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects starting with clprd_abc, your subsequent call can include ending_before=clprd_abc in order to fetch the previous page of the list.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects ending with clprd_xyz, your subsequent call can include starting_after=clprd_xyz in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CLIMATE_SUPPLIERSTool to retrieve a list of available Stripe Climate supplier objects for carbon removal. Use when you need to see carbon removal providers including biomass carbon removal, direct air capture, and enhanced weathering.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects starting with clsp_abc, your subsequent call can include ending_before=clsp_abc in order to fetch the previous page of the list.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects ending with clsp_xyz, your subsequent call can include starting_after=clsp_xyz in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_COUNTRY_SPECSRetrieves a list of country specifications available in the Stripe API. Use when you need details about supported currencies, payment methods, and verification requirements for specific countries.

Input Parameters

integer
Maximum number of country spec objects to return (1-100, default is 10 if not specified).
string
Cursor for pagination. A country spec ID that defines your place in the list; returns country specs listed before this one. Use a country spec ID from a previous response to fetch the previous page.
string
Cursor for pagination. A country spec ID that defines your place in the list; returns country specs listed after this one. Use a country spec ID from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_COUPONSRetrieves a list of discount coupons from a Stripe account, supporting pagination via limit, starting_after, and ending_before.

Input Parameters

integer
Maximum number of coupon objects to return. Stripe’s default (usually 10) applies if omitted.
string
A coupon ID for pagination. Returns items created before this object.
string
A coupon ID for pagination. Returns items created after this object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CREDIT_NOTESLists Stripe credit notes with optional filtering by customer, invoice, or customer account, and pagination support.

Input Parameters

integer
Maximum number of credit note objects to return (1-100). Defaults to 10 if not specified.
object
Filter credit notes by their creation date. Use keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), ‘lte’ (less than or equal to) with Unix timestamp values to specify a range.
string
Filters credit notes to those for the specified invoice ID.
string
Filters credit notes to those for the specified customer ID.
string
Cursor for backward pagination; returns only credit notes created before this object ID.
string
Cursor for forward pagination; returns only credit notes created after this object ID.
string
Filters credit notes to those for the specified customer account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CUSTOMERSRetrieves a list of Stripe customers, with options to filter by email, creation date, or test clock, and support for pagination.

Input Parameters

string
Filters customers by a case-sensitive email address.
integer
Maximum number of customer objects to return (range 1-100). Defaults to 10 if unspecified.
object
Filters by creation date. Use a dictionary with keys like ‘gte’, ‘lte’, ‘gt’, ‘lt’ and Unix timestamp values (e.g., {‘gte’: 1609459200, ‘lte’: 1640995200}).
string
Filters customers by the specified test clock ID. If omitted, returns only live mode customers.
string
Pagination cursor; retrieves objects created before the specified object ID to fetch the previous page.
string
Pagination cursor; retrieves objects created after the specified object ID to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_CUSTOMER_SUBSCRIPTIONSTool to list all active subscriptions for a customer in Stripe. Use when you need to retrieve all subscriptions associated with a specific customer ID. Supports pagination via starting_after and ending_before cursors.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
array
Specifies which fields in the response should be expanded. For example, expand=[‘latest_invoice’] will include the full invoice object in the response.
string
required
The ID of the customer whose subscriptions will be retrieved. Must start with ‘cus_’ followed by alphanumeric characters.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_DISPUTESTool to list all disputes from a Stripe account. Use when you need to retrieve disputes with optional filtering by charge or payment intent.

Input Parameters

integer
Number of objects to return (range: 1-100, default: 10).
string
Filter results to disputes linked to a specific charge ID.
object
Filter disputes by creation date range using timestamps with keys ‘gt’, ‘gte’, ‘lt’, ‘lte’.
string
A cursor for pagination; returns only disputes created before this object ID.
string
Filter results to disputes associated with a specific PaymentIntent ID.
string
A cursor for pagination; returns only disputes created after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_ENTITLEMENTS_FEATURESRetrieves a paginated list of entitlements features from Stripe. Use when you need to list monetizable abilities or functionalities in your system that can be assigned to products.

Input Parameters

integer
A limit on the number of feature objects to be returned. The value must be an integer between 1 and 100. If not specified, the default is 10.
boolean
Narrows results to features matching the specified archive status. Set to True to return only archived features, or False for non-archived ones.
string
Filters results to features with the matching lookup_key value. Maximum 80 characters.
string
A cursor for use in pagination. Defines your place in the list. Use the ID of the first feature from the previous page to fetch the previous page.
string
A cursor for use in pagination. Defines your place in the list. Use the ID of the last feature from the previous page to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_FILESTool to retrieve a list of files that your account has access to. Use when you need to list files uploaded to Stripe, with optional filtering by purpose or creation date.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
A filter on the list based on the object created field. The value can be a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values. Use ‘gte’ for greater than or equal, ‘lte’ for less than or equal, ‘gt’ for greater than, and ‘lt’ for less than.
string
Filter queries to only return files with the given purpose. Possible values include: account_requirement, additional_verification, business_icon, business_logo, customer_signature, dispute_evidence, finance_report_run, financial_account_statement, identity_document, identity_document_downloadable, issuing_regulatory_reporting, pci_document, platform_terms_of_service, selfie, sigma_scheduled_query, tax_document_user_upload, terminal_android_apk, terminal_reader_splashscreen. If no purpose is provided, returns unfiltered files.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_FINANCIAL_CONNECTIONS_ACCOUNTSTool to list Financial Connections Account objects representing external financial accounts. Use when you need to retrieve accounts linked through Financial Connections.

Input Parameters

integer
Number of results to return. Range: 1-100, default: 10.
string
Filter to accounts collected in a specific Financial Connections session. Mutually exclusive with account_holder parameters.
string
A cursor for reverse pagination; object ID marking the list position.
object
Filter to specify which account holder’s accounts to retrieve.
string
A cursor for forward pagination; object ID marking the list position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_FORWARDING_REQUESTSLists ForwardingRequest objects from Stripe’s Vault and Forward API. ForwardingRequests are records of requests Stripe made to third-party endpoints on your behalf, with payment card details securely inserted. Use this to retrieve and audit forwarding requests, with optional filtering by creation timestamp and pagination support. Note: This API requires special account authorization. Contact Stripe support if you need access.

Input Parameters

integer
A limit on the number of objects to be returned. Range: 1-100. Default: 10.
object
Filters results by creation timestamp using comparison operators. Supported keys: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal). Values are Unix timestamps.
string
A pagination cursor to fetch the previous page of the list. Value must be a ForwardingRequest ID.
string
A pagination cursor to fetch the next page of the list. Value must be a ForwardingRequest ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_FX_QUOTESList issued FX quotes, with the most recent appearing first, for reviewing exchange rates and lock details for payments or transfers.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination that defines your place in the list for fetching prior pages. Use an FX quote ID from a previous response.
string
A cursor for use in pagination that defines your place in the list for fetching subsequent pages. Use an FX quote ID from a previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_INVOICEITEMSRetrieves a paginated list of Stripe invoice items. Use to filter by customer, invoice, creation date, or attachment status with cursor-based pagination.

Input Parameters

integer
Maximum number of invoice items to return (1-100). Defaults to 10 if not specified.
object
Filter invoice items by creation date. Use keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), ‘lte’ (less than or equal to) with Unix timestamp values to specify a range.
string
Filter by invoice ID. Only return invoice items belonging to the specified invoice.
boolean
Filter by attachment status. Set to true to return only unattached invoice items, false to return only attached items, or omit to return all items.
string
Filter by customer ID. Only return invoice items for the specified customer.
string
Cursor for backward pagination. An invoice item ID that defines where to end fetching the previous page.
string
Cursor for forward pagination. An invoice item ID that defines where to start fetching the next page.
string
Filter by customer account ID. Only return invoice items for the specified customer account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_INVOICE_PAYMENTSTool to list all payments for invoices in Stripe. Use when you need to retrieve payment information associated with invoices, including pagination and filtering by invoice ID, status, or creation date.

Input Parameters

integer
Number of objects to return (1-100). Defaults to 10 if not specified.
string
Filter by payment status. Possible values: ‘paid’, ‘open’, or ‘canceled’.
object
Filter by creation timestamp. Use keys ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal) with Unix timestamp values.
string
The invoice identifier whose payments should be returned. If omitted, returns all invoice payments.
string
Cursor for pagination; fetch results before this invoice payment ID. Use an invoice payment ID from a previous response to fetch the previous page.
string
Cursor for pagination; fetch results after this invoice payment ID. Use an invoice payment ID from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_INVOICE_RENDERING_TEMPLATESLists invoice rendering templates ordered by creation date, with cursor-based pagination.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_INVOICESRetrieves a list of Stripe invoices, filterable by various criteria and paginatable using invoice ID cursors obtained from previous responses.

Input Parameters

integer
Maximum number of invoice objects to return (1-100). Defaults to 10 if not specified.
string
Filter invoices by status: ‘draft’, ‘open’, ‘paid’, ‘uncollectible’, or ‘void’; if omitted, returns invoices with any status.
object
Filter invoices by their creation date. Use keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), ‘lte’ (less than or equal to) with Unix timestamp values to specify a range.
string
ID of the customer whose invoices to retrieve; if omitted, invoices for all customers may be returned.
string
ID of the subscription whose invoices to retrieve; if omitted, invoices for all subscriptions may be returned.
string
Cursor for backward pagination; an invoice ID from a previous response that defines the end of the current page, used to fetch the preceding page.
string
Cursor for forward pagination; an invoice ID from a previous response that defines the end of the current page, used to fetch the subsequent page.
string
Filter by collection method: ‘charge_automatically’ (Stripe attempts auto-charge) or ‘send_invoice’ (Stripe emails invoice); if omitted, returns invoices with any collection method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_METER_EVENT_SUMMARIESTool to retrieve billing meter event summaries for a customer within a time range. Use when you need aggregated meter event data for billing analysis.

Input Parameters

string
required
Unique identifier for the billing meter object.
integer
Number of objects returned (1-100, default: 10).
string
required
The customer for which to fetch event summaries.
integer
required
The timestamp from when to stop aggregating meter events (exclusive). Must align with minute boundaries. Unix timestamp in seconds.
integer
required
The timestamp from when to start aggregating meter events (inclusive). Must align with minute boundaries. Unix timestamp in seconds.
string
Cursor for backward pagination using object ID.
string
Cursor for forward pagination using object ID.
string
Specifies aggregation granularity: ‘hour’ (aligned to hour boundaries) or ‘day’ (aligned to UTC boundaries). If omitted, returns single summary for entire range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PAYMENT_ATTEMPT_RECORDSLists payment attempt records for a specified payment record, with cursor-based pagination.

Input Parameters

integer
Limit on the number of payment attempt records to be returned. Stripe API defaults to 10 if unspecified.
string
A cursor for pagination; returns only payment attempt records created before this object ID.
string
required
The ID of the Payment Record to retrieve payment attempt records for.
string
A cursor for pagination; returns only payment attempt records created after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PAYMENT_INTENTSTool to list PaymentIntents from Stripe. Use when you need to retrieve a list of payment intents with optional filtering by customer, creation date, or pagination parameters.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
Filter by creation date using Unix timestamps. Supported keys: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal).
string
Only return PaymentIntents for the customer specified by this customer ID.
string
A cursor for use in pagination. Object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ending_before=obj_foo in order to fetch the previous page of the list.
string
A cursor for use in pagination. Object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include starting_after=obj_bar in order to fetch the next page of the list.
string
Only return PaymentIntents for the account representing the customer specified by this account ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PAYOUTSLists 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.

Input Parameters

integer
Limit on the number of payouts to be returned. Stripe API defaults to 10 if unspecified. Range: 1-100.
string
Filters payouts by status. Possible values: ‘pending’, ‘paid’, ‘failed’, or ‘canceled’.
object
Filters payouts by creation date range. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Filters payouts by the external account ID (bank account or debit card) to which funds are being transferred.
object
Filters payouts by expected arrival date range. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
A cursor for pagination; returns only payouts created before this object ID.
string
A cursor for pagination; returns only payouts created after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PLANSLists billing plans from a Stripe account, with optional filters and cursor-based pagination. Use to retrieve plans for subscription management or display pricing options.

Input Parameters

integer
Maximum number of plan objects to return (range 1-100). Defaults to 10 if not specified.
boolean
Filter plans by their active status. Set to True for active plans, False for inactive plans.
object
Filter plans by creation timestamp. Accepts sub-parameters: created.gt (exclusive minimum), created.gte (inclusive minimum), created.lt (exclusive maximum), created.lte (inclusive maximum). Provide Unix timestamp values (e.g., {‘gte’: 1609459200, ‘lte’: 1640995200}).
string
Restrict results to plans associated with a specific product ID.
string
Pagination cursor for fetching the previous page. Returns objects listed before this plan ID.
string
Pagination cursor for fetching the next page. Returns objects listed after this plan ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PRICESTool to list Stripe prices. Use when you need to retrieve and filter price objects before processing write operations.

Input Parameters

string ("one_time" | "recurring")
Filter by price type: one_time or recurring.
integer
Limit number of prices returned (1-100).
boolean
Filter prices based on their active status. True returns active prices only.
array
Fields to expand in each price object.
object
Filter by creation timestamp using gt, gte, lt, or lte.
string
Filter prices for a specific product ID (e.g., ‘prod_123’).
string
Filter by three-letter ISO currency code (e.g., ‘usd’).
object
Filter by recurring fields: interval, meter, or usage_type.
array
List of lookup keys to filter prices (max 10).
string
Cursor for pagination to fetch previous page by price ID.
string
Cursor for pagination to fetch next page by price ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PRODUCTSRetrieves a list of Stripe products, with optional filtering and pagination; starting_after/ending_before cursors must be valid product IDs from a previous response.

Input Parameters

array
A list of product IDs to retrieve. If provided, only products with these specific IDs will be returned.
string
Filter products by a specific URL. Only products with this exact URL will be returned.
integer
A limit on the number of product objects to be returned. The value must be an integer between 1 and 100, inclusive. If not specified, the default is 10.
boolean
Filter products based on their active status. Set to True to return only active products, or False for inactive ones.
object
Filters products by their creation date range. Provide a dictionary with keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), or ‘lte’ (less than or equal to) and Unix timestamp values (seconds since epoch). For instance, {'gte': 1609459200, 'lte': 1640995200} filters for products created from January 1, 2021, to January 1, 2022.
boolean
Filter products based on whether they are shippable. Set to True to return only shippable products, or False for non-shippable ones.
string
A cursor for use in pagination to fetch the previous page of results. ending_before is an object ID that defines your place in the list. For instance, if a list request returns objects ending with prod_XYZ, your subsequent call can include ending_before='prod_XYZ' to fetch the previous page.
string
A cursor for use in pagination to fetch the next page of results. starting_after is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object’s ID is prod_ABC, your subsequent call can include starting_after='prod_ABC' to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PRODUCTS_PRODUCT_FEATURESRetrieves a list of features attached to a product. Returns a paginated list of product_feature objects representing attachments between features and products.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, defaults to 10 if not specified.
string
required
The ID of the product whose features you want to retrieve.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. An object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_PROMOTION_CODESTool to retrieve a list of promotion codes from Stripe. Use when you need to view, filter, or paginate through promotion codes with optional filters for active status, code, coupon, customer, or creation date.

Input Parameters

string
Only return promotion codes that have this case-insensitive code.
integer
Number of results to return (1-100, default: 10).
boolean
Filter by active/inactive status. A promotion code is only active if the coupon is also valid.
string
Filter by associated coupon ID.
object
Filter by creation timestamp. Supports sub-parameters: gt, gte, lt, lte (integer Unix timestamps).
string
Restrict results to specific customer ID.
string
Pagination cursor - ID of object to end before for backward navigation.
string
Pagination cursor - ID of object to start after for forward navigation.
string
Restrict results to customer account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_QUOTESLists Stripe quotes with pagination and optional filtering by customer, customer account, status, or test clock.

Input Parameters

integer
Maximum number of quote objects to return (1-100). Defaults to 10 if not specified.
string
Filter quotes by status: ‘draft’, ‘open’, ‘accepted’, or ‘canceled’; if omitted, returns quotes with any status.
string
ID of the customer whose quotes to retrieve; if omitted, quotes for all customers may be returned.
string
Provides a list of quotes associated with the specified test clock.
string
Cursor for backward pagination; a quote ID from a previous response that defines the end of the current page, used to fetch the preceding page.
string
Cursor for forward pagination; a quote ID from a previous response that defines the end of the current page, used to fetch the subsequent page.
string
ID of the account representing the customer whose quotes to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_RADAR_EARLY_FRAUD_WARNINGSTool to list all early fraud warnings from Stripe Radar. Use when you need to retrieve fraud warnings for charges, optionally filtered by charge ID or payment intent ID.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
Only return early fraud warnings for the charge specified by this charge ID.
object
A filter on the list based on the object created field. The value can be a dictionary with keys ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
Only return early fraud warnings for charges that were created by the PaymentIntent specified by this PaymentIntent ID.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_RADAR_REVIEWSReturns a list of Radar Review objects that have open set to true, sorted in descending order by creation date. Use when you need to retrieve reviews that require action with optional filtering and pagination support.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
A filter on the list based on the object created field. The value can be a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_REFUNDSLists Stripe refunds, sorted by creation date descending (newest first), with optional filtering by charge or payment_intent and pagination support.

Input Parameters

integer
Limit on the number of refunds to be returned. Stripe API defaults to 10 if unspecified.
string
Filters refunds to those for the specified Charge ID.
string
A cursor for pagination; returns only refunds created before this object ID.
string
Filters refunds to those for the specified PaymentIntent ID.
string
A cursor for pagination; returns only refunds created after this object ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_REPORTING_REPORT_RUNSLists Stripe Report Runs, sorted by creation date descending (newest first). Use when you need to retrieve reporting data or check the status of report generation tasks.

Input Parameters

integer
Limit on the number of report runs to be returned. Must be between 1 and 100. Defaults to 10 if not specified.
object
Filters Report Runs by creation date using a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Cursor for pagination. A report run ID that defines your place in the list; returns report runs listed before this report run. Use a report run ID from a previous response to fetch the previous page.
string
Cursor for pagination. A report run ID that defines your place in the list; returns report runs listed after this report run. Use a report run ID from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_REVIEWSRetrieves a list of open Stripe reviews with pagination support. Use when you need to access reviews that require action, sorted by creation date with most recent first.

Input Parameters

integer
Maximum number of review objects to return (range 1-100). Defaults to 10 if unspecified.
object
Filters by creation date. Use a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values (e.g., {‘gte’: 1609459200, ‘lte’: 1640995200}).
string
Pagination cursor; retrieves objects created before the specified review ID to fetch the previous page.
string
Pagination cursor; retrieves objects created after the specified review ID to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_SETUP_ATTEMPTSTool to list SetupAttempts associated with a SetupIntent. Use when you need to retrieve attempts to confirm a SetupIntent and attach a payment method to a customer.

Input Parameters

integer
Controls the number of results returned. Range: 1-100. Default: 10.
object
Filters results based on creation timestamp. Supports sub-parameters: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal) for Unix timestamp comparisons.
string
required
Filters results to only include SetupAttempts created by the specified SetupIntent ID. This parameter is required.
string
Pagination cursor for backward pagination. Object ID defining the position for fetching previous pages.
string
Pagination cursor for forward pagination. Object ID defining the starting position for fetching subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_SETUP_INTENTSTool to list SetupIntents from Stripe. Use when you need to retrieve a list of setup intents with optional filtering by customer, payment method, or pagination parameters.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
Filter by creation date using Unix timestamps. Supported keys: ‘gt’ (greater than), ‘gte’ (greater than or equal), ‘lt’ (less than), ‘lte’ (less than or equal).
string
Only return SetupIntents for the customer specified by this customer ID.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
boolean
If present, the SetupIntent’s payment method will be attached to the in-context Stripe Account.
string
Only return SetupIntents that associate with the specified payment method.
string
A cursor for use in pagination. This is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_SIGMA_SCHEDULED_QUERY_RUNSLists a page of Stripe Sigma scheduled query runs, with pagination support, to check run status or access query result information.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
array
Specifies which fields in the response should be expanded. Accepts an array of strings.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_SUBSCRIPTION_ITEMSLists subscription items for a given Stripe subscription, with pagination. Items include pricing, quantities, and billing details.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The ID of the subscription whose items will be retrieved.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_SUBSCRIPTIONSRetrieves a list of Stripe subscriptions, optionally filtered by various criteria such as customer, price, status, collection method, and date ranges, with support for pagination.

Input Parameters

integer
Limit on the number of subscription objects to return (1-100). Default is 10.
string
ID of the recurring price to filter subscriptions by.
string
Filter subscriptions by status (e.g., ‘active’, ‘all’, ‘canceled’). Defaults to non-canceled statuses if unspecified.
object
Filter subscriptions by creation date using comparison keys (e.g., ‘gte’, ‘lt’) and Unix timestamp values.
string
ID of the customer whose subscriptions will be retrieved.
string
Filter subscriptions by a specific test clock ID (only applicable in test mode).
object
Filter subscriptions by automatic tax settings, e.g., {‘enabled’: True}.
string
Cursor for paginating backwards; provide the ID of the subscription that should end the list.
string
Cursor for paginating forwards; provide the ID of the subscription that should start the list.
string
Filter subscriptions by collection method: ‘charge_automatically’ or ‘send_invoice’.
object
Filter subscriptions by the end date of the current billing period, using comparison keys (e.g., ‘gt’, ‘gte’) and Unix timestamp values.
object
Filter subscriptions by the start date of the current billing period, using comparison keys (e.g., ‘lt’, ‘lte’) and Unix timestamp values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TAX_CODESRetrieves a paginated list of globally available, predefined Stripe tax codes used for classifying products and services in Stripe Tax.

Input Parameters

integer
Maximum number of objects to return. API defaults to 10 if this parameter is omitted.
string
Object ID cursor to fetch the previous page of results.
string
Object ID cursor to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TAX_RATESRetrieves a list of tax rates, which are returned sorted by creation date in descending order.

Input Parameters

integer
A limit on the number of tax rates to be returned. The value must be between 1 and 100, inclusive. The default is 10.
boolean
Filter tax rates by their active status. Set to true for active tax rates and false for inactive (archived) tax rates.
object
Filter tax rates by their creation date. Accepts a dictionary with keys like gt (greater than), gte (greater than or equal to), lt (less than), or lte (less than or equal to), and Unix timestamp values.
boolean
Filter tax rates by whether they are inclusive. Set to true for inclusive tax rates and false for exclusive tax rates.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include ending_before=obj_foo in order to fetch the previous page of objects.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include starting_after=obj_bar in order to fetch the next page of objects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TAX_REGISTRATIONSRetrieves a paginated list of tax registrations. Use when you need to view where a business is registered to collect tax on payments within various regions.

Input Parameters

integer
Number of objects to return per request. Range: 1-100. Defaults to 10 if not specified.
string ("active" | "expired" | "scheduled" | "all")
Filter registrations by their current status. Defaults to ‘all’ if not specified.
string
Cursor for backward pagination. Object ID to fetch results before this object, used to retrieve previous pages.
string
Cursor for forward pagination. Object ID to fetch results after this object, used to retrieve subsequent pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TERMINAL_CONFIGURATIONSTool to retrieve a list of Terminal Configuration objects from Stripe. Use when you need to view all terminal configurations with optional filtering and pagination.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
boolean
If present, only return the account default or non-default configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TERMINAL_LOCATIONSRetrieves a list of Stripe terminal locations with pagination support. Use when you need to view all terminal locations for managing physical card readers.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TERMINAL_READERSTool to list all Stripe Terminal Readers with optional filtering. Use when you need to retrieve readers by device type, location, serial number, or status.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string ("offline" | "online")
A status filter to filter readers to only offline or online readers.
string
A location ID to filter the response list to only readers at the specific location.
string ("bbpos_chipper2x" | "bbpos_wisepad3" | "bbpos_wisepos_e" | "mobile_phone_reader" | "simulated_stripe_s700" | "simulated_wisepos_e" | "stripe_m2" | "stripe_s700")
Filters readers by device type. Use to retrieve only readers of a specific device model.
string
A cursor for use in pagination. Defines your place in the list for backward navigation. Use the ID of the first reader from the previous page.
string
Filters readers by serial number. Use to retrieve a specific reader by its serial number.
string
A cursor for use in pagination. Defines your place in the list for forward navigation. Use the ID of the last reader from the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TEST_CLOCKSRetrieves a paginated list of test clocks. Use when you need to view all test clocks for testing time-dependent functionality.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TOPUPSTool to retrieve a list of existing top-ups from Stripe. Use when you need to view top-ups with optional filtering by amount, status, or creation date, and pagination support.

Input Parameters

integer
Maximum number of top-ups to return (1-100, default is 10 if not specified).
object
Filters top-ups by transfer amount using a dictionary with comparison operators like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and integer values in smallest currency unit (e.g., cents).
string
Only return top-ups that have the given status. One of: canceled, failed, pending, or succeeded.
object
Filters top-ups by creation date using a dictionary with keys like ‘gt’, ‘gte’, ‘lt’, ‘lte’ and Unix timestamp values.
string
Cursor for pagination. A top-up ID that defines your place in the list; returns top-ups listed before this top-up. Use a top-up ID from a previous response to fetch the previous page.
string
Cursor for pagination. A top-up ID that defines your place in the list; returns top-ups listed after this top-up. Use a top-up ID from a previous response to fetch the next page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_TRANSFERSList all transfers sent to connected accounts. Transfers are returned in reverse chronological order. Use when you need to retrieve transfer history or monitor funds sent to connected accounts.

Input Parameters

integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
object
Filter transfers by their creation date range. Provide a dictionary with keys like ‘gt’ (greater than), ‘gte’ (greater than or equal to), ‘lt’ (less than), or ‘lte’ (less than or equal to) and Unix timestamp values (seconds since epoch). For instance, {'gte': 1609459200, 'lte': 1640995200} filters for transfers created from January 1, 2021, to January 1, 2022.
string
Only return transfers for the destination specified by this account ID.
string
A cursor for use in pagination to fetch the previous page of results. ending_before is an object ID that defines your place in the list. For instance, if a list request returns objects starting with tr_XYZ, your subsequent call can include ending_before='tr_XYZ' to fetch the previous page.
string
A cursor for use in pagination to fetch the next page of results. starting_after is an object ID that defines your place in the list. For instance, if a list request returns objects and the last object’s ID is tr_ABC, your subsequent call can include starting_after='tr_ABC' to fetch the next page.
string
Only return transfers with the specified transfer group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_V2_CORE_EVENT_DESTINATIONSRetrieves a list of event destinations from Stripe V2 Core Events API. Use when you need to list all event destinations including webhooks and EventBridge integrations.

Input Parameters

string
The requested page. Use the page token from a previous response to fetch the next page.
integer
The page size. Number of event destinations to return per page.
array
Additional fields to include in the response. Currently supports ‘webhook_endpoint.url’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_LIST_V2_CORE_EVENTSTool to list v2 core events from Stripe. Use when you need to retrieve a list of events with thin payloads containing references to changed objects. These events are unversioned and require fetching the related object for full details.

Input Parameters

string
The requested page. Use the next_page or previous_page URL from a previous response to paginate through results.
integer
The page size. Maximum number of events to return per page.
array
An array of up to 20 strings containing specific event names to filter by. Only events matching these types will be returned.
object
Timestamp range filter for event creation time.
string
Primary object ID used to retrieve related events. Filter events to only those related to this specific object.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_MARK_INVOICE_UNCOLLECTIBLETool to mark a Stripe invoice as uncollectible for bad debt accounting purposes. Use when you need to write off an unpaid invoice that is unlikely to be collected.

Input Parameters

string
required
The ID of the invoice to mark as uncollectible. Must start with ‘in_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_MIGRATE_SUBSCRIPTIONMigrates a subscription from classic to flexible billing mode to enable flexible proration and invoice calculation. Requests use Stripe API version 2025-06-30.basil.

Input Parameters

object
required
Controls how prorations and invoices are calculated and orchestrated. Type must be ‘flexible’ to migrate from classic billing mode.
string
required
The ID of the subscription to migrate from classic to flexible billing mode.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_PAY_INVOICETool to pay an invoice manually outside the normal collection schedule. Use when you need to manually trigger payment on an invoice or mark it as paid externally using paid_out_of_band parameter.

Input Parameters

string
Payment source ID belonging to the associated customer.
boolean
When true, charges available amount up to invoice total and forgives the difference if insufficient funds exist. Defaults to false.
string
required
The invoice ID to pay.
string
Mandate ID corresponding to the payment method used.
boolean
Indicates whether customer is present during payment. Defaults to true.
string
PaymentMethod ID belonging to the associated customer.
boolean
Marks invoice as paid externally without charging. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_BILLING_CREDIT_GRANTS_VOID_CREDIT_GRANTVoids a billing credit grant, preventing it from being applied to future invoices. This operation is irreversible and marks the credit grant with a voided_at timestamp.

Input Parameters

string
required
Unique identifier for the credit grant object to be voided. Typically starts with ‘credgr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_CHARGES_CHARGEUpdates a Stripe charge with the specified parameters; unspecified fields remain unchanged. Use when you need to modify charge details like customer association, description, fraud details, metadata, receipt email, shipping information, or transfer group.

Input Parameters

string
required
The ID of the charge to update.
string
ID of existing customer to associate with charge. Can only be set if no customer is currently associated.
object
Custom key-value pairs for storing additional structured information.
object
Shipping information to help prevent fraud on physical goods.
string
Arbitrary string attached to the charge, displayed in web interface and included in automatic email receipts.
object
Key-value pairs indicating charge riskiness.
string
Email address where receipt will be sent; updating triggers new email delivery.
string
String identifying transaction as part of a group. Can only be set once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_CUSTOMERS_CUSTOMER_SUBS_SUB_EXPOSED_IDUpdates an existing subscription’s items, billing cycle, payment methods, metadata, and other settings. The subscription ID selects the subscription; the supplied customer ID is not used to verify ownership.

Input Parameters

array
List of subscription item updates (max 20).
string
required
Unique identifier of the customer.
object
Key-value pairs for custom information. Replaces existing metadata.
string
Unix timestamp or enum value when subscription should cancel.
array
List of discounts for the subscription.
string
Unix timestamp for trial end or ‘now’ to end immediately.
string
Subscription description for display or tracking.
object
Stripe Tax settings for automatic tax calculation.
string
Payment handling for invoices: ‘allow_incomplete’, ‘error_if_incomplete’, or ‘pending_if_incomplete’.
string
How invoices are paid: ‘charge_automatically’ or ‘send_invoice’.
array
List of default tax rate IDs.
string
How to handle prorations: ‘create_prorations’, ‘none’, or ‘always_invoice’.
string
Unix timestamp or ‘now’ to anchor billing cycle and renewal.
boolean
If true, schedules cancellation at period end; if false, undoes scheduled cancellation.
string
ID of default payment method for the subscription.
string
required
Unique identifier of the subscription to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_CUSTOMERS_SOURCES_VERIFY_THE_BANK_ACCOUNTVerifies a bank account for a customer using microdeposit amounts. Use when you need to confirm ownership of a bank account by providing the amounts of two microdeposits sent to the account.

Input Parameters

array
Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. Used to verify ownership of the bank account. Each value should be between 1 and 99 cents.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.
string
required
The unique identifier for the bank account to verify. Must start with ‘ba_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_INVOICES_INVOICE_VOIDVoids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice while preserving audit history. Only finalized invoices can be voided.

Input Parameters

string
required
The identifier of the invoice to void. Must be a finalized invoice that hasn’t been paid or marked as uncollectible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_PAYMENT_RECORDS_REPORT_PAYMENTTool to report a payment record in terminal state or for initialization. Use when you need to report payments that occurred on- or off-Stripe to create a unified payment history.

Input Parameters

object
Failure information. Include this if the payment failed.
string
Payment outcome status. Use ‘failed’ or ‘guaranteed’.
object
Set of key-value pairs for storing additional structured information.
object
Guarantee information. Include this if the payment was guaranteed.
string
Arbitrary description of the payment record.
integer
required
Timestamp when the payment was initiated (seconds since Unix epoch).
object
required
The requested payment amount with currency and value.
object
Optional customer information associated with the payment.
object
Shipping information for the payment.
string
Indicates customer presence during transaction. Use ‘on_session’ if customer is present, ‘off_session’ if not.
object
required
Details about the payment processor.
object
required
Details about the payment method used.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_SETUP_INTENTS_INTENTUpdates a SetupIntent object to modify configuration parameters and metadata. Use when you need to update an existing SetupIntent before completion.

Input Parameters

string
required
The ID of the SetupIntent to update.
string
Customer ID to associate with this SetupIntent; payment method will attach to Customer on successful setup.
object
Key-value pairs for structured data storage; individual keys can be unset by posting an empty value, all keys can be unset by posting an empty value to metadata.
string
Arbitrary string for display purposes.
boolean
If set, attaches the payment method to the Stripe Account for money movement flows like transfers; cannot be true when setting up for a Customer.
string
ID of existing PaymentMethod, Card, or Source to attach; pass empty string to unset.
array
Indicates money movement direction: ‘inbound’ or ‘outbound’.
string
Account ID to associate; payment method attaches to Account on successful setup.
array
List of allowed payment method types.
string
ID of payment method configuration (max 100 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_SUBSCRIPTION_ITEMS_ITEMTool to update a subscription item’s plan, quantity, billing thresholds, discounts, or metadata. Use when you need to modify an existing subscription item. Changes may trigger prorations.

Input Parameters

string
required
The unique identifier of the subscription item to update.
string
ID of the price object. Either price or price_data is required if changing the price.
object
Set of key-value pairs for storing additional structured information about the subscription item.
integer
Quantity of the subscription item.
array
List of discounts to apply to this subscription item. Replaces existing discounts.
array
List of tax rate IDs to override the subscription’s default tax rates for this item.
object
Inline price object generation for the subscription item.
boolean
Indicates if the payment is being made off-session. Defaults to false.
integer
Unix timestamp to calculate prorations as if the update occurred at this time.
string
Payment behavior when payment collection fails. One of: allow_incomplete, default_incomplete, error_if_incomplete, pending_if_incomplete.
object
Usage-based billing thresholds for the subscription item.
string
How to handle prorations during billing changes. One of: create_prorations (default), always_invoice, none.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_SUBSCRIPTIONS_SUBSCRIPTION_EXPOSED_IDTool to update an existing Stripe subscription with specified parameters. Use when you need to modify subscription items, billing settings, payment methods, or metadata for an active subscription.

Input Parameters

array
Subscription items to update (max 20).
object
Key-value pairs for additional information. Replaces existing metadata.
string
Unix timestamp when subscription cancels, or empty string to clear.
array
Discounts to apply to subscription.
string
Unix timestamp or ‘now’ to end trial.
string
Subscription description (max 500 characters).
boolean
Indicate off-session payment.
string
Connected account ID to charge on behalf of.
object
Automatic tax configuration.
object
Transfer data configuration.
integer
Days until invoice is due for send_invoice method.
string
ID of default payment source.
integer
Unix timestamp for proration calculation.
object
Trial settings configuration.
boolean
Apply plan’s trial_period_days.
object
Invoice settings configuration.
object
Configuration for pausing payment collection.
string
Payment behavior. One of: allow_incomplete, default_incomplete, pending_if_incomplete, error_if_incomplete.
object
Payment settings configuration.
array
Items to add to the next invoice (max 20).
string
Payment collection method. One of: charge_automatically, send_invoice.
array
Tax rate IDs to apply by default.
object
Billing threshold configuration.
string
Proration behavior. One of: always_invoice, create_prorations, none.
string
Unix timestamp or ‘now’ or ‘unchanged’ to set billing cycle anchor.
boolean
Cancel at current period end.
object
Details about subscription cancellation.
string
ID of default payment method.
number
Application fee percentage (0-100).
string
required
ID of the subscription to update.
object
Interval for pending invoice items.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_TERMINAL_CONFIGURATIONS_CONFIGURATIONTool to update a Stripe Terminal Configuration. Use when you need to modify terminal reader settings including device-specific configurations, offline transaction capabilities, security settings, reboot windows, WiFi credentials, or tipping configurations. Changes can take up to 10 minutes to reflect on target readers.

Input Parameters

string
Configuration identifier/name. Maximum 100 characters.
object
WiFi network credentials for terminal readers.
object
Offline transaction settings.
object
Tipping configuration by currency code (e.g., ‘usd’, ‘eur’). Supports: AED, AUD, BGN, CAD, CHF, CZK, DKK, EUR, GBP, GIP, HKD, HUF, JPY, MXN, MYR, NOK, NZD, PLN, RON, SEK, SGD, USD.
object
Device-specific splash screen settings.
string
required
The ID of the terminal configuration to update.
object
Customized reboot time window for terminal readers.
object
Device-specific splash screen settings.
object
Device-specific splash screen settings.
object
Device-specific splash screen settings.
object
Security configuration for terminal readers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_TERMINAL_READERS_READER_PROCESS_PAYMENT_INTENTInitiates a payment flow on a Stripe Terminal Reader to process a PaymentIntent. Use when you need to hand off a PaymentIntent to a physical card reader for customer payment. The reader must be online and not currently processing another action, and the PaymentIntent must be in requires_capture or requires_payment_method state. The response returns immediately with action status ‘in_progress’; poll the Reader object or use webhooks to determine completion.

Input Parameters

string
required
The unique identifier of the Reader device that will process the payment.
string
required
The ID of the PaymentIntent to process on the reader.
object
Transaction configuration overrides.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_TERMINAL_READERS_READER_SET_READER_DISPLAYConfigures a Stripe terminal reader to display cart information on screen. Use when you need to show customers their purchase details on a physical terminal device during checkout. Supported on Verifone P400, BBPOS WisePOS E, and Stripe Reader S700.

Input Parameters

object
required
Cart object containing the line items, total, currency, and optional tax to display on the reader.
string
required
The type of information to display on the reader. Currently only ‘cart’ is supported.
string
required
The ID of the terminal reader to update. Typically starts with ‘tmr_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_TERMINAL_READERS_SET_READER_DISPLAYTool to configure a terminal reader’s display to show cart details. Use when you need to display line items, amounts, and currency information on a Stripe Terminal reader screen.

Input Parameters

object
required
Cart object containing the cart’s total, tax, currency, and line items.
string
required
Type of information to display. Currently only ‘cart’ is supported.
string
required
The ID of the terminal reader. Must start with ‘tmr_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_ACCOUNTS_CAPABILITIES_CAPABILITIESUpdates an existing account capability for a Stripe connected account. Use when you need to request a new capability or remove a non-permanent capability. There may be a delay before the requested capability becomes active, and the response includes any activation requirements.

Input Parameters

string
required
The unique identifier of the Stripe account for which to update the capability. Typically starts with ‘acct_’.
boolean
Set to true to request a new capability for the account; pass false to remove non-permanent capabilities. There can be a delay before the requested capability becomes active.
string
required
The specific capability name to update (e.g., card_payments, transfers, giropay_payments, us_bank_account_ach_payments).
boolean
When true, assigns the experimental onboarding policy to the capability. Use with caution as this may affect the capability activation process.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_BALANCE_SETTINGS_OVERVIEWTool to update balance settings for a Stripe account. Use when customizing payout schedules, settlement timing, or negative balance handling for a connected account.

Input Parameters

object
Payment-related settings.
string
The connected account ID for which to update balance settings. If not provided, updates settings for the authenticated account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_BILLING_PORTAL_CONFIGS_OVERVIEW_BILLINGTool to update an existing billing portal configuration in Stripe. Use when you need to modify portal settings like business profile, features, or default return URL.

Input Parameters

string
A descriptive name for the configuration (maximum 256 characters).
boolean
Whether the configuration is active and can be used.
object
Configuration for features available in the portal.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
object
Configuration for the login page.
object
Business information shown to customers in the portal.
string
required
The ID of the billing portal configuration to update.
string
The default URL to redirect customers to when they click on the portal’s link to return to your website.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_CHECKOUT_SESSIONS_RETRIEVE_A_CHECKOUTUpdates metadata on a Stripe Checkout Session and returns the session details. Response fields can optionally be expanded.

Input Parameters

string
required
The checkout session identifier, typically starting with ‘cs_’.
array
Specifies which fields in the response should be expanded. Supports nested expansion using dot notation (e.g., ‘payment_intent.customer’). Common expandable fields include: customer, payment_intent, subscription, invoice, line_items, payment_link.
object
Set of key-value pairs that you can attach to the session object. This can be useful for storing additional information about the session in a structured format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_CREDIT_NOTES_CREDIT_NOTE2Tool to update an existing credit note in Stripe by modifying its memo or metadata. Use when you need to add context or store additional information on an already-issued credit note.

Input Parameters

string
Credit note memo text that appears on the PDF sent to customers. Use this to provide context or explanation for the credit note.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information in a structured format. Individual keys can be unset by posting empty values to them. All keys can be unset by posting an empty value to metadata.
string
required
The unique identifier of the credit note to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_CUSTOMERS_FUNDING_INSTRUCTIONS_FUND_A_TESTCreates or retrieves funding instructions for a customer cash balance via bank transfer. Returns bank account details (ABA, IBAN, etc.) that can be used to fund the customer’s account. If funding instructions already exist for the customer, the same instructions will be returned.

Input Parameters

string
required
Three-letter ISO 4217 currency code in lowercase. Determines which bank account details are returned (e.g., ‘usd’ for US bank accounts, ‘eur’ for IBAN).
string
required
The ID of the customer for whom to create or retrieve funding instructions. Must be a valid Stripe customer ID starting with ‘cus_’.
string
required
The funding method type. Currently only ‘bank_transfer’ is supported.
object
required
Configuration specifying the type of bank transfer and optional parameters like requested address types and EU country.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_CUSTOMERS_SEARCH_CUSTOMERSTool to search for Stripe customers using a search query. Use when you need to find customers by email, name, metadata, or other fields using Stripe’s Search Query Language.

Input Parameters

string
A cursor for pagination. Use the next_page value returned in a previous response to fetch the next page of results. Omit this parameter for the first page.
integer
Maximum number of results to return per page. Must be between 1 and 100. Defaults to 10 if not specified.
string
required
The search query string using Stripe’s Search Query Language. Supports exact matches, range queries, boolean operators, and metadata searches. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_INVOICES_FINALIZE_VOID_AN_INVOICEVoids a finalized invoice and maintains a papertrail. Use when you need to void a finalized invoice that has not been paid. Once voided, the invoice cannot be undone and maintains audit history.

Input Parameters

string
required
The unique identifier of the invoice to void. Must be a finalized invoice that hasn’t been paid or marked as uncollectible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_INVOICES_LINES_OVERVIEWUpdates an invoice’s line item before finalization. Use when you need to modify details of a line item such as description, metadata, amount, or tax settings before the invoice is finalized.

Input Parameters

integer
The amount to charge in cents. Use negative values for credits.
object
Period associated with the line item.
string
required
The ID of the invoice containing the line item to update.
object
Pricing information for the invoice item.
object
Set of key-value pairs for storing additional structured information about this line item.
integer
Non-negative integer specifying the quantity of units for the line item.
array
The coupons, promotion codes, or existing discounts to apply to the line item. Pass an empty list to remove all discounts.
array
The tax rates which apply to the line item. This overrides the invoice’s default_tax_rates. Pass an empty list to remove all tax rates.
object
Data for generating a new Price object inline.
string
An arbitrary string which you can attach to the line item for tracking and display purposes.
array
A list of up to 10 tax amounts for this line item. Cannot be set if the line item has tax_rates set, or if the invoice has default_tax_rates set, or uses automatic tax.
boolean
Controls whether discounts apply to this line item. Defaults vary by item type. Cannot be set to true for prorations.
string
required
The ID of the invoice line item to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_INVOICES_REMOVE_LINES_OVERVIEWTool to remove multiple line items from a draft Stripe invoice. Use when you need to delete or unassign specific line items from an invoice that hasn’t been finalized yet.

Input Parameters

array
required
Array of line items to remove from the invoice. Each line item must specify an ID and a behavior (delete or unassign).
string
required
The ID of the draft invoice from which to remove line items.
object
Optional key-value pairs to update on the invoice object itself after removing lines. Useful for storing additional information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_INVOICES_SEND_VOID_AN_INVOICETool to void a finalized Stripe invoice. Use when you need to permanently void an invoice while preserving an audit trail. This operation cannot be undone and only works on finalized invoices.

Input Parameters

string
required
The unique identifier of the finalized invoice to void.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_INVOICES_VOID_AN_INVOICETool to permanently void a finalized Stripe invoice. Use when an invoice needs to be canceled while maintaining an audit trail. This operation is irreversible and only applies to finalized invoices.

Input Parameters

string
required
The unique identifier of the finalized invoice to void.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_METHOD_CONFIGS_LIST_PAYMENT_METHOD2Updates a payment method configuration to control which payment methods are displayed at checkout. Use when modifying payment method availability or display settings.

Input Parameters

string
required
The unique identifier of the payment method configuration to update.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
Configuration for a specific payment method.
string
Configuration name (max 100 characters).
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
boolean
Controls whether the configuration can be used for new payments.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.
object
Configuration for a specific payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_METHOD_DOMAINS_PAYMENT_METHODUpdates an existing payment method domain to enable or disable it. Use when you need to control whether payment methods requiring domain verification will appear in Elements or Embedded Checkout.

Input Parameters

string
required
The unique identifier of the payment method domain to update. Typically starts with ‘pmd_’.
boolean
Determines if the payment method domain is active. When disabled (false), associated payment methods won’t display in Elements or Embedded Checkout. When enabled (true), payment methods requiring domain verification will appear in Elements or Embedded Checkout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_ATTEMPTTool to report a payment attempt on a Stripe Payment Record. Use when updating a Payment Record with payment attempt details such as initiation time and outcome status.

Input Parameters

string
required
The outcome of the payment attempt (e.g., ‘guaranteed’, ‘failed’).
object
Details for guaranteed payment outcome.
integer
required
Unix timestamp when the payment attempt was initiated.
string
required
The unique identifier of the Payment Record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_CANCELEDTool to report that the most recent payment attempt was canceled. Use when you need to update a Payment Record to reflect a canceled payment attempt.

Input Parameters

string
required
The unique identifier of the Payment Record to update. Format: pr_* (e.g., pr_test_65Tqu1EdnfhFTBzFcFB41QvM72TjFrbIBU)
integer
required
When the reported payment was canceled. Measured in seconds since the Unix epoch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_GUARANTEEDReports that a payment attempt was guaranteed for a specific Payment Record. Use when confirming that a payment has been successfully guaranteed by the payment processor at a specific timestamp.

Input Parameters

string
required
The Payment Record identifier.
integer
required
When the reported payment was guaranteed, measured in seconds since the Unix epoch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_INFOTool to report additional payment attempt information for a payment record. Use when you need to add informational details about a payment attempt.

Input Parameters

string
required
Additional payment attempt information to report for this payment record.
string
required
The unique identifier of the payment record to report on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYMENT_RECORDS_REPORT_REFUND_OVERVIEWReports that the most recent payment attempt on a Payment Record was refunded. Use when you need to record a refund for a successfully processed payment to maintain accurate payment records. Multiple partial refunds can be reported until the full amount is refunded.

Input Parameters

string
required
The Payment Record identifier.
object
Refund amount details.
string
required
Must be set to ‘refunded’ to report a refund.
object
Set of key-value pairs for storing additional information in a structured format.
object
required
Information about the payment attempt refund.
integer
Unix epoch timestamp when the refund was initiated.
object
required
Processor information for the refund.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PAYOUTS_RETRIEVE_A_PAYOUTUpdates an existing payout’s metadata and returns the payout object. Individual metadata keys can be removed by supplying an empty string as their value.

Input Parameters

object
Set of key-value pairs to attach or update on the payout object. Useful for storing additional information. Keys and values must be strings. To remove a specific key, pass an empty string as its value. To clear all metadata, pass an empty dictionary.
string
required
The unique identifier of the payout to update. This ID typically starts with ‘po_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PLANS_OVERVIEWTool to update a Stripe plan by setting passed parameter values. Use when modifying plan details like nickname, metadata, or active status.

Input Parameters

string
required
The identifier of the plan to be updated.
boolean
Whether the plan is currently available for new subscriptions.
string
The product the plan belongs to. Cannot be changed once used in a subscription or subscription schedule.
object
Set of key-value pairs for storing additional structured information. Individual keys can be unset by posting an empty value to them.
string
A brief description of the plan, hidden from customers.
integer
Default number of trial days when subscribing a customer to this plan using trial_from_plan=true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_PROMOTION_CODES_PROMOTION_CODEUpdates an existing promotion code. Most fields are not editable by design. Use this to activate/deactivate codes, update metadata, or modify currency-specific restrictions.

Input Parameters

boolean
Whether the promotion code is currently active and can be redeemed. A promotion code can only be reactivated when the underlying coupon is still valid.
object
Set of key-value pairs for storing additional structured information about the promotion code. Individual keys can be unset by posting an empty value.
object
Settings restricting redemption of the promotion code.
string
required
The ID of the promotion code to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_SHIPPING_RATES_OVERVIEW2Updates an existing Stripe shipping rate’s active status, metadata, and currency-specific fixed amounts and tax behavior.

Input Parameters

string
required
Unique identifier of the shipping rate to update.
boolean
Whether the shipping rate can be used for new purchases. Defaults to true.
object
Set of key-value pairs that you can attach to an object for storing additional information. Keys up to 40 characters, values up to 500 characters.
object
Fixed amount charge details for shipping.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_SUBSCRIPTION_SCHEDULES_OVERVIEW2Tool to update an existing subscription schedule with new phases, settings, metadata, and end behavior. Use when modifying subscription schedule configuration.

Input Parameters

string
required
The subscription schedule ID to update
array
List of subscription phases with customizable durations and pricing
object
Key-value pairs for storing additional information
string
Subscription fate when schedule ends: release or cancel
object
Object representing the subscription schedule’s default settings
string
Billing changes handling: create_prorations, always_invoice, or none

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_SUBSCRIPTION_SCHEDULES_RELEASE_OVERVIEWTool to release a subscription schedule. Releases a subscription schedule immediately, stops scheduling future phases but leaves the existing subscription in place.

Input Parameters

string
required
The ID of the subscription schedule to release.
boolean
Keep any cancellation date on the underlying subscription that the schedule previously set. If false (default), any previously set cancellation date will be cleared.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_SUBSCRIPTIONS_LIST_SUBSCRIPTIONSUpdates an existing Stripe subscription’s properties including metadata, description, payment method, billing settings, trial periods, and cancellation behavior. Use this to modify subscription configuration, change payment methods, update billing cycles, manage trials, or schedule cancellations. This action does not modify subscription items (prices/products) - use separate actions for that.

Input Parameters

object
Set of key-value pairs for storing additional information about the subscription. Keys can be up to 40 characters and values up to 500 characters.
string
Unix timestamp for when the trial period ends, or ‘now’ to end the trial immediately. Use this to grant or modify trial periods.
string
Customer-facing description for the subscription. Maximum 500 characters.
integer
Number of days a customer has to pay invoices. Only valid when collection_method is ‘send_invoice’.
string
ID of the payment source to use as the default for the subscription. Must belong to the subscription’s customer.
string
required
The ID of the subscription to update (required).
string
How invoices are paid. Use ‘charge_automatically’ to automatically charge the default payment method, or ‘send_invoice’ to email the customer an invoice.
string
How to handle prorations when subscription is updated. Options: ‘create_prorations’ (default), ‘none’, or ‘always_invoice’.
string
Use ‘now’ to reset the billing cycle anchor to the current time, or ‘unchanged’ to keep it as is.
boolean
Set to true to cancel the subscription at the end of the current billing period. Set to false to undo a pending cancellation.
string
ID of the payment method to use as the default for this subscription. Must belong to the subscription’s customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V1_TAX_RATES_TAX_RATE2Tool to update an existing Stripe tax rate. Use when you need to modify tax rate properties such as display name, description, or active status.

Input Parameters

string
ISO 3166-2 subdivision code without country prefix (e.g., ‘NY’ for New York in the US, ‘ON’ for Ontario in Canada).
boolean
Flag determining whether the tax rate is active or inactive (archived). Inactive tax rates cannot be used with new applications or Checkout Sessions.
string
Two-letter country code per ISO 3166-1 alpha-2 standard.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
string
The high-level tax type, such as vat or sales_tax. One of: amusement_tax, communications_tax, gst, hst, igst, jct, lease_tax, pst, qst, retail_delivery_fee, rst, sales_tax, service_tax, or vat.
string
An arbitrary string attached to the tax rate for your own reference. It is not visible to your customers.
string
required
The unique identifier of the tax rate to update.
string
The display name of the tax rate as shown to customers on receipts and invoices. Maximum 50 characters.
string
The jurisdiction for the tax rate. You can use this label field for tax reporting purposes. Maximum 50 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_POST_V2_BILLING_METER_EVENT_ADJUSTMENTS_METER_EVENTCreates a billing meter event adjustment to cancel a previously sent meter event. Use when you need to cancel a meter event within 24 hours of Stripe receiving it.

Input Parameters

string
required
Specifies adjustment type. Currently only ‘cancel’ is supported for single events.
object
required
Object containing cancellation details with the identifier of the event to cancel.
string
required
The name of the meter event. Corresponds with the event_name field on a meter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_PRESENT_PAYMENT_METHODTool to present a payment method on a simulated terminal reader for testing purposes. Use when testing payment flows, simulating card acceptance, or validating terminal reader integrations in test mode.

Input Parameters

object
Simulated card payment data.
string ("card" | "card_present" | "interac_present")
Simulated payment type. Must be one of: ‘card’, ‘card_present’, or ‘interac_present’.
string
required
The unique identifier of the terminal reader to present the payment method on.
integer
Simulated on-reader tip amount in the smallest currency unit (e.g., 100 cents to represent $1.00).
object
Simulated card_present payment data.
object
Simulated Interac payment data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_PROCESS_SETUP_INTENTInitiates a SetupIntent flow on a Stripe Terminal Reader to save payment details. Use when you need to collect and save payment method information for future use.

Input Parameters

string
required
The unique identifier of the terminal reader to process the setup intent on.
string
required
The ID of the SetupIntent to process on the reader.
object
Configuration overrides for setup operations.
string ("always" | "limited" | "unspecified")
Indicates whether this payment method can be shown again to its customer in a checkout flow. Controls visibility in Stripe products like Checkout and Elements.
Set to true when customer consent has been collected. Required by regulations in some jurisdictions to confirm the customer agreed to save their payment method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_REACTIVATE_BILLING_METERReactivates a deactivated billing meter. Use when you need to resume tracking usage after a meter has been deactivated.

Input Parameters

string
required
Unique identifier of the billing meter to reactivate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_REPORT_PAYMENT_ATTEMPT_FAILEDReports that a recent payment attempt on a Payment Record has failed. Use when a payment attempt encounters an error to ensure Stripe has a complete view of payment flows.

Input Parameters

string
required
The identifier of the Payment Record to update.
integer
required
When the reported payment failed. Measured in seconds since the Unix epoch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RESUME_SUBSCRIPTIONResumes a paused Stripe subscription with billing cycle and proration options. Use when a customer wants to restart payment collection on a previously paused subscription.

Input Parameters

integer
Calculates prorations as if resumed at specified time; useful for matching preview calculations. Unix timestamp in seconds.
string
required
The ID of the subscription to resume.
string
Controls proration handling when anchor is ‘unchanged’. Options: ‘always_invoice’ (immediate invoicing), ‘create_prorations’ (conditional invoicing), or ‘none’ (disable prorations). Default: ‘create_prorations’.
string
Determines timing for resumption. Options: ‘now’ (reset anchor to current UTC time) or ‘unchanged’ (advance to surrounding period). Default: ‘now’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_BALANCERetrieves the complete current balance details for the connected Stripe account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_CHARGERetrieves full details for an existing Stripe charge using its unique ID.

Input Parameters

string
required
Identifier for the charge, typically starting with ‘ch_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_CHECKOUT_SESSIONTool to retrieve a Checkout Session object from Stripe. Use when you need to get the current state of a checkout session, including payment status, customer details, and line items.

Input Parameters

array
Specifies which fields in the response should be expanded. Supports nested expansion using dot notation (e.g., ‘payment_intent.customer’). Common expandable fields include: customer, payment_intent, subscription, invoice, line_items, payment_link.
string
required
The identifier of the checkout session to retrieve, typically starting with ‘cs_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_CUSTOMERRetrieves detailed information for an existing Stripe customer using their unique customer ID.

Input Parameters

string
required
The unique identifier of the Stripe customer to retrieve. This ID typically starts with ‘cus_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_PAYMENT_INTENTRetrieves a PaymentIntent by its ID; client_secret is required if a publishable API key is used.

Input Parameters

string
Client secret for the PaymentIntent. Required if using a publishable key for authentication.
string
required
The unique identifier of the PaymentIntent to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_PROMOTION_CODETool to retrieve a Stripe promotion code by its ID. Use when you need to get details about a specific promotion code including its associated coupon, usage restrictions, and redemption statistics.

Input Parameters

string
required
The unique identifier of the promotion code to retrieve, typically starting with ‘promo_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_RETRIEVE_UPCOMING_INVOICETool to preview the upcoming invoice for a customer, showing all pending charges including subscription renewals and invoice items. Use when you need to preview invoice amounts before they are finalized, test the effects of subscription updates including prorations, or estimate future billing.

Input Parameters

string
The code of the coupon to apply to the invoice preview. If multiple discounts needed, use the discounts parameter instead.
object
The connected account that issues the invoice. Can specify type (‘self’ or ‘account’) and account ID.
string
The currency for the invoice preview. Three-letter ISO currency code. Defaults to customer’s currency.
string
The identifier of the customer whose upcoming invoice to retrieve. Required if subscription is not specified.
string
The identifier of the subscription schedule for which you’d like to retrieve the upcoming invoice. Cannot be combined with subscription or subscription_details parameters.
array
List of discounts to apply. Each discount can have coupon, discount, or promotion_code.
string
The account (if any) for which the funds of the invoice payment are intended. Used with Stripe Connect.
string
Determines the preview calculation type. ‘next’ (default) calculates the next invoice with all items. ‘recurring’ estimates long-term recurring bill.
string
The identifier of the subscription for which you’d like to retrieve the upcoming invoice. If not specified, uses the customer’s default subscription.
object
Settings for automatic tax calculation. Must include ‘enabled’ boolean field.
array
List of invoice items to add or update in the upcoming invoice preview. Maximum 250 items.
object
Details about the customer used for this invoice preview. Can include address, shipping, and tax information.
object
Details for schedule creation or modification to preview. Include phases, end_behavior, and proration_behavior.
array
List of subscription items for subscription updates. Each item can have id, deleted, price, quantity, etc.
object
Subscription creation or modification parameters to preview. Can include items, proration_behavior, proration_date, billing_cycle_anchor, trial_end, etc.
integer
Unix timestamp at which the subscription should be canceled. Used to preview the invoice that will be generated if the subscription is canceled at this time.
string
For paused subscriptions, when to resume. Can be ‘now’.
string
Trial end for the subscription. Can be ‘now’ or a Unix timestamp.
boolean
Boolean to simulate immediate cancellation of the subscription.
integer
Unix timestamp for when the subscription should start.
integer
Unix timestamp to use for proration calculations. Important: Use this same value when doing the actual subscription update to ensure matching prorations.
boolean
Boolean indicating if a default trial from the plan should be applied.
array
List of tax rate IDs to apply to the subscription items in this preview.
string
How to handle prorations when updating subscriptions. Can be ‘create_prorations’, ‘none’, or ‘always_invoice’.
string
For new subscriptions, billing cycle anchor. Can be ‘now’, ‘unchanged’, or a Unix timestamp.
boolean
Boolean indicating whether the subscription should cancel at the end of the current period.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_CHARGESSearch charges using Stripe’s Search Query Language. Use when you need to find historical charges by status, amount, customer, metadata, or other criteria.

Input Parameters

string
Pagination cursor for a specific page; omit entirely for the first page. Use next_page from a previous response for subsequent pages.
integer
Maximum number of results per page (default is 10).
string
required
The search query string, adhering to Stripe’s Search Query Language. Supports exact matches, range queries, boolean operators (AND/OR), and metadata searches. CRITICAL LIMITATION: You CANNOT mix AND and OR operators in the same query - use either all AND or all OR, never both. Parentheses are not supported. Combine up to 10 clauses with spaces (defaults to AND logic) or explicit AND/OR keywords. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_CUSTOMERSRetrieves a list of Stripe customers matching a search query that adheres to Stripe’s Search Query Language.

Input Parameters

string
Cursor token for pagination. MUST be the exact next_page value from a previous search response - NOT a numeric page number like ‘1’ or ‘2’. Omit this parameter on the first request. Only provide this when has_more is true in the previous response.
integer
Maximum number of results per page (default is 10).
string
required
The search query string using Stripe’s Search Query Language. IMPORTANT: Every query must include at least one field:value condition - standalone wildcards like ’*’ are NOT supported and will fail. Supported operators: ’:’ for exact match (case-insensitive), '' for substring match (minimum 3 characters), comparison operators (>, <, >=, <=) for numeric/date fields. Combine clauses with AND, OR, or prefix with ’-’ for negation. To retrieve many/all customers, use ‘created>0’. For partial text matching, use the ~ operator (e.g., email’example’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_INVOICESSearches for invoices using Stripe’s Search Query Language. Use when you need to find invoices by status, total amount, customer, currency, or other criteria. Data is typically searchable within one minute, though propagation can lag up to an hour during outages.

Input Parameters

string
Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages.
integer
Maximum number of results per page (default is 10).
string
required
The search query string using Stripe’s Search Query Language. Supported search fields for invoices: created (timestamp), currency (3-letter ISO code), customer (customer ID), last_finalization_error_code (error code from finalization), last_finalization_error_type (error type from finalization), metadata (key-value pairs), number (invoice number), receipt_number (receipt number), status (draft/open/paid/uncollectible/void), subscription (subscription ID), total (amount in cents). Supports exact matches, range queries (>, <, >=, <=), boolean operators (AND, OR, NOT), and metadata search. Can combine up to 10 query clauses. Cannot mix AND with OR in the same query. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_PAYMENT_INTENTSSearches for PaymentIntents using Stripe’s Search Query Language. Use when you need to find payments by status, amount, customer, or other criteria.

Input Parameters

string
Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages.
integer
Maximum number of results per page (default is 10).
string
required
The search query string, adhering to Stripe’s Search Query Language. This language supports features like exact matches, range queries, boolean operators, and searching by metadata. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_PRICESSearch for prices using Stripe’s Search Query Language. Use when you need to find prices by status, currency, product, or other criteria with flexible query syntax.

Input Parameters

string
Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages.
integer
Maximum number of results per page (default is 10, maximum is 100).
string
required
The search query string, adhering to Stripe’s Search Query Language. This language supports features like exact matches, range queries, boolean operators, and searching by metadata. For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_PRODUCTSTool to search for products using Stripe’s Search Query Language. Use when you need to find products based on specific criteria like active status, name, or metadata.

Input Parameters

string
A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
integer
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
string
required
The search query string using Stripe’s Search Query Language. CRITICAL: All string values MUST be enclosed in double quotes (”), not single quotes (’). The substring match operator is ~ (tilde), placed immediately after the field name with no colon, e.g., name~“value”. Combine up to 10 clauses with AND or OR operators. Minimum 3 characters for substring matches.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEARCH_SUBSCRIPTIONSSearches for subscriptions using Stripe’s Search Query Language. Use when you need to find subscriptions by status, metadata, created timestamp, or canceled_at timestamp.

Input Parameters

string
Pagination cursor for a specific page; omit for the first page. Use next_page from a previous response for subsequent pages.
integer
Maximum number of results per page (default is 10, max is 100).
string
required
The search query string using Stripe’s Search Query Language. Supported search fields for subscriptions: status (e.g., ‘active’, ‘canceled’), metadata (custom key-value pairs), created (Unix timestamp), canceled_at (Unix timestamp). Supports exact matches, range queries (>, <, >=, <=), and boolean operators (AND, OR). For detailed syntax, refer to https://docs.stripe.com/search#search-query-language.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SEND_INVOICETool to manually send a finalized Stripe invoice to the customer outside the automatic billing schedule. Use when you need to deliver an invoice for manual payment. Note: In test mode, no emails are sent, but webhook events (invoice.sent) are still generated.

Input Parameters

string
required
The unique identifier of the invoice to send to the customer. Must be a finalized invoice with ‘send_invoice’ collection method.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SET_READER_DISPLAYConfigures a Stripe Terminal reader to display cart information on its screen. Use when you need to show transaction details to customers during checkout.

Input Parameters

object
required
Cart details to display on the reader screen. Required when type is ‘cart’.
string
The type of information to display. Currently only ‘cart’ is supported.
string
required
The unique identifier of the Terminal reader to update (e.g., ‘tmr_xxxxx’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SET_TERMINAL_READER_DISPLAYTool to set the display on a Stripe Terminal reader to show cart details. Use when you need to display line items, totals, and tax information on a physical terminal reader screen.

Input Parameters

object
Cart information to display on the terminal reader.
string
required
Display type. Currently only ‘cart’ is supported.
string
required
The ID of the terminal reader to set the display for. Must be an existing terminal reader ID (format: tmr_xxx). Obtain this from listing terminal readers or after creating one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_SUCCEED_TEST_TERMINAL_READER_INPUT_COLLECTIONSimulates successful completion of an ongoing input collection on a Terminal reader. This test helper allows you to test your integration’s handling of successfully collected customer inputs (signature, email, phone, etc.) without requiring physical hardware or actual customer interaction. The reader must have an active input collection in progress (initiated via collect_inputs endpoint). Note: This endpoint only works in test mode with test API keys.

Input Parameters

array
Specifies which fields in the response should be expanded. Each item has a maximum length of 5000 characters.
string
required
The unique identifier of the terminal reader to simulate successful input collection on.
string ("all" | "none")
Defines which non-required inputs should be skipped during simulation. Use ‘all’ to skip all non-required inputs (simulating customer skipping optional fields), or ‘none’ to collect all inputs including non-required ones (simulating customer completing all fields).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_TIMEOUT_TEST_TERMINAL_READER_INPUT_COLLECTIONSimulate an input collection timeout on a Stripe Terminal reader. This test helper endpoint allows you to simulate timeout scenarios during input collection operations on Terminal readers without needing physical hardware. When called, it marks the current reader action as failed with a timeout error, useful for testing error handling in your integration. Important: This endpoint is ONLY available in test mode. You must use test API keys (sk_test_…) to call this endpoint. Calling with live mode keys will result in an error. Use this when testing: - Timeout error handling in your application - Input collection failure scenarios - Reader action recovery flows

Input Parameters

array
Specifies which fields in the response should be expanded. Each item has a maximum length of 5000 characters.
string
required
The unique identifier of the Terminal reader to simulate timeout on. Must be a valid reader ID (starts with ‘tmr_’) that has an active input collection operation. The timeout will fail the current reader action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_APPLICATION_FEE_REFUNDUpdates metadata on an existing application fee refund identified by its fee ID and refund ID.

Input Parameters

string
required
The ID of the refund to update. This ID typically starts with ‘fr_’.
string
required
The ID of the application fee that was refunded. This ID typically starts with ‘fee_’.
array
Specifies which fields in the response should be expanded. Expandable fields include: balance_transaction, fee.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_BILLING_CREDIT_GRANTUpdates an existing billing credit grant. Use when you need to modify the expiration time or metadata of a credit grant.

Input Parameters

string
required
Unique identifier for the credit grant object to update. Typically starts with ‘credgr_’.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
integer
Unix timestamp when the billing credits created by this credit grant expire. If set to empty, the billing credits never expire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_BILLING_METERTool to update a billing meter’s display name. Use when you need to modify the name of an existing billing meter.

Input Parameters

string
required
The unique identifier of the billing meter to update.
array
Specifies which fields in the response should be expanded. Available on all API requests and applies to the response of that request only.
string
The meter’s name. Not visible to the customer. Maximum length: 250 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_BILLING_PORTAL_CONFIGURATIONUpdate a billing portal configuration. Use when you need to modify portal settings, business profile, or features.

Input Parameters

string
Configuration name (max 256 characters).
boolean
Whether the configuration is active for creating portal sessions.
object
Features configuration for the billing portal.
object
Key-value pairs for storing additional information.
object
Login page configuration.
string
required
ID of the billing portal configuration to update.
object
Business profile settings for the billing portal.
string
Default URL to redirect customers when they return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CASH_BALANCETool to update a customer’s cash balance settings in Stripe. Use when you need to modify how funds transferred to a customer’s cash balance are applied to payment intents and invoices.

Input Parameters

object
Settings for the cash balance.
string
required
The unique identifier of the Stripe customer whose cash balance settings you want to update. This ID typically starts with ‘cus_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CHARGETool to update a Stripe charge object with provided parameters. Use when you need to modify charge details such as description, metadata, fraud assessment, receipt email, shipping information, or transfer group.

Input Parameters

string
The ID of an existing customer to associate with this charge. Only updatable if the charge has no existing customer.
object
Set of key-value pairs for storing structured information. Individual keys can be unset by posting empty values.
object
Shipping information for the charge.
string
required
The ID of the charge to update.
string
An arbitrary string to attach to the charge. Displayed in the Stripe Dashboard and on customer receipts.
object
Fraud details for the charge.
string
The email address to send the receipt to. Updating this will trigger a new receipt email to be sent.
string
A string that identifies this transaction as part of a group for connected accounts. Can only be set once.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CHARGE_DISPUTETool to update metadata on a charge’s dispute. Use when you need to attach structured information to a dispute for tracking or internal reference purposes.

Input Parameters

string
required
The ID of the charge to update the dispute for. Must start with ‘ch_’.
object
Key-value pairs to attach to the dispute for storing structured additional information. Individual keys can be unset by posting an empty value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CHARGE_REFUNDTool to update a specified refund within a charge. Use when you need to modify the metadata of an existing refund.

Input Parameters

string
required
The identifier of the refund to update. This ID typically starts with ‘re_’.
object
Set of key-value pairs that you can attach to the refund object for storing additional information in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CHECKOUT_SESSIONTool to update a Stripe Checkout Session dynamically. Use when you need to modify customer information, line items, or shipping options on an existing checkout session. Line item updates require retransmitting the entire array.

Input Parameters

string
required
The ID of the Checkout Session to update.
object
Key-value pairs for storing additional structured information about the checkout session.
array
List of purchased items. Must retransmit the entire array when updating. Items can be retained (by ID), updated (ID + new values), added (price/price_data), or removed (omit ID).
array
Shipping rate options (maximum 5).
object
Customer data collected within the session. Only applies to embedded or custom checkout sessions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_COUPONUpdates a Stripe coupon’s metadata, name, or currency options. Other coupon details (currency, duration, amount_off, percent_off) are, by design, not editable. Use when you need to modify coupon metadata, display name, or add new currency-specific discount amounts.

Input Parameters

string
Name of the coupon displayed to customers on invoices or receipts. Maximum length is 40 characters. Defaults to the coupon ID if not set.
string
required
The ID of the coupon to update.
object
Set of key-value pairs for storing additional information in a structured format. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value to metadata.
object
Coupons defined in each available currency option (amount-based coupons only). Each key must be a three-letter ISO currency code with a nested amount_off value. Only applicable for amount-based coupons. Note: You can only add new currencies, not modify existing currency options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMERUpdates an existing Stripe customer, identified by customer_id, with only the provided details; unspecified fields remain unchanged.

Input Parameters

object
Specifies tax-related information for the customer.
string
The customer’s full name or the business name.
string
The customer’s email address. Updating this may trigger a verification email to the new address.
string
The customer’s primary phone number, preferably in E.164 format.
string
The ID of a coupon to apply to the customer. This coupon will be applied to the customer’s subsequent invoices and subscriptions.
object
Defines the customer’s primary billing address.
integer
An integer representing the customer’s account balance in the smallest currency unit (e.g., cents for USD). A positive value credits the customer’s balance, and a negative value debits it. This balance will be applied to future invoices.
object
Key-value pairs for storing additional, unstructured information. Keys up to 40 characters, values up to 500.
object
Encapsulates the customer’s shipping details.
string
Specifies the customer’s tax exemption status. Accepted values are ‘none’, ‘exempt’, or ‘reverse’. Use ‘reverse’ for B2B transactions in the EU subject to reverse charge.
string
required
The unique identifier of the Stripe customer to update.
string
An arbitrary string providing additional information about the customer, often used for internal notes. Maximum 5000 characters.
string
The ID of a card or bank account object to set as the customer’s default payment source for charges and subscriptions. Deprecated in favor of default_payment_method for newer integrations.
object
Defines default settings for invoices created for this customer.
string
The ID of a PaymentMethod to set as the customer’s default for subscriptions and invoices.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_BALANCE_TXNUpdates an existing customer balance transaction’s description and metadata. Use when you need to modify the description or add/update metadata on a customer balance transaction. Most transaction fields are immutable after creation.

Input Parameters

object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.
string
An arbitrary string attached to the object. Often useful for displaying to users. Maximum length is 350 characters.
string
required
The unique identifier for the customer balance transaction to update. Must start with ‘cbtxn_’ followed by alphanumeric characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNTUpdates a specified bank account for a given customer. Use when you need to modify account holder details or metadata for a customer’s bank account.

Input Parameters

string
required
The unique identifier for the bank account source to update. Must start with ‘ba_’ followed by alphanumeric characters.
string
required
The unique identifier for the customer. Must start with ‘cus_’ followed by alphanumeric characters.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
string
The name of the person or business that owns the bank account.
string
The type of entity that holds the account. This can be either ‘individual’ or ‘company’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_BANK_ACCOUNT_SOURCEUpdates a bank account source attached to a customer. Use when you need to modify editable attributes like account holder name, type, or metadata.

Input Parameters

object
Key-value pairs for storing additional structured information. Individual keys or all keys can be unset by posting empty values.
string
required
The unique identifier of the bank account source to update.
string
required
The unique identifier of the Stripe customer.
string
The name of the person or business that owns the bank account.
string ("individual" | "company")
Entity type holding the account. Either ‘individual’ or ‘company’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_CARDTool to update a card for a specified customer. Use when you need to update card details including billing address, expiration, name, or metadata.

Input Parameters

string
required
The ID of the card to update.
string
Cardholder name as it appears on the card.
string
required
The ID of the customer whose card should be updated.
string
Four-digit number representing the card’s expiration year.
object
Set of key-value pairs for storing additional structured information about the card.
string
Two-digit number representing the card’s expiration month.
string
ZIP or postal code for billing address.
string
City, district, suburb, town, or village for billing address.
string
Street address, PO Box, or company name for billing address.
string
Apartment, suite, unit, or building number for billing address.
string
State, county, province, or region for billing address.
string
Two-letter country code (ISO 3166-1 alpha-2) for billing address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_SOURCEUpdate a specified source for a given customer. Use when modifying card details, bank account information, or source metadata.

Input Parameters

string
required
The unique identifier of the source to update.
string
Cardholder name. Maximum 5000 characters.
object
Owner information for source objects.
array
Specifies which fields in the response should be expanded. Each item maximum 5000 characters.
string
required
The unique identifier of the customer.
string
Four-digit number representing the card’s expiration year. Maximum 5000 characters.
object
Set of key-value pairs to attach to the object. Useful for storing additional information. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value for metadata.
string
Two-digit number representing the card’s expiration month. Maximum 5000 characters.
string
ZIP or postal code. Maximum 5000 characters.
string
City, district, suburb, town, or village. Maximum 5000 characters.
string
Address line 1 (e.g., street address, PO Box, or company name). Maximum 5000 characters.
string
Address line 2 (e.g., apartment, suite, unit, or building). Maximum 5000 characters.
string
State, county, province, or region. Maximum 5000 characters.
string
Billing address country. Maximum 5000 characters.
string
Name of the person or business that owns the bank account. Maximum 5000 characters.
string ("company" | "individual")
Type of entity that holds the account. Can be ‘company’ or ‘individual’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_CUSTOMER_SUBSCRIPTIONTool to update a subscription on a customer in Stripe. Use when modifying subscription items, billing settings, payment methods, or metadata. Requires both customer ID and subscription ID. Supports updating items, metadata, billing cycle, cancellation settings, and more.

Input Parameters

array
List of subscription items to update (max 20).
string
required
The ID of the customer whose subscription is being updated.
object
Set of key-value pairs to attach to the subscription. Can be used to store additional information.
string
Unix timestamp or empty string to cancel scheduled cancellation.
string
Unix timestamp for trial end or ‘now’ to end immediately.
string
Subscription description, displayed to customer.
boolean
Indicates if customer is off-session during invoice payment attempt.
object
Automatic tax settings for subscription.
integer
Days customer has to pay invoices (only for send_invoice collection method).
string
ID of default payment source or empty string to remove.
integer
Unix timestamp for calculating prorations.
object
Trial settings configuration.
boolean
If true, applies plan’s trial_period_days to subscription.
object
Invoice settings for subscription.
string
Pause collection configuration or empty string to unpause.
string ("allow_incomplete" | "default_incomplete" | "error_if_incomplete" | "pending_if_incomplete")
Payment behavior for subscription updates.
string ("charge_automatically" | "send_invoice")
Collection method for subscription payments.
string
Billing thresholds configuration or empty string to remove.
string ("always_invoice" | "create_prorations" | "none")
Proration behavior for subscription changes.
string ("now" | "unchanged")
Billing cycle anchor values.
boolean
If true, subscription cancels at end of current period. If false, undoes scheduled cancellation.
object
Details about subscription cancellation.
string
ID of default payment method for the subscription.
string
required
The ID of the subscription to update.
string
Interval for billing pending invoice items or empty string to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_DISPUTETool to update a Stripe dispute by submitting evidence or updating metadata. Use when responding to payment disputes to provide documentation countering the dispute claim.

Input Parameters

boolean
When true, submits evidence immediately to the bank; when false, stages evidence for later submission. Default: true.
string
required
The ID of the dispute to update.
object
Documentation to counter the dispute.
object
Custom key-value pairs for storing structured data about the dispute. Individual keys can be unset by posting an empty value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_ENTITLEMENT_FEATURETool to update a feature’s properties or deactivate it. Use when you need to modify an existing entitlements feature’s metadata, name, or active status.

Input Parameters

string
required
The unique identifier of the feature to update. This ID typically starts with ‘feat_’.
string
The feature’s internal name for your own identification purposes, not meant to be displayed to customers. Maximum length is 80 characters.
boolean
When set to false, prevents the feature from being attached to new products and excludes it from the features list endpoint. When true, the feature is active and available.
object
Set of key-value pairs for storing additional structured information about the feature. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_EVENT_DESTINATIONUpdates a v2 Event Destination with new values for specified parameters. Use when you need to modify an event destination’s name, description, enabled events, webhook URL, or metadata.

Input Parameters

string
Event destination name.
array
Additional fields to include in the response. Currently supports ‘webhook_endpoint.url’.
object
Metadata. Keys can be up to 40 characters long. Values can be unset by posting an empty value.
string
An optional description of what the event destination is used for.
array
The list of events to enable for this endpoint. Use [’*’] to receive all events.
object
Webhook endpoint configuration for request.
string
required
Unique identifier for the event destination to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_EXTERNAL_ACCOUNTUpdates 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. Use when you need to modify external account details for a connected account, such as updating the account holder information or setting it as the default external account. Other bank account details are not editable by design. Requires the ‘account’ parameter (the Stripe account ID) and ‘id’ parameter (the external account ID). You can only update bank accounts when account.controller.requirement_collection is ‘application’, which includes Custom accounts.

Input Parameters

string
required
The unique identifier of the external account to update. Must start with ‘ba_’ (bank account) or ‘ca_’ (card).
string
Cardholder name. Maximum 5000 characters.
array
Specifies which fields in the response should be expanded. Each item maximum 5000 characters.
string
required
The unique identifier of the Stripe account. Must start with ‘acct_’ followed by alphanumeric characters.
object
Set of key-value pairs to attach to the object. Useful for storing additional information. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value for metadata.
string
ZIP or postal code. Maximum 5000 characters.
string ("checking" | "futsu" | "savings" | "toza")
The bank account type. This can only be ‘checking’ or ‘savings’ in most countries. In Japan, this can only be ‘futsu’ or ‘toza’.
string
City/District/Suburb/Town/Village. Maximum 5000 characters.
string
Address line 1 (Street address/PO Box/Company name). Maximum 5000 characters.
string
Address line 2 (Apartment/Suite/Unit/Building). Maximum 5000 characters.
string
State/County/Province/Region. Maximum 5000 characters.
string
Billing address country, if provided when creating card. Maximum 5000 characters.
string
The name of the person or business that owns the bank account. Maximum 5000 characters.
string ("company" | "individual")
The type of entity that holds the account. This can be either ‘individual’ or ‘company’.
boolean
When set to true, this becomes the default external account for its currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_INVOICEUpdates a draft Stripe invoice. Use when modifying invoice details before finalization. Once finalized, monetary values and collection_method become immutable.

Input Parameters

Footer text on invoice.
object
Connected account issuing the invoice.
string
Invoice number (max 26 chars).
string
required
The ID of the invoice to update.
integer
Payment due date (Unix timestamp, send_invoice only, draft only).
object
Key-value pairs for structured data storage.
array
Discounts to apply to the invoice.
object
Options for customizing the invoice PDF appearance.
string
Memo displayed to users.
boolean
Controls automatic collection, finalization, and reconciliation.
integer
Date when invoice takes effect (Unix timestamp).
string
Account for which payment funds are intended.
object
Configuration for Stripe’s automatic tax calculation on the invoice.
array
Up to 4 custom fields to display on the invoice.
object
Shipping cost for the invoice.
object
For Stripe Connect, details of the destination account for transferring funds.
integer
Days until payment due (send_invoice only, draft only).
string
Payment source ID for the customer.
array
Tax IDs associated with the invoice.
object
Settings for the invoice payment process.
object
Shipping details for the invoice recipient.
string
Either ‘charge_automatically’ or ‘send_invoice’ (draft only).
array
Tax rates applied to line items without explicit rates.
string
Additional credit card statement information.
integer
Fee in cents transferred to application owner’s account.
string
Payment method ID for the customer.
integer
Scheduled finalization time (Unix timestamp).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_INVOICEITEMUpdates an invoice item on a draft invoice. Use when modifying invoice item properties like amount, description, discounts, or tax settings before invoice finalization.

Input Parameters

integer
The integer amount in cents of the charge to be applied to the upcoming invoice. To apply a credit, pass a negative value.
object
Time period for invoice item.
object
Pricing details for the invoice item.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information in a structured format. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value to metadata.
integer
Non-negative integer. The quantity of units for the invoice item.
string
A tax code ID.
array
The coupons, promotion codes & existing discounts which apply to the invoice item. Item discounts are applied before invoice discounts. Pass an empty array to remove previously-defined discounts.
array
The tax rates which apply to the invoice item. When set, the default_tax_rates on the invoice do not apply to this invoice item. Pass an empty array to remove previously-defined tax rates.
object
Data to create a new price inline.
string
An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.
boolean
Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.
string
Only required if a default tax behavior was not provided in the Stripe Tax settings. Specifies whether the price is considered inclusive of taxes or exclusive of taxes. One of inclusive, exclusive, or unspecified.
string
required
The ID of the invoice item to update. Must start with ‘ii_’ followed by alphanumeric characters.
string
Same as unit_amount, but accepts a decimal value with at most 12 decimal places.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_INVOICE_LINESBulk updates existing line items on a draft invoice, including descriptions, amounts, quantities and discounts. It can also update metadata on the invoice itself.

Input Parameters

array
required
List of line items to update. Each line item must have an ‘id’ field to identify which line item to update.
string
required
The ID of the invoice to update line items for. The invoice must be in ‘draft’ status.
object
Set of key-value pairs to attach to the invoice object itself.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_PAYMENT_INTENTUpdates 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 necessitate re-confirmation by the customer.

Input Parameters

integer
The amount intended to be collected by this PaymentIntent, in the smallest currency unit (e.g., cents for USD). This is a positive integer.
string
The three-letter ISO currency code, in lowercase (e.g., ‘usd’, ‘eur’). Must be a supported currency.
string
The ID of the Customer this PaymentIntent should be associated with.
object
A set of key-value pairs to store additional structured information about the PaymentIntent. Keys can be up to 40 characters long and values can be up to 500 characters long.
object
Shipping information for the PaymentIntent. This is a dictionary that should contain the recipient’s name, phone, and an address object with line1, line2 (optional), city, state, postal_code, and country.
string
An arbitrary string providing a description of the PaymentIntent, often displayed to users.
string
The email address to which Stripe will send a receipt for a successful payment.
string
ID of the PaymentMethod to attach to this PaymentIntent.
string
required
The unique identifier of the PaymentIntent to be updated.
string
Indicates if you intend to use the payment method attached to this PaymentIntent for future payments. Allowed values are ‘on_session’ or ‘off_session’.
string
String for customer’s credit card statement (max 22 characters).
string
Additional info for customer’s card statement, appended to statement_descriptor (max 22 characters).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_PAYMENT_METHODUpdates an existing PaymentMethod object in Stripe. Use when you need to modify billing details, expiration dates, or metadata for a payment method. The payment method must be attached to a customer before updates can be applied.

Input Parameters

object
Card details for card-type payment methods.
object
PayTo payment method details.
object
Key-value pairs for storing additional structured data. Post an empty object to clear all metadata.
string ("always" | "limited" | "unspecified")
Controls whether the payment method displays in checkout flows. Options: always, limited, unspecified.
object
Billing information associated with the PaymentMethod.
object
US bank account details.
string
required
The unique identifier of the payment method to update. Must be attached to a customer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_PRICEUpdates a Stripe price by setting passed parameter values; unspecified parameters remain unchanged. Use when you need to modify price metadata, active status, lookup key, or nickname. Note: Price amounts cannot be modified via API.

Input Parameters

string
required
The ID of the price to update.
boolean
Whether the price can be used for new purchases. Defaults to true.
object
Key-value pairs for storing additional information. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value to metadata.
string
Internal price description (hidden from customers).
string
Retrieval identifier (max 200 characters).
string
Tax classification: ‘inclusive’, ‘exclusive’, or ‘unspecified’. Once specified, it cannot be changed.
object
Per-currency pricing configuration. Keys must be ISO 4217 three-letter currency codes.
boolean
When true, atomically moves lookup key from another price to this one.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_PRODUCTTool to update an existing product in Stripe. Use when you need to modify product details like name, description, pricing, or availability.

Input Parameters

string
required
The unique identifier of the product to update.
string
A URL of a publicly-accessible webpage for this product.
string
The product’s name, meant to be displayable to the customer.
boolean
Whether the product is available for purchase. Set to false to archive.
array
A list of up to 8 URLs of images for this product, meant to be displayable to the customer.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
string
A tax code ID for determining tax rates on sales of this product.
boolean
Whether this product is shipped (i.e., physical goods).
string
A label that represents units of this product. When set, this will be included in customers’ receipts, invoices, Checkout, and the customer portal. Use singular form. Up to 12 characters.
string
The product’s description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product being sold for your own rendering purposes.
string
The ID of the Price object that is the default price for this product.
array
A list of up to 15 marketing features for this product. These are displayed in pricing tables.
object
The dimensions of the product for shipping purposes.
string
An arbitrary string to be displayed on your customer’s credit card or bank statement. While most banks display this information consistently, some may display it incorrectly or not at all. This may be up to 22 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_PROMOTION_CODEUpdates an existing Stripe promotion code by setting the values of the parameters passed. Use when you need to activate/deactivate a promotion code, update its metadata, or modify redemption restrictions. Most promotion code fields are intentionally non-editable after creation.

Input Parameters

string
required
The ID of the promotion code to update.
boolean
Whether the promotion code is currently active. Set to true to reactivate (requires a valid coupon and redeemable status), or false to deactivate.
object
Set of key-value pairs for storing additional structured information. Keys can be up to 40 characters, values up to 500 characters. Individual keys can be unset by posting an empty value.
object
Settings controlling promotion code redemption conditions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_QUOTETool to update an existing Stripe quote with new values. Use when modifying quote details like description, line items, metadata, or other quote parameters.

Input Parameters

string
required
The ID of the quote to update.
Quote PDF footer text (max 500 characters).
string
Quote PDF header text (max 50 characters).
string
Customer ID. Required before finalizing; cannot be changed once set.
object
Custom key-value pairs for structured data storage.
array
Applied discounts using coupon, discount ID, or promotion code.
integer
Future Unix timestamp when draft/open quote auto-cancels.
array
Quoted products and services with quantities and costs.
string
Quote PDF description (max 500 characters).
string
Account to charge on behalf of.
object
Automatic tax computation settings.
object
Automatic transfer configuration per invoice.
string
Account ID. Required before finalizing; immutable after setting.
object
Invoice billing configuration.
string
Payment method: ‘charge_automatically’ or ‘send_invoice’. Defaults to automatic.
array
Tax rates applied to line items without specific rates.
object
Subscription/schedule configuration data.
integer
Fee amount transferred to application owner’s Stripe account. Cannot be used with recurring line items.
number
Percentage (0-100, max 2 decimals) of subscription invoice transferred to app owner. Requires at least one recurring line item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_SOURCEUpdates a Stripe source with specified parameters. Use when you need to modify source metadata, owner information, or mandate details. NOTE: The Stripe Sources API is deprecated. Stripe recommends migrating to the Payment Methods API for new integrations. This action only works with sources created before the API deprecation.

Input Parameters

object
Payment instrument holder information.
integer
Monetary value linked to the source.
string
required
The unique identifier of the source object to be updated.
object
Bank debit authorization details.
object
Set of key-value pairs for storing additional information.
object
Items and shipping details for transactional sources.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_SUBSCRIPTIONUpdates an existing, non-canceled Stripe subscription by its ID, including supported item, billing, payment, tax, cancellation, and metadata settings.

Input Parameters

array
List of subscription item updates (max 20). Item id usually required for modification.
object
Key-value pairs for custom information (max 50 keys: 40 chars; values: 500 chars). Replaces existing; empty dict removes all.
string
Arbitrary string for user display or internal tracking.
object
Stripe Tax settings for automatic tax calculation. liability may be required if enabled is true.
string
required
Unique identifier of the subscription to update.
string ("allow_incomplete" | "error_if_incomplete" | "pending_if_incomplete")
Payment handling for invoices.
string ("charge_automatically" | "send_invoice")
How invoices are paid.
string ("create_prorations" | "none" | "always_invoice")
How to handle prorations on changes.
string
Unix timestamp (seconds) or ‘now’ to anchor billing cycle and renewal. Changes may cause proration.
boolean
If true, schedules cancellation at current period’s end; if false, undoes scheduled cancellation.
string
ID of the default payment method; updates subscription’s default payment source if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_SUBSCRIPTION_SCHEDULETool to update an existing subscription schedule in Stripe. Use when you need to modify phases, default settings, metadata, or end behavior of a subscription schedule.

Input Parameters

array
List of subscription phases with distinct configurations.
object
Custom key-value pairs for storing additional information.
string
required
The ID of the subscription schedule to update.
string ("release" | "cancel")
How to handle underlying subscription when schedule ends: ‘release’ (default) or ‘cancel’.
object
Default settings for subscription schedule.
string ("create_prorations" | "always_invoice" | "none")
How to handle prorations for billing configuration changes: ‘create_prorations’ (default), ‘always_invoice’, or ‘none’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_TAX_REGISTRATIONTool to update an existing tax registration in Stripe. Use when you need to modify the active_from or expires_at fields of a registration. Registrations cannot be deleted after creation; use expires_at to terminate them instead.

Input Parameters

string
required
Unique identifier for the tax registration object to update.
string
Time at which the registration expires. Can be ‘now’ or a Unix timestamp in seconds. If not set, the registration will remain active indefinitely.
string
Time at which the registration becomes active. Can be ‘now’ or a Unix timestamp in seconds.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_TAX_SETTINGSUpdates Stripe Tax Settings parameters used in tax calculations. Use to configure default tax behavior, tax codes, and business head office location for tax purposes.

Input Parameters

object
Default tax configuration settings.
object
The place where your business is located for tax purposes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_TERMINAL_LOCATIONUpdates a Terminal Location by modifying specified parameters. Use when you need to change location details like display name, address, phone, or metadata.

Input Parameters

string
The phone number of the location.
object
The full address of the location.
string
required
The identifier of the location to update. Must start with ‘tml_’ followed by alphanumeric characters.
object
Set of key-value pairs for storing additional information. Individual keys can be unset by posting an empty value. All keys can be unset by posting an empty value to metadata.
object
Kana variation of the address (Japan only).
string
A name for the location.
object
Kanji variation of the address (Japan only).
string
Kana variation of the display name (Japan only).
string
Kanji variation of the display name (Japan only).
string
Configuration ID to be used to customize all readers at this location.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_UPDATE_TERMINAL_READERTool to update a Terminal Reader object by setting parameter values. Use when you need to modify the label or metadata of an existing reader device.

Input Parameters

string
Custom label name for the reader to help distinguish it from other readers. Use this to set a friendly name.
string
required
The unique identifier of the Terminal Reader to update. Must start with ‘tmr_’ followed by alphanumeric characters.
object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_VALIDATE_PAYMENT_METHOD_DOMAINTool to validate an existing payment method domain in Stripe to activate payment methods. Use when additional registration steps need to be completed before a payment method can be used in Elements or Embedded Checkout.

Input Parameters

string
required
The payment method domain identifier to validate (e.g., pmd_1Nnrer2eZvKYlo2Cips79tWl).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_VERIFY_MICRODEPOSITSVerifies microdeposits on a SetupIntent object to confirm bank account ownership. Use when customer needs to verify their bank account using either amounts or descriptor code from microdeposits.

Input Parameters

array
Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. Provide this OR descriptor_code.
string
A six-character code starting with SM present in the microdeposit sent to the bank account. Provide this OR amounts.
string
required
The unique identifier of the SetupIntent to verify microdeposits for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_VERIFY_MICRODEPOSITS_PAYMENT_INTENTVerifies microdeposits on a PaymentIntent object by matching deposit amounts or descriptor code. Use after microdeposits are sent to complete bank account verification.

Input Parameters

string
required
The ID of the PaymentIntent to verify microdeposits for.
array
Two positive integers, in cents, equal to the values of the microdeposits sent to the bank account. Used to verify account ownership by matching the deposit amounts. Either amounts or descriptor_code must be provided, but not both.
string
A six-character code starting with SM present in the microdeposit sent to the bank account. This is an alternative verification method to using amounts. Either amounts or descriptor_code must be provided, but not both.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_VOID_CREDIT_NOTEMarks a credit note as void. Use when you need to void a credit note and reverse its adjustments.

Input Parameters

string
required
The identifier of the credit note to void. Typically starts with ‘cn_’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_VOID_INVOICEVoids a finalized Stripe invoice while maintaining a paper trail. Voiding is permanent and cannot be undone; draft invoices should be deleted instead.

Input Parameters

string
required
The identifier of the invoice to void. Must be a finalized invoice. Draft invoices should be deleted instead of voided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: STRIPE_WHO_AM_IReturn the connected Stripe account (account id, dashboard name). Identity is account-level.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not

Triggers

Slug: STRIPE_CHARGE_CAPTUREDType: webhookOccurs whenever a previously uncaptured charge is captured.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_DISPUTE_CLOSEDType: webhookOccurs when a dispute is closed and the dispute status changes to lost, warning_closed, or won.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_DISPUTE_CREATEDType: webhookOccurs whenever a customer disputes a charge with their bank.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_DISPUTE_UPDATEDType: webhookOccurs when the dispute is updated (usually with evidence).

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_FAILEDType: webhookOccurs whenever a failed charge attempt occurs.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_REFUNDEDType: webhookOccurs whenever a charge is refunded, including partial refunds. Listen to refund.created for information about the refund.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_REFUND_UPDATEDType: webhookOccurs whenever a refund is updated on selected payment methods. For updates on all refunds, listen to refund.updated instead.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHARGE_SUCCEEDEDType: webhookOccurs whenever a charge is successful.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHECKOUT_SESSION_ASYNC_PAYMENT_FAILEDType: webhookOccurs when a payment intent using a delayed payment method fails.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHECKOUT_SESSION_ASYNC_PAYMENT_SUCCEEDEDType: webhookOccurs when a payment intent using a delayed payment method finally succeeds.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHECKOUT_SESSION_COMPLETEDType: webhookOccurs when a Checkout Session has been successfully completed.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CHECKOUT_SESSION_EXPIREDType: webhookOccurs when a Checkout Session is expired.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_CREATEDType: webhookOccurs whenever a new customer is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_DELETEDType: webhookOccurs whenever a customer is deleted.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_SUBSCRIPTION_CREATEDType: webhookOccurs whenever a customer is signed up for a new plan.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_SUBSCRIPTION_DELETEDType: webhookOccurs whenever a customer’s subscription ends.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_SUBSCRIPTION_TRIAL_WILL_ENDType: webhookOccurs three days before a subscription’s trial period is scheduled to end, or immediately when a trial is ended early (for example, with trial_end=now or when a Customer Portal plan change ends a trial). If a trial is shortened so that fewer than three days remain, this event can fire immediately, including during the same transaction that collects payment. Before sending payment-reminder communications from this webhook, check the subscription status and latest invoice to determine whether payment has already been collected.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_SUBSCRIPTION_UPDATEDType: webhookOccurs whenever a subscription changes (e.g., switching from one plan to another, or changing the status from trial to active).

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_CUSTOMER_UPDATEDType: webhookOccurs whenever any property of a customer changes.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_CREATEDType: webhookOccurs whenever a new invoice is created. To learn how webhooks can be used with this event, and how they can affect it, see Using Webhooks with Subscriptions.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_FINALIZEDType: webhookOccurs whenever a draft invoice is finalized and updated to be an open invoice.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICEITEM_CREATEDType: webhookOccurs whenever an invoice item is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_PAIDType: webhookOccurs whenever an invoice payment attempt succeeds or an invoice is marked as paid out-of-band.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_PAYMENT_FAILEDType: webhookOccurs whenever an invoice payment attempt fails, due to either a declined payment, including soft decline, or to the lack of a stored payment method.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_PAYMENT_SUCCEEDEDType: webhookOccurs whenever an invoice payment attempt succeeds.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_UPCOMINGType: webhookOccurs X number of days before a subscription is scheduled to create an invoice that is automatically charged-where X is determined by your subscriptions settings. Note: The received Invoice object will not have an invoice ID.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_INVOICE_VOIDEDType: webhookOccurs whenever an invoice is voided.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYMENT_INTENT_CANCELEDType: webhookOccurs when a PaymentIntent is canceled.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYMENT_INTENT_CREATEDType: webhookOccurs when a new PaymentIntent is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYMENT_INTENT_PAYMENT_FAILEDType: webhookOccurs when a PaymentIntent has failed the attempt to create a payment method or a payment.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYMENT_INTENT_REQUIRES_ACTIONType: webhookOccurs when a PaymentIntent transitions to requires_action state.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYMENT_INTENT_SUCCEEDEDType: webhookOccurs when a PaymentIntent has successfully completed payment.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYOUT_FAILEDType: webhookOccurs whenever a payout attempt fails.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PAYOUT_PAIDType: webhookOccurs whenever a payout is expected to be available in the destination account. If the payout fails, a payout.failed notification is also sent, at a later time.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PRICE_CREATEDType: webhookOccurs whenever a price is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PRICE_UPDATEDType: webhookOccurs whenever a price is updated.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PRODUCT_CREATEDType: webhookOccurs whenever a product is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_PRODUCT_UPDATEDType: webhookOccurs whenever a product is updated.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.
Slug: STRIPE_REFUND_CREATEDType: webhookOccurs whenever a refund is created.

Payload

string
The connected account the event belongs to. Present only for events forwarded from a Stripe Connect account.
object
Event content — the resource is on data.object.
boolean
False when the event came from Stripe test mode.