Stripe connector

Bearer TokenAccounting & FinanceDeveloper ToolsAutomation

Connect to Stripe to manage customers, payments, products, subscriptions, invoices, and financial data.

Stripe connector

Install the SDK
Section titled “Install the SDK”
- Node.js
- Python
Terminal window
1 npm install @scalekit-sdk/node
Terminal window
1 pip install scalekit
Full SDK reference: Node.js | Python
Set your credentials
Section titled “Set your credentials”

Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Set up the connector
Section titled “Set up the connector”

Register your Stripe credentials with Scalekit so it can authenticate requests on your behalf. You do this once per environment.
Dashboard setup steps
Register your Stripe Secret Key with Scalekit so it can authenticate requests on your behalf. This connector uses a Bearer token — there is no redirect URI or OAuth flow.
1. Choose a sandbox or your live account
  
  Stripe separates every account into isolated environments: one or more sandboxes for testing, and the live account for real payments. Each environment has its own API keys, so pick the right one before you continue:
  - Use a sandbox (shown as Test mode in the dashboard) while you build and test your integration. Sandbox keys are prefixed sk_test_ and pk_test_, and never move real money.
  - Switch to your live account only when you’re ready to process real payments. Live keys are prefixed sk_live_ and pk_live_.
  A sandbox Secret Key only works against that sandbox’s data — it cannot see or affect your live account, and vice versa. If Scalekit requests fail with an authentication error, confirm you copied the key from the environment you intended.
2. Get your Secret Key
  - Sign in to the Stripe Dashboard and confirm the environment switcher in the top-left corner shows the sandbox or live account you want keys for.
  - Go to Developers → API keys.
  - Under Standard keys, click the Secret key row and reveal or copy its value.
  The Workbench overview page (Developers → Workbench) also surfaces a Testing tools panel with your current sandbox’s Test keys and a View all API keys shortcut — useful when you’re already debugging a request there.
  
  Treat the Secret Key like a password — it grants full API access to whichever environment it belongs to. Store it in an environment variable or secrets manager, never in source code or version control.
3. Add a connected account in Scalekit
  
  Connected accounts link a specific user identifier in your system to a Stripe Secret Key. Add one via the dashboard for testing, or via the Scalekit API in production. Use the Secret Key from step 2 as the token credential field — see Set your credentials above for the request shape.
  
  If you run sandbox and live traffic through the same Scalekit connection, create separate connected accounts per user and environment so each one holds the matching sk_test_ or sk_live_ key.

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3

4
const scalekit = new ScalekitClient(
5
  process.env.SCALEKIT_ENV_URL,
6
  process.env.SCALEKIT_CLIENT_ID,
7
  process.env.SCALEKIT_CLIENT_SECRET,
8
)
9
const actions = scalekit.actions
10

11
const connector = 'stripe'
12
const identifier = 'user_123'
13

14
// Make your first call
15
const result = await actions.executeTool({
16
  connector,
17
  identifier,
18
  toolName: 'stripe_get_account_dahlia',
19
  toolInput: {},
20
})
21
console.log(result)

1
import os
2
from scalekit.client import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENV_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "stripe"
14
identifier = "user_123"
15

16
# Make your first call
17
result = actions.execute_tool(
18
    tool_input={},
19
    tool_name="stripe_get_account_dahlia",
20
    connection_name=connection_name,
21
    identifier=identifier,
22
)
23
print(result)

What you can do

Connect this agent connector to let your agent:

Note void credit — Marks a previously issued credit note as void
Update subscription schedule, setup intent dahlia, price dahlia — Updates an existing subscription schedule, e.g
Send invoice dahlia — Manually sends an invoice to the customer’s email out of the normal automatic billing schedule
Search subscriptions dahlia, products dahlia, prices dahlia — Search for subscriptions using Stripe’s Search Query Language
Dahlia reverse payout, resume subscription, mark invoice uncollectible — Reverses a payout by debiting the destination bank account
List transfer reversals dahlia, subscription schedules, customer tax ids dahlia — Lists the reversals belonging to a specific transfer

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

stripe_accept_quote_dahlia#Accept a finalized Quote. Converts it into a subscription or invoice.1 param

Accept a finalized Quote. Converts it into a subscription or invoice.

NameTypeRequiredDescription

quotestringrequiredThe ID of the quote to accept.

stripe_attach_invoice_payment_dahlia#Attaches a PaymentIntent to an invoice, crediting the invoice's amount_paid when the PaymentIntent succeeds. Use this to record an out-of-band or externally-processed payment against an invoice.3 params

Attaches a PaymentIntent to an invoice, crediting the invoice's amount_paid when the PaymentIntent succeeds. Use this to record an out-of-band or externally-processed payment against an invoice.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to attach the payment to.

expandarrayoptionalList of fields to expand in the response.

payment_intentstringoptionalThe ID of the PaymentIntent to attach to the invoice.

stripe_attach_payment_method_dahlia#Attach a PaymentMethod to a Customer.2 params

Attach a PaymentMethod to a Customer.

NameTypeRequiredDescription

customerstringrequiredThe ID of the customer to attach the PaymentMethod to.

idstringrequiredThe ID of the PaymentMethod to attach.

stripe_cancel_payment_intent_dahlia#Cancels a PaymentIntent object when it's in a cancellable state. Depending on the payment method, it may be possible to cancel a PaymentIntent once it has been confirmed and is in requires_capture state.2 params

Cancels a PaymentIntent object when it's in a cancellable state. Depending on the payment method, it may be possible to cancel a PaymentIntent once it has been confirmed and is in requires_capture state.

NameTypeRequiredDescription

payment_intent_idstringrequiredThe ID of the PaymentIntent to cancel.

cancellation_reasonstringoptionalReason for canceling this PaymentIntent.

stripe_cancel_payout_dahlia#Cancel a payout that has not yet been paid out. Only cancels payouts with status 'pending'.1 param

Cancel a payout that has not yet been paid out. Only cancels payouts with status 'pending'.

NameTypeRequiredDescription

payoutstringrequiredThe ID of the payout to cancel.

stripe_cancel_quote_dahlia#Cancel a Quote that has been finalized but not yet accepted.1 param

Cancel a Quote that has been finalized but not yet accepted.

NameTypeRequiredDescription

quotestringrequiredThe ID of the quote to cancel.

stripe_cancel_refund_dahlia#Cancels a refund that has a status of requires_action. Only refunds for payment methods that require customer action can enter that state; refunds in other states cannot be canceled.2 params

Cancels a refund that has a status of requires_action. Only refunds for payment methods that require customer action can enter that state; refunds in other states cannot be canceled.

NameTypeRequiredDescription

refund_idstringrequiredThe ID of the refund to cancel.

expandarrayoptionalList of fields to expand in the response.

stripe_cancel_setup_intent_dahlia#Cancel a SetupIntent that has not been confirmed.2 params

Cancel a SetupIntent that has not been confirmed.

NameTypeRequiredDescription

setup_intent_idstringrequiredThe ID of the SetupIntent to cancel.

cancellation_reasonstringoptionalThe reason for canceling the SetupIntent.

stripe_cancel_subscription_dahlia#Cancels a customer's subscription immediately. The customer will not be charged again for the subscription. By default the subscription is canceled immediately but if prorate is set, any remaining charges are refunded.4 params

Cancels a customer's subscription immediately. The customer will not be charged again for the subscription. By default the subscription is canceled immediately but if prorate is set, any remaining charges are refunded.

NameTypeRequiredDescription

subscription_idstringrequiredThe ID of the subscription to cancel.

cancellation_detailsobjectoptionalDetails about why this subscription was cancelled.

invoice_nowbooleanoptionalWill generate a final invoice that charges for any un-invoiced metered usage.

proratebooleanoptionalWill generate a proration invoice item that credits remaining unused time until the subscription period end.

stripe_cancel_subscription_schedule#Cancels a subscription schedule and its associated subscription immediately (if the schedule has an active subscription). A subscription schedule can only be canceled if its status is 'not_started' or 'active'.3 params

Cancels a subscription schedule and its associated subscription immediately (if the schedule has an active subscription). A subscription schedule can only be canceled if its status is 'not_started' or 'active'.

NameTypeRequiredDescription

subscription_schedule_idstringrequiredThe ID of the subscription schedule to cancel.

invoice_nowbooleanoptionalIf the subscription schedule is active, indicates whether a final invoice will be generated for any un-invoiced metered usage and pending proration items. Defaults to true.

proratebooleanoptionalIf the subscription schedule is active, indicates whether the cancellation should be prorated. Defaults to true.

stripe_capture_charge_dahlia#Captures the payment of an existing, uncaptured charge that was created with capture set to false. Uncaptured charges expire (7 days by default) after which capture attempts fail.5 params

Captures the payment of an existing, uncaptured charge that was created with capture set to false. Uncaptured charges expire (7 days by default) after which capture attempts fail.

NameTypeRequiredDescription

charge_idstringrequiredThe ID of the uncaptured charge to capture.

amountintegeroptionalThe amount to capture, which must be less than or equal to the original charge amount.

expandarrayoptionalList of fields to expand in the response.

receipt_emailstringoptionalThe email address to send the receipt to, overriding any previously-specified email.

statement_descriptorstringoptionalText that appears on the customer's statement as the statement descriptor for a non-card charge.

stripe_close_dispute_dahlia#Close a dispute and accept the chargeback. This cannot be undone.1 param

Close a dispute and accept the chargeback. This cannot be undone.

NameTypeRequiredDescription

disputestringrequiredThe ID of the dispute to close.

stripe_confirm_payment_intent_dahlia#Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the payment method requires action (3DS, redirect), the PaymentIntent will move to requires_action.3 params

Confirm that your customer intends to pay with current or provided payment method. Upon confirmation, the PaymentIntent will attempt to initiate a payment. If the payment method requires action (3DS, redirect), the PaymentIntent will move to requires_action.

NameTypeRequiredDescription

payment_intent_idstringrequiredThe ID of the PaymentIntent to confirm.

payment_methodstringoptionalID of the payment method to confirm with.

return_urlstringoptionalThe URL to redirect the customer to after payment completion.

stripe_confirm_setup_intent_dahlia#Confirm a SetupIntent and attempt to collect a payment method for future use.3 params

Confirm a SetupIntent and attempt to collect a payment method for future use.

NameTypeRequiredDescription

setup_intent_idstringrequiredThe ID of the SetupIntent to confirm.

payment_methodstringoptionalID of the payment method to attach to this SetupIntent.

return_urlstringoptionalThe URL to redirect to after the SetupIntent is confirmed.

stripe_create_account_dahlia#Creates a new connected account for use with Stripe Connect. Platforms use this to onboard sellers, service providers, or other businesses to accept payments and receive payouts.12 params

Creates a new connected account for use with Stripe Connect. Platforms use this to onboard sellers, service providers, or other businesses to accept payments and receive payouts.

NameTypeRequiredDescription

business_profileobjectoptionalBusiness information shown to customers, such as the business's URL and MCC.

business_typestringoptionalThe business type: individual, company, government_entity, or non_profit.

capabilitiesobjectoptionalCapabilities to request for the account, e.g. card_payments and transfers.

companyobjectoptionalInformation about the company, used when business_type is 'company'.

controllerobjectoptionalConfiguration describing who is responsible for pricing, fee collection, and dashboard access on this account.

countrystringoptionalTwo-letter country code for the account holder's country.

default_currencystringoptionalThree-letter ISO currency code representing the default currency for the account.

emailstringoptionalThe email address of the account holder.

expandarrayoptionalList of fields to expand in the response.

individualobjectoptionalInformation about the individual represented by the account, used when business_type is 'individual'.

metadataobjectoptionalSet of key-value pairs to attach to the account.

tos_acceptanceobjectoptionalDetails on the account's acceptance of the Stripe Services Agreement.

stripe_create_account_external_account_dahlia#Adds an external account (a bank account or debit card) to a connected account for receiving payouts.5 params

Adds an external account (a bank account or debit card) to a connected account for receiving payouts.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

external_accountstringrequiredA token (from Stripe.js) representing the bank account or card to attach, or a dictionary of external account details.

default_for_currencybooleanoptionalWhether this external account should become the default for its currency.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the external account.

stripe_create_account_login_link_dahlia#Creates a single-use login link for a connected account that uses the Express Dashboard, letting the account holder access their dashboard without a separate Stripe login.2 params

Creates a single-use login link for a connected account that uses the Express Dashboard, letting the account holder access their dashboard without a separate Stripe login.

NameTypeRequiredDescription

accountstringrequiredThe ID of the Express-dashboard connected account.

expandarrayoptionalList of fields to expand in the response.

stripe_create_account_person_dahlia#Creates a new person associated with a connected account's legal entity, such as an owner, director, executive, or representative.11 params

Creates a new person associated with a connected account's legal entity, such as an owner, director, executive, or representative.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

addressobjectoptionalThe person's address.

dobobjectoptionalThe person's date of birth.

emailstringoptionalThe person's email address.

expandarrayoptionalList of fields to expand in the response.

first_namestringoptionalThe person's first name.

last_namestringoptionalThe person's last name.

metadataobjectoptionalSet of key-value pairs to attach to the person.

phonestringoptionalThe person's phone number.

relationshipobjectoptionalThe relationship that this person has with the account's legal entity (e.g. owner, director, representative).

ssn_last_4stringoptionalThe last four digits of the person's Social Security number (U.S. only).

stripe_create_application_fee_refund#Refunds an application fee previously collected via Stripe Connect but not yet fully refunded. Funds are refunded to the Stripe account from which the fee was originally collected. Can be called multiple times to partially refund a fee until it is entirely refunded.3 params

Refunds an application fee previously collected via Stripe Connect but not yet fully refunded. Funds are refunded to the Stripe account from which the fee was originally collected. Can be called multiple times to partially refund a fee until it is entirely refunded.

NameTypeRequiredDescription

application_fee_idstringrequiredThe ID of the application fee to refund.

amountintegeroptionalA positive integer, in the smallest currency unit, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee. Omit to refund the full remaining amount.

metadataobjectoptionalSet of key-value pairs to attach to the fee refund.

stripe_create_billing_meter#Creates a billing meter that defines how to aggregate usage events for usage-based billing prices.6 params

Creates a billing meter that defines how to aggregate usage events for usage-based billing prices.

NameTypeRequiredDescription

default_aggregationobjectrequiredThe default settings used to aggregate this meter's events.

display_namestringrequiredThe meter's name. Not visible to the customer. Max 250 characters.

event_namestringrequiredThe name of the meter event to record usage for. Corresponds with the event_name field on meter events. Max 100 characters.

customer_mappingobjectoptionalFields that specify how to map a meter event to a customer.

event_time_windowstringoptionalThe time window which meter events have been pre-aggregated for, if any.

value_settingsobjectoptionalFields that specify how to calculate a meter event's value.

stripe_create_billing_meter_event#Submits a usage event (e.g. API calls, minutes used) against a billing meter to drive usage-based billing.4 params

Submits a usage event (e.g. API calls, minutes used) against a billing meter to drive usage-based billing.

NameTypeRequiredDescription

event_namestringrequiredThe name of the meter event. Must match the event_name configured on a billing meter. Max 100 characters.

payloadobjectrequiredThe payload of the event. Must contain the fields corresponding to the meter's customer_mapping.event_payload_key (default 'stripe_customer_id') and value_settings.event_payload_key (default 'value').

identifierstringoptionalA unique identifier for the event. If not provided, one is generated. Stripe enforces uniqueness within a rolling period of at least 24 hours. Max 100 characters.

timestampintegeroptionalThe time of the event, in Unix seconds. Must be within the past 35 calendar days or up to 5 minutes in the future. Defaults to the current time if not specified.

stripe_create_billing_portal_configuration_dahlia#Creates a configuration that describes the functionality and behavior of the customer self-service billing portal, such as which features (subscription updates, cancellation, invoice history) are enabled.5 params

Creates a configuration that describes the functionality and behavior of the customer self-service billing portal, such as which features (subscription updates, cancellation, invoice history) are enabled.

NameTypeRequiredDescription

featuresobjectrequiredInformation about the features available in the portal, such as invoice_history, subscription_cancel, and payment_method_update.

business_profileobjectoptionalThe business information shown to customers in the portal.

default_return_urlstringoptionalThe default URL to redirect customers to when they click the portal's return-to-site link.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the configuration.

stripe_create_charge_dahlia#Creates a direct charge against a card or other payment source. Stripe recommends using the Payment Intents API for new integrations; this legacy endpoint remains useful for simple, immediate card charges.8 params

Creates a direct charge against a card or other payment source. Stripe recommends using the Payment Intents API for new integrations; this legacy endpoint remains useful for simple, immediate card charges.

NameTypeRequiredDescription

amountintegerrequiredAmount to be collected, in the smallest currency unit (e.g. cents for USD).

currencystringrequiredThree-letter ISO currency code for the charge.

capturebooleanoptionalWhether to immediately capture the charge. Defaults to true; pass false to create an authorization only.

customerstringoptionalThe ID of an existing customer to charge.

descriptionstringoptionalAn arbitrary string attached to the charge, shown in the dashboard.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the charge.

receipt_emailstringoptionalThe email address to which the receipt for this charge will be sent.

stripe_create_checkout_session_dahlia#Create a Checkout Session to accept one-time or subscription payments via Stripe-hosted page.8 params

Create a Checkout Session to accept one-time or subscription payments via Stripe-hosted page.

NameTypeRequiredDescription

modestringrequiredThe mode of the Checkout Session.

success_urlstringrequiredThe URL the customer will be redirected to after a successful payment.

cancel_urlstringoptionalThe URL the customer will be redirected to if they cancel the payment.

currencystringoptionalThree-letter ISO currency code (e.g., usd, eur, gbp).

customerstringoptionalID of an existing Customer to associate with this session.

customer_emailstringoptionalIf provided, this value will be used when the customer has not provided an email address.

line_itemsarrayoptionalArray of line items for this Checkout Session. Each item is a JSON object with fields: price (Stripe Price ID) and quantity. Required for payment/subscription mode.

metadataobjectoptionalSet of key-value pairs to attach to the Checkout Session.

stripe_create_coupon_dahlia#Create a coupon that can be redeemed for a discount on subscriptions or one-time charges.10 params

Create a coupon that can be redeemed for a discount on subscriptions or one-time charges.

NameTypeRequiredDescription

durationstringrequiredHow long the discount will be in effect. 'once' applies to the first charge, 'repeating' applies for duration_in_months, 'forever' applies indefinitely.

amount_offintegeroptionalFixed amount discount in the smallest currency unit (e.g. cents). Requires currency. Use this OR percent_off.

currencystringoptionalThree-letter ISO currency code. Required when amount_off is set.

duration_in_monthsintegeroptionalNumber of months the discount applies when duration is repeating.

idstringoptionalUnique identifier for the coupon. If not provided, Stripe generates a random ID.

max_redemptionsintegeroptionalMaximum number of times this coupon can be redeemed in total.

metadataobjectoptionalSet of key-value pairs for storing additional information.

namestringoptionalName of the coupon displayed to customers.

percent_offnumberoptionalPercentage discount to apply. Use this OR amount_off, not both.

redeem_byintegeroptionalUnix timestamp after which the coupon can no longer be redeemed.

stripe_create_credit_note#Issues a credit note to adjust the amount of a finalized invoice (e.g. to refund or credit a customer against that invoice). One of amount, lines, or shipping_cost must be provided.10 params

Issues a credit note to adjust the amount of a finalized invoice (e.g. to refund or credit a customer against that invoice). One of amount, lines, or shipping_cost must be provided.

NameTypeRequiredDescription

invoicestringrequiredThe ID of the invoice to credit.

amountintegeroptionalThe integer amount in the smallest currency unit representing the total amount of the credit note. One of amount, lines, or shipping_cost must be provided.

credit_amountintegeroptionalThe integer amount in the smallest currency unit to credit to the customer's balance, automatically applied to their next invoice.

email_typestringoptionalType of email to send to the customer.

linesarrayoptionalLine items that make up the credit note. One of amount, lines, or shipping_cost must be provided.

memostringoptionalThe credit note's memo, which appears on the credit note PDF.

metadataobjectoptionalSet of key-value pairs to attach to the credit note.

out_of_band_amountintegeroptionalThe integer amount in the smallest currency unit that is or will be credited outside of Stripe.

reasonstringoptionalReason for issuing this credit note.

refund_amountintegeroptionalThe integer amount in the smallest currency unit to refund. If set, a refund is created for the charge associated with the invoice.

stripe_create_customer_balance_transaction_dahlia#Creates an immutable transaction that adjusts a customer's credit balance, which is automatically applied to the customer's next invoices.6 params

Creates an immutable transaction that adjusts a customer's credit balance, which is automatically applied to the customer's next invoices.

NameTypeRequiredDescription

amountintegerrequiredThe signed integer amount, in the smallest currency unit, to apply to the customer's credit balance. A negative amount is a credit; a positive amount is a debit.

currencystringrequiredThree-letter ISO currency code for the balance transaction.

customer_idstringrequiredThe ID of the customer whose balance to adjust.

descriptionstringoptionalAn arbitrary string attached to the object, useful for displaying to users.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the balance transaction.

stripe_create_customer_dahlia#Creates a new customer object. Use this to store a customer's payment and billing details. The customer object allows you to perform recurring charges and track multiple charges associated with the same customer.9 params

Creates a new customer object. Use this to store a customer's payment and billing details. The customer object allows you to perform recurring charges and track multiple charges associated with the same customer.

NameTypeRequiredDescription

addressobjectoptionalThe customer's address as a JSON object with fields: line1, line2, city, state, postal_code, country.

descriptionstringoptionalAn arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.

emailstringoptionalCustomer's email address. It is displayed alongside the customer in the dashboard and can be useful for searching and tracking.

metadataobjectoptionalSet of key-value pairs that you can attach to an object. Useful for storing additional information about the customer.

namestringoptionalThe customer's full name or business name.

payment_methodstringoptionalThe ID of the PaymentMethod to attach to the customer.

phonestringoptionalThe customer's phone number.

shippingobjectoptionalThe customer's shipping information as a JSON object with name, address, and optional phone fields.

tax_exemptstringoptionalThe customer's tax exemption status. One of: none, exempt, or reverse.

stripe_create_customer_portal_session_dahlia#Creates a session of the customer portal. A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. Portal sessions are short-lived and will expire if the customer does not visit the URL.5 params

Creates a session of the customer portal. A portal session describes the instantiation of the customer portal for a particular customer. By visiting the session's URL, the customer can manage their subscriptions and billing details. Portal sessions are short-lived and will expire if the customer does not visit the URL.

NameTypeRequiredDescription

customerstringrequiredThe ID of an existing customer

configurationstringoptionalThe ID of an existing configuration to use for this session

localestringoptionalThe IETF language tag of the locale customer portal is displayed in

on_behalf_ofstringoptionalThe `on_behalf_of` account to use for this session

return_urlstringoptionalThe default URL to redirect customers to when they click on the portal's link to return to your website

stripe_create_customer_tax_id_dahlia#Creates a new tax ID (such as a VAT or GST number) for a customer, for use on invoices and tax reporting.4 params

Creates a new tax ID (such as a VAT or GST number) for a customer, for use on invoices and tax reporting.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer to add the tax ID to.

typestringrequiredThe type of tax ID, e.g. eu_vat, us_ein, gb_vat.

valuestringrequiredThe value of the tax ID.

expandarrayoptionalList of fields to expand in the response.

stripe_create_invoice_dahlia#This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay, send, and delete the invoice.11 params

This endpoint creates a draft invoice for a given customer. The draft invoice created pulls in all pending invoice items on that customer, including prorations. The invoice remains a draft until you finalize the invoice, which allows you to pay, send, and delete the invoice.

NameTypeRequiredDescription

customerstringrequiredThe ID of the customer to bill.

auto_advancebooleanoptionalControls whether Stripe performs automatic collection of the invoice.

collection_methodstringoptionalEither charge_automatically or send_invoice.

currencystringoptionalThree-letter ISO currency code.

days_until_dueintegeroptionalThe number of days from when the invoice is created until it is due (send_invoice only).

default_payment_methodstringoptionalID of the default payment method for this invoice.

descriptionstringoptionalAn arbitrary string attached to the invoice.

footerstringoptionalFooter text displayed on the invoice.

metadataobjectoptionalSet of key-value pairs to attach to the invoice.

pending_invoice_items_behaviorstringoptionalControls whether the customer's pending invoice items are attached to this invoice.

subscriptionstringoptionalThe ID of the subscription to invoice.

stripe_create_invoice_item_dahlia#Create an invoice item to be added to a pending invoice.7 params

Create an invoice item to be added to a pending invoice.

NameTypeRequiredDescription

currencystringrequiredThree-letter ISO currency code for the invoice item.

customerstringrequiredThe ID of the customer to create the invoice item for.

amountintegeroptionalThe amount in the smallest currency unit (e.g. cents for USD).

descriptionstringoptionalAn arbitrary string describing the invoice item.

invoicestringoptionalThe ID of an existing invoice to attach this item to.

pricestringoptionalThe ID of a Price to use for this invoice item.

quantityintegeroptionalNon-negative integer quantity of units for this invoice item.

stripe_create_invoice_preview_dahlia#Previews the upcoming invoice for a customer or subscription without creating it, showing pending charges, renewal amounts, invoice item charges, and any applicable discounts or prorations.7 params

Previews the upcoming invoice for a customer or subscription without creating it, showing pending charges, renewal amounts, invoice item charges, and any applicable discounts or prorations.

NameTypeRequiredDescription

currencystringoptionalThe currency to preview this invoice in. Defaults to the customer's currency if not specified.

customerstringoptionalThe ID of the customer whose upcoming invoice you're previewing.

expandarrayoptionalList of fields to expand in the response.

invoice_itemsarrayoptionalList of ad-hoc invoice items to add to the preview (up to 250).

preview_modestringoptionalWhether to preview only the next invoice, or a full recurring schedule. Defaults to 'next'.

subscriptionstringoptionalThe ID of the subscription to preview, e.g. to preview the effect of a plan change.

subscription_detailsobjectoptionalOverrides used to preview a subscription update, such as new items or a proration date.

stripe_create_payment_intent_dahlia#Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can also create and confirm a PaymentIntent in a single step by using the confirm parameter.12 params

Creates a PaymentIntent object. After the PaymentIntent is created, attach a payment method and confirm to continue the payment. You can also create and confirm a PaymentIntent in a single step by using the confirm parameter.

NameTypeRequiredDescription

amountintegerrequiredAmount intended to be collected in the smallest currency unit (e.g., 100 cents for $1.00 USD).

currencystringrequiredThree-letter ISO currency code (lowercase, e.g., usd, eur, gbp).

capture_methodstringoptionalControls when the funds will be captured from the customer's account.

confirmbooleanoptionalSet to true to attempt to confirm this PaymentIntent immediately after creation.

customerstringoptionalID of the Customer this PaymentIntent belongs to, if one exists.

descriptionstringoptionalAn arbitrary string attached to the object. Often useful for displaying to users.

metadataobjectoptionalSet of key-value pairs that you can attach to an object.

payment_methodstringoptionalID of the payment method to attach to this PaymentIntent.

payment_method_typesarrayoptionalThe payment method types to allow for this PaymentIntent (e.g. ["card"], ["card", "sepa_debit"]). Stripe's API requires this as an array, even for a single type.

receipt_emailstringoptionalEmail address to send the receipt to after successful payment.

return_urlstringoptionalThe URL to redirect to after payment is confirmed (used when confirm=true).

statement_descriptorstringoptionalText shown on the customer's bank or card statement (max 22 characters).

stripe_create_payment_method_dahlia#Create a PaymentMethod object. Attach it to a Customer to enable reusable payment.4 params

Create a PaymentMethod object. Attach it to a Customer to enable reusable payment.

NameTypeRequiredDescription

typestringrequiredThe type of payment method to create. Excludes 'link': Stripe rejects direct creation of a link PaymentMethod ("You cannot create a type `link` PaymentMethod directly") regardless of input — it can only be obtained via other flows (e.g. an automatic_payment_methods-enabled PaymentIntent/SetupIntent).

billing_detailsobjectoptionalBilling information associated with the PaymentMethod, as a JSON object with fields: name, email, phone.

cardobjectoptionalCard details (for type=card), as a JSON object with fields: number, exp_month, exp_year, cvc. Use Stripe test numbers like 4242424242424242.

metadataobjectoptionalSet of key-value pairs to attach to the PaymentMethod.

stripe_create_payout_dahlia#Create a payout to send funds to a bank account or debit card.6 params

Create a payout to send funds to a bank account or debit card.

NameTypeRequiredDescription

amountintegerrequiredAmount in the smallest currency unit (e.g., cents for USD). Must be a positive integer.

currencystringrequiredThree-letter ISO 4217 currency code for the payout.

descriptionstringoptionalAn arbitrary string to describe the payout.

destinationstringoptionalThe ID of a bank account or debit card to send the payout to.

methodstringoptionalThe method used to send the payout. 'standard' (bank transfer) or 'instant' (instant payout to debit card).

statement_descriptorstringoptionalA string that appears on the recipient's bank statement (max 22 characters).

stripe_create_plan_dahlia#Create a Plan (legacy billing API). Consider using Prices instead for new integrations.8 params

Create a Plan (legacy billing API). Consider using Prices instead for new integrations.

NameTypeRequiredDescription

amountintegerrequiredAmount to charge per billing interval, in the smallest currency unit (e.g. cents for USD).

currencystringrequiredThree-letter ISO currency code (lowercase) for the plan.

intervalstringrequiredBilling frequency for the plan.

productstringrequiredThe product ID (or inline product object) this plan belongs to.

idstringoptionalAn optional custom identifier for the plan. Must be unique.

interval_countintegeroptionalNumber of intervals between billings. For example, interval=month and interval_count=3 means every 3 months.

nicknamestringoptionalA friendly name for the plan shown in the Stripe dashboard.

trial_period_daysintegeroptionalNumber of trial period days granted when subscribing to this plan.

stripe_create_price_dahlia#Creates a new price for an existing product. Prices define how much and how often to charge for products. This includes one-time prices and recurring prices for subscriptions.10 params

Creates a new price for an existing product. Prices define how much and how often to charge for products. This includes one-time prices and recurring prices for subscriptions.

NameTypeRequiredDescription

currencystringrequiredThree-letter ISO currency code.

activebooleanoptionalWhether the price can be used for new purchases. Defaults to true.

billing_schemestringoptionalDescribes how to compute the price per period. Either per_unit or tiered.

lookup_keystringoptionalA lookup key used to retrieve prices dynamically from a static string.

metadataobjectoptionalSet of key-value pairs to attach to the price.

nicknamestringoptionalA brief description of the price, hidden from customers.

productstringoptionalThe ID of the product that this price will belong to.

recurringobjectoptionalRecurring billing details as a JSON object with fields: interval (day, week, month, year) and optional interval_count. Omit for a one-time price.

tax_behaviorstringoptionalSpecifies whether the price is considered inclusive of taxes or exclusive of taxes.

unit_amountintegeroptionalA positive integer in cents (or 0 for a free price) representing how much to charge.

stripe_create_product_dahlia#Creates a new product object. Products describe the specific goods or services you offer to your customers. Products are used in conjunction with Prices to configure how much and how often you charge customers.10 params

Creates a new product object. Products describe the specific goods or services you offer to your customers. Products are used in conjunction with Prices to configure how much and how often you charge customers.

NameTypeRequiredDescription

namestringrequiredThe product's name, meant to be displayable to the customer.

activebooleanoptionalWhether the product is currently available for purchase. Defaults to true.

descriptionstringoptionalThe product's description, meant to be displayable to the customer. Use this field to optionally store a long form explanation of the product.

imagesarrayoptionalA list of up to 8 URLs of images for this product.

metadataobjectoptionalSet of key-value pairs to attach to the product.

shippablebooleanoptionalWhether this product is shipped (i.e., physical goods).

statement_descriptorstringoptionalAn arbitrary string to be displayed on your customer's credit card or bank statement.

tax_codestringoptionalA tax code ID. Stripe Tax uses this to classify the product for tax calculations.

unit_labelstringoptionalA label that represents units of this product. When set, this will be included in customers' receipts, invoices, Checkout, and the customer portal.

urlstringoptionalA URL of a publicly-accessible webpage for this product.

stripe_create_promotion_code_dahlia#Create a promotion code for a coupon that customers can redeem.7 params

Create a promotion code for a coupon that customers can redeem.

NameTypeRequiredDescription

couponstringrequiredThe ID of the coupon to apply to this promotion code.

activebooleanoptionalWhether the promotion code is currently active. Defaults to true.

codestringoptionalHuman-readable code that customers enter at checkout. If not set, Stripe generates a random code.

customerstringoptionalRestrict this promotion code to a specific customer ID.

expires_atintegeroptionalUnix timestamp after which the promotion code can no longer be redeemed.

max_redemptionsintegeroptionalMaximum number of times this promotion code can be redeemed.

metadataobjectoptionalSet of key-value pairs for storing additional information.

stripe_create_quote_dahlia#Create a Quote for a subscription or one-time payment, which can be sent to customers for approval.8 params

Create a Quote for a subscription or one-time payment, which can be sent to customers for approval.

NameTypeRequiredDescription

customerstringoptionalThe ID of the customer the quote belongs to.

descriptionstringoptionalA description visible to customers on the quote.

expires_atintegeroptionalUnix timestamp at which the quote will expire.

footerstringoptionalFooter text shown at the bottom of the quote document.

headerstringoptionalHeader text shown at the top of the quote document.

line_itemsarrayoptionalA list of line items to include on the quote.

metadataobjectoptionalSet of key-value pairs to attach to the quote.

subscription_dataobjectoptionalSubscription data to apply when converting the quote to a subscription.

stripe_create_refund_dahlia#Create a refund for a charge or payment intent. Refunds a charge that has previously been created, with optional partial amount.4 params

Create a refund for a charge or payment intent. Refunds a charge that has previously been created, with optional partial amount.

NameTypeRequiredDescription

amountintegeroptionalA positive integer in the smallest currency unit representing how much to refund. Defaults to full refund if omitted.

chargestringoptionalThe identifier of the charge to refund. Either charge or payment_intent must be provided.

payment_intentstringoptionalThe identifier of the PaymentIntent to refund. Alternative to charge.

reasonstringoptionalThe reason for the refund.

stripe_create_setup_intent_dahlia#Create a SetupIntent to collect payment method details for future off-session payments.6 params

Create a SetupIntent to collect payment method details for future off-session payments.

NameTypeRequiredDescription

confirmbooleanoptionalSet to true to attempt to confirm this SetupIntent immediately.

customerstringoptionalID of the Stripe customer this SetupIntent is associated with.

descriptionstringoptionalAn arbitrary string description for the SetupIntent.

payment_methodstringoptionalID of the payment method to attach to this SetupIntent.

payment_method_typesarrayoptionalThe payment method types this SetupIntent is allowed to use (e.g. ["card"], ["card", "sepa_debit"]). Stripe's API requires this as an array, even for a single type.

usagestringoptionalIndicates how the payment method is intended to be used in the future.

stripe_create_subscription_dahlia#Creates a new subscription on an existing customer. Each customer can have multiple active subscriptions if needed.11 params

Creates a new subscription on an existing customer. Each customer can have multiple active subscriptions if needed.

NameTypeRequiredDescription

customerstringrequiredThe identifier of the customer to subscribe.

itemsarrayrequiredList of subscription items, each with a price ID and optional quantity.

cancel_at_period_endbooleanoptionalBoolean indicating whether this subscription should cancel at the end of the current period.

collection_methodstringoptionalEither charge_automatically or send_invoice.

currencystringoptionalThree-letter ISO currency code for the subscription.

days_until_dueintegeroptionalNumber of days a customer has to pay invoices (used with send_invoice collection method).

default_payment_methodstringoptionalID of the default payment method for this subscription.

metadataobjectoptionalSet of key-value pairs to attach to the subscription.

payment_behaviorstringoptionalControls how Stripe handles the first invoice when payment is required and collection_method=charge_automatically. Use default_incomplete to let the subscription go to status=incomplete (generating a PaymentIntent the client confirms) instead of hard-failing when the customer has no default payment method.

trial_endstringoptionalUnix timestamp for when the trial period ends. Use 'now' to end an existing trial.

trial_period_daysintegeroptionalInteger representing the number of trial period days before the customer is charged.

stripe_create_subscription_item_dahlia#Add a new item to an existing subscription.4 params

Add a new item to an existing subscription.

NameTypeRequiredDescription

pricestringrequiredThe ID of the price to use for this subscription item.

subscriptionstringrequiredThe ID of the subscription to add this item to.

proration_behaviorstringoptionalDetermines how to handle prorations when adding this item.

quantityintegeroptionalThe quantity of the plan to which the customer should be subscribed.

stripe_create_subscription_schedule#Creates a subscription schedule that predefines future phases/changes to a subscription (upgrades, downgrades, trial-to-paid transitions) on a fixed timeline. Provide either 'customer' with 'phases', or 'from_subscription' to migrate an existing subscription onto a schedule.8 params

Creates a subscription schedule that predefines future phases/changes to a subscription (upgrades, downgrades, trial-to-paid transitions) on a fixed timeline. Provide either 'customer' with 'phases', or 'from_subscription' to migrate an existing subscription onto a schedule.

NameTypeRequiredDescription

customerstringoptionalThe identifier of the customer to create the subscription schedule for. Required unless from_subscription is set.

default_settingsobjectoptionalDefault settings for the subscription schedule, applied to phases that don't override them (e.g. default_payment_method, collection_method, application_fee_percent).

end_behaviorstringoptionalBehavior when the schedule ends: 'release' (default, keeps the underlying subscription running as-is) or 'cancel' (cancels the underlying subscription).

expandarrayoptionalList of fields to expand in the response.

from_subscriptionstringoptionalMigrate an existing subscription to be managed by a subscription schedule, using the subscription's item(s), set to auto-renew using the subscription's interval. When set, phase values cannot also be set.

metadataobjectoptionalSet of key-value pairs to attach to the subscription schedule.

phasesarrayoptionalList of phases for the subscription schedule. Each phase can have different prices/quantities and duration. The end_date of one phase equals the start_date of the next.

start_datestringoptionalWhen the subscription schedule starts. Use 'now' to start immediately, or a Unix timestamp to backdate/postdate the start.

stripe_create_tax_rate_dahlia#Create a tax rate that can be applied to invoices and subscriptions.8 params

Create a tax rate that can be applied to invoices and subscriptions.

NameTypeRequiredDescription

display_namestringrequiredLabel shown to customers on invoices and receipts, e.g. VAT or GST.

inclusivebooleanrequiredWhether the tax is included in the price (true) or added on top (false).

percentagenumberrequiredThe tax rate percentage as a decimal, e.g. 20.0 for 20%.

countrystringoptionalTwo-letter ISO country code the tax rate applies to, e.g. DE or US.

descriptionstringoptionalInternal description of the tax rate, not shown to customers.

jurisdictionstringoptionalThe jurisdiction for the tax rate, displayed on invoices.

metadataobjectoptionalSet of key-value pairs for storing additional information.

statestringoptionalState, county, province, or region the tax rate applies to.

stripe_create_transfer_dahlia#Create a transfer to send funds to a connected Stripe account (Connect platforms).5 params

Create a transfer to send funds to a connected Stripe account (Connect platforms).

NameTypeRequiredDescription

amountintegerrequiredAmount to transfer in the smallest currency unit (e.g. cents for USD).

currencystringrequiredThree-letter ISO currency code (lowercase) for the transfer.

destinationstringrequiredThe ID of the connected Stripe account to transfer funds to.

descriptionstringoptionalAn optional description of the transfer.

source_transactionstringoptionalThe ID of a charge to use as the source for the transfer.

stripe_create_transfer_reversal_dahlia#Reverses a transfer, in full or in part. Multiple partial reversals are allowed until the entire transfer amount has been reversed. A fully-reversed transfer cannot be reversed again.6 params

Reverses a transfer, in full or in part. Multiple partial reversals are allowed until the entire transfer amount has been reversed. A fully-reversed transfer cannot be reversed again.

NameTypeRequiredDescription

transfer_idstringrequiredThe ID of the transfer to reverse.

amountintegeroptionalThe amount in the smallest currency unit to reverse. Omit to reverse the entire remaining transfer amount.

descriptionstringoptionalAn arbitrary string attached to the reversal object.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the reversal.

refund_application_feebooleanoptionalWhether the application fee should be refunded when reversing this transfer.

stripe_create_webhook_endpoint_dahlia#Create a webhook endpoint to receive Stripe event notifications at your HTTPS URL. Supports subscribing to any number of event types (or use * to receive all events).3 params

Create a webhook endpoint to receive Stripe event notifications at your HTTPS URL. Supports subscribing to any number of event types (or use * to receive all events).

NameTypeRequiredDescription

enabled_eventsarrayrequiredArray of event types to subscribe to. Use ["*"] to receive all events.

urlstringrequiredThe HTTPS URL of your webhook endpoint.

descriptionstringoptionalAn optional description of the webhook endpoint.

stripe_delete_account_dahlia#Deletes a connected account you manage. Test-mode accounts can be deleted at any time; live-mode accounts can only be deleted once all balances are zero and the account does not use the standard Stripe dashboard.1 param

Deletes a connected account you manage. Test-mode accounts can be deleted at any time; live-mode accounts can only be deleted once all balances are zero and the account does not use the standard Stripe dashboard.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account to delete.

stripe_delete_account_external_account_dahlia#Deletes a specified external account (bank account or card) from a connected account.2 params

Deletes a specified external account (bank account or card) from a connected account.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

idstringrequiredUnique identifier for the external account to delete.

stripe_delete_account_person_dahlia#Deletes an existing person's relationship to a connected account's legal entity. The representative cannot be deleted through this endpoint.2 params

Deletes an existing person's relationship to a connected account's legal entity. The representative cannot be deleted through this endpoint.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

personstringrequiredThe ID of the person to delete.

stripe_delete_coupon_dahlia#Delete a coupon. Customers that have already applied this coupon are not affected.1 param

Delete a coupon. Customers that have already applied this coupon are not affected.

NameTypeRequiredDescription

couponstringrequiredThe ID of the coupon to delete.

stripe_delete_customer_dahlia#Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.1 param

Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer to delete.

stripe_delete_customer_discount_dahlia#Removes the currently applied discount (coupon) from a customer.1 param

Removes the currently applied discount (coupon) from a customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer to remove the discount from.

stripe_delete_customer_tax_id_dahlia#Deletes an existing tax ID object from a customer.2 params

Deletes an existing tax ID object from a customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer the tax ID belongs to.

tax_idstringrequiredThe ID of the tax ID object to delete.

stripe_delete_invoice_dahlia#Permanently deletes a one-off invoice that is still in draft status. This cannot be undone. Finalized invoices, or invoices tied to a subscription, must be voided instead.1 param

Permanently deletes a one-off invoice that is still in draft status. This cannot be undone. Finalized invoices, or invoices tied to a subscription, must be voided instead.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the draft invoice to delete.

stripe_delete_invoice_item_dahlia#Delete an invoice item. Can only delete items that have not been finalized in an invoice.1 param

Delete an invoice item. Can only delete items that have not been finalized in an invoice.

NameTypeRequiredDescription

invoiceitemstringrequiredThe ID of the invoice item to delete.

stripe_delete_plan_dahlia#Delete a Plan. Customers subscribed to this plan are not affected.1 param

Delete a Plan. Customers subscribed to this plan are not affected.

NameTypeRequiredDescription

planstringrequiredThe ID of the plan to delete.

stripe_delete_product_dahlia#Deletes a product. This is only possible if the product has no prices associated with it.1 param

Deletes a product. This is only possible if the product has no prices associated with it.

NameTypeRequiredDescription

product_idstringrequiredThe ID of the product to delete.

stripe_delete_subscription_discount_dahlia#Removes the currently applied discount (coupon) from a subscription.1 param

Removes the currently applied discount (coupon) from a subscription.

NameTypeRequiredDescription

subscription_idstringrequiredThe ID of the subscription to remove the discount from.

stripe_delete_subscription_item_dahlia#Delete a subscription item, removing it from the subscription.2 params

Delete a subscription item, removing it from the subscription.

NameTypeRequiredDescription

itemstringrequiredThe ID of the subscription item to delete.

proration_behaviorstringoptionalDetermines how to handle prorations when deleting this item.

stripe_delete_webhook_endpoint_dahlia#Delete a webhook endpoint. Once deleted, the endpoint will no longer receive events from Stripe.1 param

Delete a webhook endpoint. Once deleted, the endpoint will no longer receive events from Stripe.

NameTypeRequiredDescription

webhook_endpointstringrequiredThe ID of the webhook endpoint to delete.

stripe_detach_payment_method_dahlia#Detach a PaymentMethod from a Customer, making it reusable for other customers.1 param

Detach a PaymentMethod from a Customer, making it reusable for other customers.

NameTypeRequiredDescription

idstringrequiredThe ID of the PaymentMethod to detach.

stripe_expire_checkout_session_dahlia#Expire a Checkout Session before it has been completed. Can only expire sessions in 'open' status.1 param

Expire a Checkout Session before it has been completed. Can only expire sessions in 'open' status.

NameTypeRequiredDescription

sessionstringrequiredThe ID of the Checkout Session to expire.

stripe_finalize_invoice_dahlia#Stripe automatically finalizes drafts before sending them. However, if you'd like to finalize a draft invoice manually, you can do so using this method. After an invoice is finalized, it can be paid or sent to customers.2 params

Stripe automatically finalizes drafts before sending them. However, if you'd like to finalize a draft invoice manually, you can do so using this method. After an invoice is finalized, it can be paid or sent to customers.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to finalize.

auto_advancebooleanoptionalControls whether Stripe performs automatic collection of the invoice after finalization.

stripe_finalize_quote_dahlia#Finalize a Quote to make it ready to be accepted by the customer.2 params

Finalize a Quote to make it ready to be accepted by the customer.

NameTypeRequiredDescription

quotestringrequiredThe ID of the quote to finalize.

expires_atintegeroptionalUnix timestamp at which the finalized quote will expire.

stripe_get_account_dahlia#Retrieve the details of the current Stripe account.0 params

Retrieve the details of the current Stripe account.

stripe_get_account_person_dahlia#Retrieves an existing person associated with a connected account's legal entity.3 params

Retrieves an existing person associated with a connected account's legal entity.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

personstringrequiredThe ID of the person to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_balance_dahlia#Retrieve the current balance of the Stripe account, showing available and pending amounts by currency.0 params

Retrieve the current balance of the Stripe account, showing available and pending amounts by currency.

stripe_get_balance_transaction_dahlia#Retrieve a balance transaction by ID. Balance transactions represent funds moving through the Stripe account.1 param

Retrieve a balance transaction by ID. Balance transactions represent funds moving through the Stripe account.

NameTypeRequiredDescription

idstringrequiredThe ID of the balance transaction to retrieve.

stripe_get_charge_dahlia#Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information.2 params

Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and Stripe will return the corresponding charge information.

NameTypeRequiredDescription

charge_idstringrequiredThe ID of the charge to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_checkout_session_dahlia#Retrieve a Checkout Session by ID.1 param

Retrieve a Checkout Session by ID.

NameTypeRequiredDescription

sessionstringrequiredThe ID of the Checkout Session to retrieve.

stripe_get_checkout_session_line_items_dahlia#Retrieves the full, paginated list of line items for a Checkout Session.5 params

Retrieves the full, paginated list of line items for a Checkout Session.

NameTypeRequiredDescription

session_idstringrequiredThe ID of the Checkout Session.

ending_beforestringoptionalLine item ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of line items to return (1-100, default 10).

starting_afterstringoptionalLine item ID to start pagination after.

stripe_get_connected_account_dahlia#Retrieves the details of a connected account by ID. Use this to check onboarding status, requirements, and capabilities for a specific Connect account, as opposed to the platform's own account.2 params

Retrieves the details of a connected account by ID. Use this to check onboarding status, requirements, and capabilities for a specific Connect account, as opposed to the platform's own account.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_coupon_dahlia#Retrieve a coupon by its ID.1 param

Retrieve a coupon by its ID.

NameTypeRequiredDescription

couponstringrequiredThe ID of the coupon to retrieve.

stripe_get_customer_dahlia#Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.2 params

Retrieves the details of an existing customer. You need only supply the unique customer identifier that was returned upon customer creation.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_customer_payment_method_dahlia#Retrieves a specific PaymentMethod that is attached to a given customer.3 params

Retrieves a specific PaymentMethod that is attached to a given customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer the payment method is attached to.

payment_method_idstringrequiredThe ID of the payment method to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_customer_tax_id_dahlia#Retrieves the tax ID object with the given identifier for a customer.3 params

Retrieves the tax ID object with the given identifier for a customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer the tax ID belongs to.

tax_idstringrequiredThe ID of the tax ID object to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_dispute_dahlia#Retrieve a dispute by ID. A dispute occurs when a customer questions a charge with their card issuer.1 param

Retrieve a dispute by ID. A dispute occurs when a customer questions a charge with their card issuer.

NameTypeRequiredDescription

disputestringrequiredThe ID of the dispute to retrieve.

stripe_get_event_dahlia#Retrieve an event by ID. Events are Stripe's way of notifying your application about changes.1 param

Retrieve an event by ID. Events are Stripe's way of notifying your application about changes.

NameTypeRequiredDescription

idstringrequiredThe ID of the event to retrieve.

stripe_get_invoice_dahlia#Retrieves the invoice with the given ID. Supply the unique invoice identifier that was returned from your previous request, and Stripe will return the corresponding invoice information.2 params

Retrieves the invoice with the given ID. Supply the unique invoice identifier that was returned from your previous request, and Stripe will return the corresponding invoice information.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_invoice_item_dahlia#Retrieves the invoice item with the given ID. Supply the unique invoice item identifier and Stripe will return the corresponding invoice item information.2 params

Retrieves the invoice item with the given ID. Supply the unique invoice item identifier and Stripe will return the corresponding invoice item information.

NameTypeRequiredDescription

invoice_item_idstringrequiredThe ID of the invoice item to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_payment_intent_dahlia#Retrieves the details of a PaymentIntent that was previously created. Supply the unique PaymentIntent ID and Stripe will return the corresponding PaymentIntent information.2 params

Retrieves the details of a PaymentIntent that was previously created. Supply the unique PaymentIntent ID and Stripe will return the corresponding PaymentIntent information.

NameTypeRequiredDescription

payment_intent_idstringrequiredThe ID of the PaymentIntent to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_payment_method_dahlia#Retrieve a PaymentMethod object.1 param

Retrieve a PaymentMethod object.

NameTypeRequiredDescription

idstringrequiredThe ID of the PaymentMethod to retrieve.

stripe_get_payout_dahlia#Retrieve a payout by ID.1 param

Retrieve a payout by ID.

NameTypeRequiredDescription

payoutstringrequiredThe ID of the payout to retrieve.

stripe_get_plan_dahlia#Retrieve a Plan by ID.1 param

Retrieve a Plan by ID.

NameTypeRequiredDescription

planstringrequiredThe ID of the plan to retrieve.

stripe_get_price_dahlia#Retrieves the price with the given ID.2 params

Retrieves the price with the given ID.

NameTypeRequiredDescription

price_idstringrequiredThe ID of the price to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_product_dahlia#Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.2 params

Retrieves the details of an existing product. Supply the unique product ID from either a product creation request or the product list, and Stripe will return the corresponding product information.

NameTypeRequiredDescription

product_idstringrequiredThe ID of the product to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_promotion_code_dahlia#Retrieve a promotion code by ID.1 param

Retrieve a promotion code by ID.

NameTypeRequiredDescription

promotion_codestringrequiredThe ID of the promotion code to retrieve.

stripe_get_quote_dahlia#Retrieve a Quote by ID.1 param

Retrieve a Quote by ID.

NameTypeRequiredDescription

quotestringrequiredThe ID of the quote to retrieve.

stripe_get_refund_dahlia#Retrieve the details of an existing refund.1 param

Retrieve the details of an existing refund.

NameTypeRequiredDescription

idstringrequiredThe ID of the refund to retrieve.

stripe_get_setup_intent_dahlia#Retrieve a SetupIntent by ID.1 param

Retrieve a SetupIntent by ID.

NameTypeRequiredDescription

setup_intent_idstringrequiredThe ID of the SetupIntent to retrieve.

stripe_get_subscription_dahlia#Retrieves the subscription with the given ID. Supply the unique subscription identifier that was returned from your previous request, and Stripe will return the corresponding subscription information.2 params

Retrieves the subscription with the given ID. Supply the unique subscription identifier that was returned from your previous request, and Stripe will return the corresponding subscription information.

NameTypeRequiredDescription

subscription_idstringrequiredThe ID of the subscription to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_subscription_item_dahlia#Retrieves the subscription item with the given ID. Supply the unique subscription item identifier and Stripe will return the corresponding subscription item information.2 params

Retrieves the subscription item with the given ID. Supply the unique subscription item identifier and Stripe will return the corresponding subscription item information.

NameTypeRequiredDescription

subscription_item_idstringrequiredThe ID of the subscription item to retrieve

expandarrayoptionalList of fields to expand in the response.

stripe_get_subscription_schedule#Retrieves the subscription schedule with the given ID.2 params

Retrieves the subscription schedule with the given ID.

NameTypeRequiredDescription

subscription_schedule_idstringrequiredThe ID of the subscription schedule to retrieve.

expandarrayoptionalList of fields to expand in the response.

stripe_get_tax_rate_dahlia#Retrieve a tax rate by ID.1 param

Retrieve a tax rate by ID.

NameTypeRequiredDescription

tax_ratestringrequiredThe ID of the tax rate to retrieve.

stripe_get_transfer_dahlia#Retrieve a transfer by ID.1 param

Retrieve a transfer by ID.

NameTypeRequiredDescription

transferstringrequiredThe ID of the transfer to retrieve.

stripe_get_transfer_reversal_dahlia#Retrieves the details of a specific reversal stored on a transfer. By default only the 10 most recent reversals are stored directly on the transfer object; use this to retrieve any reversal by ID.3 params

Retrieves the details of a specific reversal stored on a transfer. By default only the 10 most recent reversals are stored directly on the transfer object; use this to retrieve any reversal by ID.

NameTypeRequiredDescription

reversal_idstringrequiredThe ID of the reversal to retrieve.

transfer_idstringrequiredThe ID of the transfer the reversal belongs to.

expandarrayoptionalList of fields to expand in the response.

stripe_get_webhook_endpoint_dahlia#Retrieve a webhook endpoint by ID.1 param

Retrieve a webhook endpoint by ID.

NameTypeRequiredDescription

webhook_endpointstringrequiredThe ID of the webhook endpoint to retrieve.

stripe_list_account_capabilities_dahlia#Returns a list of capabilities (such as card_payments or transfers) associated with a connected account, along with each capability's current status.2 params

Returns a list of capabilities (such as card_payments or transfers) associated with a connected account, along with each capability's current status.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

expandarrayoptionalList of fields to expand in the response.

stripe_list_account_external_accounts_dahlia#Lists the external accounts (bank accounts and cards) attached to a connected account for receiving payouts.6 params

Lists the external accounts (bank accounts and cards) attached to a connected account for receiving payouts.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

ending_beforestringoptionalExternal account ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of external accounts to return (1-100, default 10).

objectstringoptionalFilter external accounts by object type.

starting_afterstringoptionalExternal account ID to start pagination after.

stripe_list_account_persons_dahlia#Returns a list of people associated with a connected account's legal entity, sorted by creation date with the most recent first.6 params

Returns a list of people associated with a connected account's legal entity, sorted by creation date with the most recent first.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

ending_beforestringoptionalPerson ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of persons to return (1-100, default 10).

relationshipobjectoptionalFilter people by their relationship to the account's company (e.g. representative, owner, director, executive).

starting_afterstringoptionalPerson ID to start pagination after.

stripe_list_accounts_dahlia#List all connected accounts on your platform (Connect platforms only).3 params

List all connected accounts on your platform (Connect platforms only).

NameTypeRequiredDescription

ending_beforestringoptionalCursor for pagination: return results before this account ID.

limitintegeroptionalMaximum number of accounts to return (1–100).

starting_afterstringoptionalCursor for pagination: return results after this account ID.

stripe_list_application_fees#Returns a list of application fees previously collected on charges made for connected accounts via Stripe Connect, most recent first.10 params

Returns a list of application fees previously collected on charges made for connected accounts via Stripe Connect, most recent first.

NameTypeRequiredDescription

chargestringoptionalOnly return application fees for the charge specified by this charge ID.

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

ending_beforestringoptionalApplication fee ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of application fees to return (1-100, default 10).

starting_afterstringoptionalApplication fee ID to start pagination after.

stripe_list_balance_transactions_dahlia#List all balance transactions, optionally filtered by currency, source, or type.6 params

List all balance transactions, optionally filtered by currency, source, or type.

NameTypeRequiredDescription

currencystringoptionalFilter by three-letter ISO currency code.

ending_beforestringoptionalBalance transaction ID to end pagination before.

limitintegeroptionalNumber of transactions to return (1-100, default 10).

sourcestringoptionalFilter by source object ID (charge or payout ID).

starting_afterstringoptionalBalance transaction ID to start pagination after.

typestringoptionalFilter by transaction type.

stripe_list_billing_portal_configurations_dahlia#Returns a list of configurations that describe the functionality of the customer self-service billing portal.6 params

Returns a list of configurations that describe the functionality of the customer self-service billing portal.

NameTypeRequiredDescription

activebooleanoptionalOnly return configurations that are active (true) or inactive (false).

ending_beforestringoptionalConfiguration ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

is_defaultbooleanoptionalOnly return the default (true) or non-default (false) configuration.

limitintegeroptionalNumber of configurations to return (1-100, default 10).

starting_afterstringoptionalConfiguration ID to start pagination after.

stripe_list_charges_dahlia#Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.10 params

Returns a list of charges you've previously created. The charges are returned in sorted order, with the most recent charges appearing first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalFilter charges by customer ID

ending_beforestringoptionalCharge ID to end pagination before

limitintegeroptionalNumber of charges to return (1-100, default 10)

payment_intentstringoptionalFilter charges by PaymentIntent ID

starting_afterstringoptionalCharge ID to start pagination after

stripe_list_checkout_sessions_dahlia#List all Checkout Sessions.6 params

List all Checkout Sessions.

NameTypeRequiredDescription

customerstringoptionalFilter sessions by customer ID.

ending_beforestringoptionalCursor for pagination. Returns sessions before this ID.

limitintegeroptionalMaximum number of sessions to return (1-100).

payment_intentstringoptionalFilter sessions by payment intent ID.

starting_afterstringoptionalCursor for pagination. Returns sessions after this ID.

subscriptionstringoptionalFilter sessions by subscription ID.

stripe_list_coupons_dahlia#List all coupons.3 params

List all coupons.

NameTypeRequiredDescription

ending_beforestringoptionalCursor for pagination. Returns results before this coupon ID.

limitintegeroptionalMaximum number of coupons to return (1–100).

starting_afterstringoptionalCursor for pagination. Returns results after this coupon ID.

stripe_list_credit_notes#Returns a list of credit notes, with the most recent appearing first.11 params

Returns a list of credit notes, with the most recent appearing first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalOnly return credit notes for the customer specified by this customer ID.

ending_beforestringoptionalCredit note ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

invoicestringoptionalOnly return credit notes for the invoice specified by this invoice ID.

limitintegeroptionalNumber of credit notes to return (1-100, default 10).

starting_afterstringoptionalCredit note ID to start pagination after.

stripe_list_customer_balance_transactions_dahlia#Returns a list of transactions that have updated a customer's credit balance.5 params

Returns a list of transactions that have updated a customer's credit balance.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer whose balance transactions you want to list.

ending_beforestringoptionalBalance transaction ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of balance transactions to return (1-100, default 10).

starting_afterstringoptionalBalance transaction ID to start pagination after.

stripe_list_customer_payment_methods_dahlia#List all PaymentMethods attached to a specific customer.5 params

List all PaymentMethods attached to a specific customer.

NameTypeRequiredDescription

customerstringrequiredThe ID of the customer whose payment methods to list.

ending_beforestringoptionalCursor for pagination — return results before this payment method ID.

limitintegeroptionalMaximum number of payment methods to return.

starting_afterstringoptionalCursor for pagination — return results after this payment method ID.

typestringoptionalFilter payment methods by type.

stripe_list_customer_tax_ids_dahlia#Returns a list of tax IDs registered for a customer.5 params

Returns a list of tax IDs registered for a customer.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer whose tax IDs you want to list.

ending_beforestringoptionalTax ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of tax IDs to return (1-100, default 10).

starting_afterstringoptionalTax ID to start pagination after.

stripe_list_customers_dahlia#Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. Supports filtering by email and pagination for large customer lists.10 params

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first. Supports filtering by email and pagination for large customer lists.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

emailstringoptionalFilter customers by exact email address

ending_beforestringoptionalCustomer ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of customers to return (1-100, default 10)

starting_afterstringoptionalCustomer ID to start pagination after

stripe_list_disputes_dahlia#List all disputes, optionally filtered by charge or payment intent.5 params

List all disputes, optionally filtered by charge or payment intent.

NameTypeRequiredDescription

chargestringoptionalFilter disputes by charge ID.

ending_beforestringoptionalCursor for pagination: return disputes before this dispute ID.

limitintegeroptionalMaximum number of disputes to return (1-100).

payment_intentstringoptionalFilter disputes by payment intent ID.

starting_afterstringoptionalCursor for pagination: return disputes after this dispute ID.

stripe_list_events_dahlia#List all events. Events represent noteworthy activity on your Stripe account.4 params

List all events. Events represent noteworthy activity on your Stripe account.

NameTypeRequiredDescription

ending_beforestringoptionalCursor for pagination: return events before this event ID.

limitintegeroptionalMaximum number of events to return (1-100).

starting_afterstringoptionalCursor for pagination: return events after this event ID.

typestringoptionalFilter events by type, e.g. payment_intent.created.

stripe_list_invoice_items_dahlia#Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recent invoice items appearing first.12 params

Returns a list of your invoice items. Invoice items are returned sorted by creation date, with the most recent invoice items appearing first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalFilter invoice items by customer ID

ending_beforestringoptionalInvoice item ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

invoicestringoptionalFilter invoice items by invoice ID

limitintegeroptionalNumber of invoice items to return (1-100, default 10)

pendingbooleanoptionalFilter by pending status

starting_afterstringoptionalInvoice item ID to start pagination after

stripe_list_invoice_line_items_dahlia#When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.5 params

When retrieving an invoice, you'll get a lines property containing the total count of line items and the first handful of those items. There is also a URL where you can retrieve the full (paginated) list of line items.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to list line items for

ending_beforestringoptionalLine item ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of line items to return (1-100, default 10)

starting_afterstringoptionalLine item ID to start pagination after

stripe_list_invoices_dahlia#Returns a list of your invoices. The invoices are returned sorted by creation date, with the most recent invoices appearing first.13 params

Returns a list of your invoices. The invoices are returned sorted by creation date, with the most recent invoices appearing first.

NameTypeRequiredDescription

collection_methodstringoptionalFilter invoices by collection method

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalFilter invoices by customer ID

ending_beforestringoptionalInvoice ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of invoices to return (1-100, default 10)

starting_afterstringoptionalInvoice ID to start pagination after

statusstringoptionalFilter invoices by status

subscriptionstringoptionalFilter invoices by subscription ID

stripe_list_payment_intents_dahlia#Returns a list of PaymentIntents. The PaymentIntents are returned sorted by creation date, with the most recent PaymentIntents appearing first.9 params

Returns a list of PaymentIntents. The PaymentIntents are returned sorted by creation date, with the most recent PaymentIntents appearing first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalFilter PaymentIntents by customer ID

ending_beforestringoptionalPaymentIntent ID to end pagination before

limitintegeroptionalNumber of results to return (1-100, default 10)

starting_afterstringoptionalPaymentIntent ID to start pagination after

stripe_list_payment_methods_dahlia#List PaymentMethods for a customer.5 params

List PaymentMethods for a customer.

NameTypeRequiredDescription

customerstringoptionalThe ID of the customer whose payment methods to list.

ending_beforestringoptionalCursor for pagination; returns results before this PaymentMethod ID.

limitintegeroptionalNumber of results to return (1–100).

starting_afterstringoptionalCursor for pagination; returns results after this PaymentMethod ID.

typestringoptionalFilter by payment method type.

stripe_list_payouts_dahlia#List all payouts, with optional filters by status and arrival date.6 params

List all payouts, with optional filters by status and arrival date.

NameTypeRequiredDescription

arrival_dateintegeroptionalFilter by arrival date (Unix timestamp).

destinationstringoptionalFilter by destination bank account or card ID.

ending_beforestringoptionalPayout ID to end pagination before.

limitintegeroptionalNumber of payouts to return (1-100, default 10).

starting_afterstringoptionalPayout ID to start pagination after.

statusstringoptionalFilter by payout status.

stripe_list_plans_dahlia#List all Plans.5 params

List all Plans.

NameTypeRequiredDescription

activebooleanoptionalFilter plans by active status. Pass true to list only active plans.

ending_beforestringoptionalCursor for pagination: return results before this plan ID.

limitintegeroptionalMaximum number of plans to return (1–100).

productstringoptionalFilter plans by product ID.

starting_afterstringoptionalCursor for pagination: return results after this plan ID.

stripe_list_prices_dahlia#Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.7 params

Returns a list of your active prices, excluding inline prices. For the list of inactive prices, set active to false.

NameTypeRequiredDescription

activebooleanoptionalOnly return prices that are active or inactive.

currencystringoptionalOnly return prices for the given currency.

ending_beforestringoptionalPrice ID to end pagination before

limitintegeroptionalNumber of prices to return (1-100, default 10)

productstringoptionalOnly return prices for the given product.

starting_afterstringoptionalPrice ID to start pagination after

typestringoptionalOnly return prices of this type.

stripe_list_products_dahlia#Returns a list of your products. The products are returned sorted by creation date, with the most recent products appearing first.13 params

Returns a list of your products. The products are returned sorted by creation date, with the most recent products appearing first.

NameTypeRequiredDescription

activebooleanoptionalFilter products by active status

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

ending_beforestringoptionalProduct ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of products to return (1-100, default 10)

shippablebooleanoptionalFilter products by shippable status

starting_afterstringoptionalProduct ID to start pagination after

typestringoptionalFilter products by type

urlstringoptionalFilter products by URL

stripe_list_promotion_codes_dahlia#List all promotion codes.7 params

List all promotion codes.

NameTypeRequiredDescription

activebooleanoptionalFilter by active status. True returns only active codes, false returns only inactive.

codestringoptionalFilter by the exact customer-facing code string.

couponstringoptionalFilter by the coupon ID the promotion codes belong to.

customerstringoptionalFilter by the customer ID the promotion codes are restricted to.

ending_beforestringoptionalCursor for reverse pagination. Returns results before this promotion code ID.

limitintegeroptionalMaximum number of promotion codes to return (1–100).

starting_afterstringoptionalCursor for forward pagination. Returns results after this promotion code ID.

stripe_list_quotes_dahlia#List all Quotes.5 params

List all Quotes.

NameTypeRequiredDescription

customerstringoptionalFilter quotes by customer ID.

ending_beforestringoptionalCursor for pagination — return results before this quote ID.

limitintegeroptionalMaximum number of quotes to return.

starting_afterstringoptionalCursor for pagination — return results after this quote ID.

statusstringoptionalFilter quotes by status.

stripe_list_refunds_dahlia#List all refunds, optionally filtered by charge or payment intent.5 params

List all refunds, optionally filtered by charge or payment intent.

NameTypeRequiredDescription

chargestringoptionalFilter refunds by the charge ID.

ending_beforestringoptionalA cursor for pagination. Returns objects before this refund ID.

limitintegeroptionalA limit on the number of objects to be returned, between 1 and 100.

payment_intentstringoptionalFilter refunds by the PaymentIntent ID.

starting_afterstringoptionalA cursor for pagination. Returns objects after this refund ID.

stripe_list_setup_intents_dahlia#List all SetupIntents.5 params

List all SetupIntents.

NameTypeRequiredDescription

customerstringoptionalFilter by customer ID.

ending_beforestringoptionalA cursor for pagination. Returns objects before this ID.

limitintegeroptionalMaximum number of objects to return (1–100).

payment_methodstringoptionalFilter by payment method ID.

starting_afterstringoptionalA cursor for pagination. Returns objects after this ID.

stripe_list_subscription_items_dahlia#Returns a list of subscription items for a given subscription. Subscription items represent the component lines of a subscription.5 params

Returns a list of subscription items for a given subscription. Subscription items represent the component lines of a subscription.

NameTypeRequiredDescription

subscriptionstringrequiredThe ID of the subscription to list items for

ending_beforestringoptionalSubscription item ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of subscription items to return (1-100, default 10)

starting_afterstringoptionalSubscription item ID to start pagination after

stripe_list_subscription_schedules#Retrieves the list of your subscription schedules, sorted by creation date with the most recent first.11 params

Retrieves the list of your subscription schedules, sorted by creation date with the most recent first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalOnly return subscription schedules for the given customer.

ending_beforestringoptionalSubscription schedule ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of subscription schedules to return (1-100, default 10).

scheduledbooleanoptionalOnly return subscription schedules that have not started yet.

starting_afterstringoptionalSubscription schedule ID to start pagination after.

stripe_list_subscriptions_dahlia#Returns a list of your subscriptions. The subscriptions are returned sorted by creation date, with the most recent subscriptions appearing first.12 params

Returns a list of your subscriptions. The subscriptions are returned sorted by creation date, with the most recent subscriptions appearing first.

NameTypeRequiredDescription

createdintegeroptionalFilter by exact creation timestamp (Unix seconds). For a range filter, use created_gt/created_gte/created_lt/created_lte instead.

created_gtintegeroptionalFilter by creation date, strictly after this Unix timestamp.

created_gteintegeroptionalFilter by creation date, at or after this Unix timestamp.

created_ltintegeroptionalFilter by creation date, strictly before this Unix timestamp.

created_lteintegeroptionalFilter by creation date, at or before this Unix timestamp.

customerstringoptionalFilter subscriptions by customer ID

ending_beforestringoptionalSubscription ID to end pagination before

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of subscriptions to return (1-100, default 10)

pricestringoptionalFilter subscriptions by price ID

starting_afterstringoptionalSubscription ID to start pagination after

statusstringoptionalFilter subscriptions by status

stripe_list_tax_rates_dahlia#List all tax rates.5 params

List all tax rates.

NameTypeRequiredDescription

activebooleanoptionalFilter to only return active or inactive tax rates.

ending_beforestringoptionalA cursor for pagination. Returns objects before this ID.

inclusivebooleanoptionalFilter to return only inclusive or exclusive tax rates.

limitintegeroptionalMaximum number of objects to return (1–100).

starting_afterstringoptionalA cursor for pagination. Returns objects after this ID.

stripe_list_transfer_reversals_dahlia#Lists the reversals belonging to a specific transfer. The 10 most recent reversals are always available directly on the transfer object; use this to page through additional ones.5 params

Lists the reversals belonging to a specific transfer. The 10 most recent reversals are always available directly on the transfer object; use this to page through additional ones.

NameTypeRequiredDescription

transfer_idstringrequiredThe ID of the transfer whose reversals you want to list.

ending_beforestringoptionalReversal ID to end pagination before.

expandarrayoptionalList of fields to expand in the response.

limitintegeroptionalNumber of reversals to return (1-100, default 10).

starting_afterstringoptionalReversal ID to start pagination after.

stripe_list_transfers_dahlia#List all transfers to connected accounts.4 params

List all transfers to connected accounts.

NameTypeRequiredDescription

destinationstringoptionalFilter transfers by the connected account ID they were sent to.

ending_beforestringoptionalCursor for pagination: return results before this transfer ID.

limitintegeroptionalMaximum number of transfers to return (1–100).

starting_afterstringoptionalCursor for pagination: return results after this transfer ID.

stripe_list_webhook_endpoints_dahlia#List all webhook endpoints.3 params

List all webhook endpoints.

NameTypeRequiredDescription

ending_beforestringoptionalCursor for pagination: return endpoints before this webhook endpoint ID.

limitintegeroptionalMaximum number of webhook endpoints to return (1-100).

starting_afterstringoptionalCursor for pagination: return endpoints after this webhook endpoint ID.

stripe_mark_invoice_uncollectible_dahlia#Marks an invoice as uncollectible, which is useful for tracking bad debt that will be written off for accounting purposes.2 params

Marks an invoice as uncollectible, which is useful for tracking bad debt that will be written off for accounting purposes.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to mark as uncollectible.

expandarrayoptionalList of fields to expand in the response.

stripe_pay_invoice_dahlia#Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you use this endpoint.3 params

Stripe automatically creates and then attempts to collect payment on invoices for customers on subscriptions according to your subscriptions settings. However, if you'd like to attempt payment on an invoice out of the normal collection schedule or for some other reason, you use this endpoint.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to pay.

forgivebooleanoptionalIn cases where the source used to pay the invoice has insufficient funds, the invoice becomes past_due. Setting forgive to true forgives the invoice and marks it as paid.

payment_methodstringoptionalID of the payment method to use for this invoice payment.

stripe_resume_subscription_dahlia#Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Only available for subscriptions using the charge_automatically collection method.4 params

Initiates resumption of a paused subscription, optionally resetting the billing cycle anchor and creating prorations. Only available for subscriptions using the charge_automatically collection method.

NameTypeRequiredDescription

subscription_idstringrequiredThe ID of the paused subscription to resume.

billing_cycle_anchorstringoptionalThe billing cycle anchor to apply when resuming: 'now' or 'unchanged'. Defaults to 'now'.

expandarrayoptionalList of fields to expand in the response.

proration_behaviorstringoptionalHow to handle prorations resulting from the billing_cycle_anchor being 'unchanged'.

stripe_reverse_payout_dahlia#Reverses a payout by debiting the destination bank account. Only available for payouts to US and Canadian bank accounts. For a pending manual payout, cancel it instead of reversing it.3 params

Reverses a payout by debiting the destination bank account. Only available for payouts to US and Canadian bank accounts. For a pending manual payout, cancel it instead of reversing it.

NameTypeRequiredDescription

payout_idstringrequiredThe ID of the payout to reverse.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the reversal.

stripe_search_charges_dahlia#Search for charges using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for charges using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_customers_dahlia#Search for customers using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for customers using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_invoices_dahlia#Search for invoices using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for invoices using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_payment_intents_dahlia#Search for payment intents using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for payment intents using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_prices_dahlia#Search for prices using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for prices using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_products_dahlia#Search for products using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for products using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_search_subscriptions_dahlia#Search for subscriptions using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.3 params

Search for subscriptions using Stripe's Search Query Language. Data is typically searchable within a minute of being written; do not use this in read-after-write flows requiring strict consistency.

NameTypeRequiredDescription

querystringrequiredThe search query string using Stripe's Search Query Language.

limitintegeroptionalNumber of results to return (1-100, default 10).

pagestringoptionalCursor for pagination across multiple pages of search results.

stripe_send_invoice_dahlia#Manually sends an invoice to the customer's email out of the normal automatic billing schedule. In test mode, no email is actually sent even though an invoice.sent event fires.2 params

Manually sends an invoice to the customer's email out of the normal automatic billing schedule. In test mode, no email is actually sent even though an invoice.sent event fires.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the finalized invoice to send.

expandarrayoptionalList of fields to expand in the response.

stripe_update_account_capability_dahlia#Updates an existing account capability by requesting it or removing a previous request. Request or remove a capability by updating its 'requested' parameter.4 params

Updates an existing account capability by requesting it or removing a previous request. Request or remove a capability by updating its 'requested' parameter.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

capabilitystringrequiredThe capability identifier, e.g. card_payments or transfers.

expandarrayoptionalList of fields to expand in the response.

requestedbooleanoptionalWhether to request the capability. Pass true to request it; pass false to remove a previous request.

stripe_update_account_dahlia#Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.9 params

Updates a connected account by setting the values of the parameters passed. Any parameters not provided are left unchanged.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account to update.

business_profileobjectoptionalBusiness information shown to customers, such as the business's URL and MCC.

companyobjectoptionalInformation about the company, used when business_type is 'company'.

default_currencystringoptionalThree-letter ISO currency code representing the default currency for the account.

emailstringoptionalThe email address of the account holder.

expandarrayoptionalList of fields to expand in the response.

individualobjectoptionalInformation about the individual represented by the account.

metadataobjectoptionalSet of key-value pairs to attach to the account.

tos_acceptanceobjectoptionalDetails on the account's acceptance of the Stripe Services Agreement.

stripe_update_account_person_dahlia#Updates an existing person associated with a connected account's legal entity.10 params

Updates an existing person associated with a connected account's legal entity.

NameTypeRequiredDescription

accountstringrequiredThe ID of the connected account.

personstringrequiredThe ID of the person to update.

addressobjectoptionalThe person's address.

emailstringoptionalThe person's email address.

expandarrayoptionalList of fields to expand in the response.

first_namestringoptionalThe person's first name.

last_namestringoptionalThe person's last name.

metadataobjectoptionalSet of key-value pairs to attach to the person.

phonestringoptionalThe person's phone number.

relationshipobjectoptionalThe relationship that this person has with the account's legal entity.

stripe_update_charge_dahlia#Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged.6 params

Updates the specified charge by setting the values of the parameters passed. Any parameters not provided are left unchanged.

NameTypeRequiredDescription

charge_idstringrequiredThe ID of the charge to update.

descriptionstringoptionalAn arbitrary string attached to the charge.

expandarrayoptionalList of fields to expand in the response.

fraud_detailsobjectoptionalInformation about the charge's riskiness, e.g. marking it as fraudulent or safe.

metadataobjectoptionalSet of key-value pairs to attach to the charge.

receipt_emailstringoptionalThis is the email address that the receipt for this charge will be sent to.

stripe_update_checkout_session_dahlia#Updates an open Checkout Session, such as extending its expiration or changing its line items. Related guide: dynamically updating a Checkout Session.4 params

Updates an open Checkout Session, such as extending its expiration or changing its line items. Related guide: dynamically updating a Checkout Session.

NameTypeRequiredDescription

session_idstringrequiredThe ID of the Checkout Session to update.

collected_informationobjectoptionalInformation about the customer collected within the session. Can only be set when updating embedded or custom sessions.

expandarrayoptionalList of fields to expand in the response.

line_itemsarrayoptionalThe full list of items the customer is purchasing. When updating, you must retransmit the entire array; include an existing item's id to retain it.

stripe_update_coupon_dahlia#Update a coupon's name or metadata.3 params

Update a coupon's name or metadata.

NameTypeRequiredDescription

couponstringrequiredThe ID of the coupon to update.

metadataobjectoptionalSet of key-value pairs for storing additional information. Replaces existing metadata.

namestringoptionalUpdated name for the coupon, shown to customers.

stripe_update_customer_dahlia#Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.8 params

Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

NameTypeRequiredDescription

customer_idstringrequiredThe ID of the customer to update.

addressobjectoptionalThe customer's address as a JSON object with fields: line1, line2, city, state, postal_code, country.

descriptionstringoptionalAn arbitrary string that you can attach to a customer object.

emailstringoptionalCustomer's email address.

metadataobjectoptionalSet of key-value pairs to attach to the customer. Pass an empty value to remove a key.

namestringoptionalThe customer's full name or business name.

phonestringoptionalThe customer's phone number.

tax_exemptstringoptionalThe customer's tax exemption status. One of: none, exempt, or reverse.

stripe_update_dispute_dahlia#Update a dispute to submit evidence to the card issuer and potentially win the chargeback.6 params

Update a dispute to submit evidence to the card issuer and potentially win the chargeback.

NameTypeRequiredDescription

disputestringrequiredThe ID of the dispute to update.

customer_email_addressstringoptionalCustomer's email address as evidence.

customer_namestringoptionalCustomer's name as evidence.

product_descriptionstringoptionalDescription of the product or service as evidence.

shipping_documentationstringoptionalFile ID for shipping documentation evidence.

submitbooleanoptionalIf true, immediately submit evidence to the card issuer.

stripe_update_invoice_item_dahlia#Update an invoice item's amount, description, or metadata.4 params

Update an invoice item's amount, description, or metadata.

NameTypeRequiredDescription

invoiceitemstringrequiredThe ID of the invoice item to update.

amountintegeroptionalThe new amount in the smallest currency unit (e.g. cents for USD).

descriptionstringoptionalAn updated description for the invoice item.

quantityintegeroptionalNon-negative integer quantity of units for this invoice item.

stripe_update_payment_intent_dahlia#Updates properties on a PaymentIntent object without confirming it. Updating certain properties, such as payment_method, requires confirming the PaymentIntent again afterward.8 params

Updates properties on a PaymentIntent object without confirming it. Updating certain properties, such as payment_method, requires confirming the PaymentIntent again afterward.

NameTypeRequiredDescription

payment_intent_idstringrequiredThe ID of the PaymentIntent to update.

amountintegeroptionalAmount intended to be collected, in the smallest currency unit.

currencystringoptionalThree-letter ISO currency code.

customerstringoptionalID of the customer this PaymentIntent belongs to.

descriptionstringoptionalAn arbitrary string attached to the object, useful for displaying to users.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the PaymentIntent.

receipt_emailstringoptionalEmail address the receipt for the resulting payment will be sent to.

stripe_update_payment_method_dahlia#Updates a PaymentMethod object. The PaymentMethod must already be attached to a customer to be updated.5 params

Updates a PaymentMethod object. The PaymentMethod must already be attached to a customer to be updated.

NameTypeRequiredDescription

payment_method_idstringrequiredThe ID of the payment method to update.

billing_detailsobjectoptionalBilling information associated with the payment method.

cardobjectoptionalIf this is a card PaymentMethod, a hash of updatable card fields (currently only exp_month and exp_year).

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the payment method.

stripe_update_payout_dahlia#Updates the specified payout by setting the values of the parameters passed. This request only accepts metadata as an argument.3 params

Updates the specified payout by setting the values of the parameters passed. This request only accepts metadata as an argument.

NameTypeRequiredDescription

payout_idstringrequiredThe ID of the payout to update.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the payout.

stripe_update_plan_dahlia#Update a Plan's nickname, active status, or metadata.5 params

Update a Plan's nickname, active status, or metadata.

NameTypeRequiredDescription

planstringrequiredThe ID of the plan to update.

activebooleanoptionalWhether the plan is currently available for new subscriptions.

metadataobjectoptionalSet of key-value pairs to attach to the plan object.

nicknamestringoptionalA brief description of the plan, hidden from customers.

trial_period_daysintegeroptionalDefault number of trial days for subscriptions created using this plan.

stripe_update_price_dahlia#Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged. Core pricing fields like unit_amount and currency are immutable once a price is created.7 params

Updates the specified price by setting the values of the parameters passed. Any parameters not provided are left unchanged. Core pricing fields like unit_amount and currency are immutable once a price is created.

NameTypeRequiredDescription

price_idstringrequiredThe ID of the price to update.

activebooleanoptionalWhether the price can be used for new purchases. Defaults to true.

expandarrayoptionalList of fields to expand in the response.

lookup_keystringoptionalA lookup key used to retrieve this price dynamically from a static string.

metadataobjectoptionalSet of key-value pairs to attach to the price.

nicknamestringoptionalA brief description of the price, hidden from customers.

tax_behaviorstringoptionalWhether the price is considered inclusive or exclusive of tax.

stripe_update_product_dahlia#Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.8 params

Updates the specific product by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

NameTypeRequiredDescription

product_idstringrequiredThe ID of the product to update.

activebooleanoptionalWhether the product is currently available for purchase.

descriptionstringoptionalThe product's description.

imagesarrayoptionalA list of up to 8 URLs of images for this product.

metadataobjectoptionalSet of key-value pairs to attach to the product.

namestringoptionalThe product's name.

unit_labelstringoptionalA label that represents units of this product.

urlstringoptionalA URL of a publicly-accessible webpage for this product.

stripe_update_promotion_code_dahlia#Update a promotion code's active status or metadata.3 params

Update a promotion code's active status or metadata.

NameTypeRequiredDescription

promotion_codestringrequiredThe ID of the promotion code to update.

activebooleanoptionalSet to false to deactivate the promotion code so it can no longer be redeemed.

metadataobjectoptionalSet of key-value pairs for storing additional information. Replaces existing metadata.

stripe_update_quote_dahlia#Update a draft Quote.7 params

Update a draft Quote.

NameTypeRequiredDescription

quotestringrequiredThe ID of the quote to update.

customerstringoptionalThe ID of the customer to associate with the quote.

descriptionstringoptionalA description visible to customers on the quote.

expires_atintegeroptionalUnix timestamp at which the quote will expire.

footerstringoptionalFooter text shown at the bottom of the quote document.

headerstringoptionalHeader text shown at the top of the quote document.

metadataobjectoptionalSet of key-value pairs to attach to the quote.

stripe_update_refund_dahlia#Update the metadata on a refund.2 params

Update the metadata on a refund.

NameTypeRequiredDescription

idstringrequiredThe ID of the refund to update.

metadataobjectoptionalSet of key-value pairs to attach to the refund as metadata.

stripe_update_setup_intent_dahlia#Updates a SetupIntent object prior to confirmation, such as changing the associated customer, payment method types, or description.6 params

Updates a SetupIntent object prior to confirmation, such as changing the associated customer, payment method types, or description.

NameTypeRequiredDescription

setup_intent_idstringrequiredThe ID of the SetupIntent to update.

customerstringoptionalThe ID of the Customer this SetupIntent belongs to.

descriptionstringoptionalAn arbitrary string attached to the object, useful for displaying to users.

expandarrayoptionalList of fields to expand in the response.

metadataobjectoptionalSet of key-value pairs to attach to the SetupIntent.

payment_methodstringoptionalID of the payment method to attach to this SetupIntent.

stripe_update_subscription_dahlia#Updates an existing subscription to match the specified parameters. When updating a subscription, any parameters not provided will be left unchanged.8 params

Updates an existing subscription to match the specified parameters. When updating a subscription, any parameters not provided will be left unchanged.

NameTypeRequiredDescription

subscription_idstringrequiredThe ID of the subscription to update.

cancel_at_period_endbooleanoptionalBoolean indicating whether this subscription should cancel at the end of the current period.

collection_methodstringoptionalEither charge_automatically or send_invoice.

days_until_dueintegeroptionalNumber of days a customer has to pay invoices (send_invoice collection method only).

default_payment_methodstringoptionalID of the default payment method for this subscription.

itemsarrayoptionalList of subscription items to update. Each item includes id, price, and/or quantity.

metadataobjectoptionalSet of key-value pairs to attach to the subscription.

proration_behaviorstringoptionalDetermines how to handle prorations when the billing cycle changes.

stripe_update_subscription_item_dahlia#Update a subscription item, for example to change the price or quantity.4 params

Update a subscription item, for example to change the price or quantity.

NameTypeRequiredDescription

itemstringrequiredThe ID of the subscription item to update.

pricestringoptionalThe ID of the new price to switch this subscription item to.

proration_behaviorstringoptionalDetermines how to handle prorations when modifying this item.

quantityintegeroptionalThe updated quantity of the subscription item.

stripe_update_subscription_schedule#Updates an existing subscription schedule, e.g. to change its phases, end behavior, or default settings. Past phases can be omitted when specifying phases.6 params

Updates an existing subscription schedule, e.g. to change its phases, end behavior, or default settings. Past phases can be omitted when specifying phases.

NameTypeRequiredDescription

subscription_schedule_idstringrequiredThe ID of the subscription schedule to update.

default_settingsobjectoptionalDefault settings for the subscription schedule, applied to phases that don't override them.

end_behaviorstringoptionalBehavior when the schedule ends: 'release' (default, keeps the underlying subscription running as-is) or 'cancel' (cancels the underlying subscription).

metadataobjectoptionalSet of key-value pairs to attach to the subscription schedule. Individual keys can be unset by posting an empty value.

phasesarrayoptionalList of phases for the subscription schedule. Note that past phases can be omitted; the end_date of one phase equals the start_date of the next.

proration_behaviorstringoptionalIf the update changes the billing configuration of the current phase, indicates how prorations should be handled. Defaults to 'create_prorations'.

stripe_update_tax_rate_dahlia#Update a tax rate's display name, description, or active status.5 params

Update a tax rate's display name, description, or active status.

NameTypeRequiredDescription

tax_ratestringrequiredThe ID of the tax rate to update.

activebooleanoptionalSet to false to deactivate the tax rate.

descriptionstringoptionalAn arbitrary string attached to the tax rate for your internal use.

display_namestringoptionalThe display name of the tax rate, shown to customers on invoices.

jurisdictionstringoptionalThe jurisdiction for the tax rate.

stripe_update_transfer_dahlia#Update a transfer's metadata.2 params

Update a transfer's metadata.

NameTypeRequiredDescription

transferstringrequiredThe ID of the transfer to update.

metadataobjectoptionalSet of key-value pairs to attach to the transfer. Stripe's update endpoint only accepts metadata — description cannot be changed after creation.

stripe_update_webhook_endpoint_dahlia#Update a webhook endpoint's URL, enabled events, or disabled status.5 params

Update a webhook endpoint's URL, enabled events, or disabled status.

NameTypeRequiredDescription

webhook_endpointstringrequiredThe ID of the webhook endpoint to update.

descriptionstringoptionalAn updated description for the webhook endpoint.

disabledbooleanoptionalWhether the webhook endpoint is disabled.

enabled_eventsarrayoptionalUpdated list of event types this endpoint should receive.

urlstringoptionalThe new HTTPS URL for the webhook endpoint.

stripe_void_credit_note#Marks a previously issued credit note as void. This cannot be undone.1 param

Marks a previously issued credit note as void. This cannot be undone.

NameTypeRequiredDescription

credit_note_idstringrequiredThe ID of the credit note to void.

stripe_void_invoice_dahlia#Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.1 param

Mark a finalized invoice as void. This cannot be undone. Voiding an invoice is similar to deletion, however it only applies to finalized invoices and maintains a papertrail where the invoice can still be found.

NameTypeRequiredDescription

invoice_idstringrequiredThe ID of the invoice to void.

stripe_zz_test_echo_probe_dahlia#Temporary throwaway tool for verifying raw wire bytes against an echo service. Not for real use — delete after testing.3 params

Temporary throwaway tool for verifying raw wire bytes against an echo service. Not for real use — delete after testing.

NameTypeRequiredDescription

big_idstringoptionalBody-spread large ID field, typed as string to avoid protobuf Struct's double-precision ceiling on NumberValue.

customerstringoptionalBody-spread field.

expandstringoptionalQuery-mapped field.

Stripe connector

Stripe connector

Install the SDK

Set your credentials

Set up the connector

Choose a sandbox or your live account

Get your Secret Key

Add a connected account in Scalekit

Make your first call

What you can do

Tool list