Plugin Data/Action Calls (API Calls only)
Plugin Data/Action calls are part of the plugin section designed only for API calls. The Data/Action calls will be described in detail in order to provide concise information about them.
Create a file
Uploads a file to Stripe (e.g., a document image for identity verification purposes).
Fields:
Name | Description | Type |
file | Upload an image file of your document ID. Make sure your file isn’t too large. | File |
purpose | The purpose of the file. Accepted values: identity_document, account_requirement, additional_verification | Text |
Return values:
Name | Description | Type |
id | Unique identifier of the file | Text |
object | Object type | Text |
created | Timestamp of file creation | Number |
filename | Name of the uploaded file | Text |
links object | Type of the links object | Text |
links has_more | Whether there are more links | Boolean |
links url | URL to the file links | Text |
purpose | Purpose of the file | Text |
size | Size of the file in bytes | Number |
title | Title of the file | Text |
type | Type of the file | Text |
url | URL to access the file | Text |
Retrieve a seller
Retrieves an existing connected account (seller) by its Account ID.
Fields:
Name | Description | Type |
Account ID | ID of the account you want to retrieve | Text |
Return values:
Name | Description | Type |
id | Unique identifier of the account | Text |
object | Object type | Text |
business_profile name | Business display name | Text |
business_profile url | Business URL | Text |
business_type | Type of business entity | Text |
charges_enabled | Whether charges are enabled on the account | Boolean |
country | Country of the account | Text |
created | Timestamp of account creation | Number |
default_currency | Default currency for the account | Text |
details_submitted | Whether account details have been submitted | Boolean |
email | Email address of the account | Text |
payouts_enabled | Whether payouts are enabled | Boolean |
type | Account type | Text |
Retrieve a customer
Retrieves the details of an existing customer by their Customer ID.
Fields:
Name | Description | Type |
Customer ID | ID of the customer you want to retrieve | Text |
Return values:
Name | Description | Type |
id | Unique identifier of the customer | Text |
object | Object type | Text |
balance | Current balance of the customer | Number |
created | Timestamp of creation | Number |
currency | Default currency of the customer | Text |
default_source | ID of the default payment source | Text |
delinquent | Whether the customer has overdue invoices | Boolean |
description | Arbitrary description | Text |
email | Email address of the customer | Text |
name | Customer’s full name | Text |
phone | Customer’s phone number | Text |
Seller charge a customer
Creates a charge to bill a customer on behalf of a connected seller account.
Fields:
Name | Description | Type |
(configured via request body) | Amount, currency, source, and destination are passed in the charge request | — |
Return values:
Name | Description | Type |
id | Charge ID | Text |
object | Object type | Text |
amount | Amount charged in smallest currency unit | Number |
amount_refunded | Amount refunded | Number |
captured | Whether the charge was captured | Boolean |
currency | Currency of the charge | Text |
customer | Customer ID | Text |
description | Description of the charge | Text |
paid | Whether the charge was paid | Boolean |
receipt_url | URL for the charge receipt | Text |
status | Status of the charge | Text |
Link a customer to a seller
Creates a token to share a customer’s payment method with a connected seller account.
Fields:
Name | Description | Type |
Card ID | The ID of the customer’s card | Text |
Customer ID | The ID of the customer | Text |
Return values:
Name | Description | Type |
id | Token ID | Text |
object | Object type | Text |
card brand | Card brand (e.g., Visa, Mastercard) | Text |
card last4 | Last 4 digits of the card | Text |
card exp_month | Card expiry month | Number |
card exp_year | Card expiry year | Number |
client_ip | IP address of the client | Text |
created | Timestamp of creation | Number |
livemode | Whether in live mode | Boolean |
type | Token type | Text |
used | Whether the token has been used | Boolean |
Retrieve all charges
Returns a list of charges, with optional pagination filters.
Fields:
Name | Description | Type |
limit | Number of objects to return (1–100) | Number |
starting_after | ID of a charge to use as cursor (next page) | Text |
ending_before | ID of a charge to use as cursor (previous page) | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of charge objects | List of Charges |
has_more | Whether more results exist | Boolean |
url | API URL for this resource | Text |
Retrieve all payouts
Returns a list of payouts made to a connected account, with optional pagination.
Fields:
Name | Description | Type |
limit | Number of objects to return (1–100) | Number |
starting_after | ID of a payout to use as cursor (next page) | Text |
ending_before | ID of a payout to use as cursor (previous page) | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of payout objects | List of Payouts |
has_more | Whether more results exist | Boolean |
url | API URL for this resource | Text |
Create a card
Creates a new card source for an existing customer.
Fields:
Name | Description | Type |
Customer ID | ID of the customer to create a card for | Text |
Return values:
Name | Description | Type |
id | Card ID | Text |
object | Object type | Text |
brand | Card brand | Text |
last4 | Last 4 digits of the card | Text |
exp_month | Expiry month | Number |
exp_year | Expiry year | Number |
customer | Customer ID the card belongs to | Text |
funding | Funding type (credit, debit, etc.) | Text |
returned_an_error | Whether the request returned an error | Boolean |
Delete a card
Deletes a card source from a customer.
Fields:
Name | Description | Type |
Customer ID | The ID of the customer that owns the card | Text |
Card ID | The ID of the card to delete | Text |
Return values:
Name | Description | Type |
id | ID of the deleted card | Text |
object | Object type | Text |
deleted | Whether the deletion was successful | Boolean |
Create a transfer
Sends funds from your Stripe balance to a connected seller account.
Fields:
Name | Description | Type |
amount | Amount in cents to transfer | Number |
currency | 3-letter ISO currency code (e.g., USD) | Text |
destination | ID of the connected Stripe account to receive funds | Text |
source_transaction | ID of a charge to transfer funds from before they clear | Text |
description | Description of the transfer | Text |
transfer_group | A string identifying this transaction as part of a group | Text |
Return values:
Name | Description | Type |
id | Transfer ID | Text |
amount | Amount transferred in cents | Number |
currency | Currency of the transfer | Text |
destination | Destination account ID | Text |
reversed | Whether the transfer has been reversed | Boolean |
transfer_group | Group identifier | Text |
created | Timestamp of creation | Number |
Complete express/standard account connection
Exchanges an OAuth authorization code for an access token to complete a Stripe Connect flow.
Fields:
Name | Description | Type |
grant_type | OAuth grant type | Text |
code | Authorization code from page URL parameter code | Text |
Return values:
Name | Description | Type |
access_token | Access token for the connected account | Text |
livemode | Whether in live mode | Boolean |
refresh_token | Refresh token | Text |
token_type | Token type | Text |
stripe_publishable_key | Publishable key for the connected account | Text |
stripe_user_id | Connected account’s Stripe user ID | Text |
scope | OAuth scope | Text |
Create a refund
Refunds a previously created charge or payment intent, in full or partially.
Fields:
Name | Description | Type |
amount | Amount to refund in cents | Number |
charge | ID of the charge to refund (leave empty if using payment_intent) | Text |
refund_application_fee | Whether to refund the application fee | Boolean |
reason | Reason for the refund: duplicate, fraudulent, or requested_by_customer | Text |
payment_intent | ID of the payment intent to refund (leave empty if using charge) | Text |
Return values:
Name | Description | Type |
id | Refund ID | Text |
amount | Refunded amount in cents | Number |
charge | ID of the refunded charge | Text |
currency | Currency of the refund | Text |
payment_intent | Payment intent ID | Text |
reason | Reason for the refund | Text |
status | Refund status | Text |
created | Timestamp of creation | Number |
Attach a payment method to customer
Attaches an existing payment method to a customer for future use.
Fields:
Name | Description | Type |
Payment method ID | ID of the payment method to attach | Text |
customer | ID of the customer to attach the payment method to | Text |
Return values:
Name | Description | Type |
id | Payment method ID | Text |
object | Object type | Text |
card brand | Card brand | Text |
card last4 | Last 4 digits | Text |
card exp_month | Expiry month | Number |
card exp_year | Expiry year | Number |
customer | Attached customer ID | Text |
created | Timestamp of creation | Number |
type | Payment method type | Text |
Detach a payment method from a customer
Removes a payment method from a customer.
Fields:
Name | Description | Type |
Payment method ID | ID of the payment method to detach | Text |
Return values:
Name | Description | Type |
id | Payment method ID | Text |
object | Object type | Text |
card brand | Card brand | Text |
card last4 | Last 4 digits | Text |
customer | Customer the method was detached from | Text |
type | Payment method type | Text |
Retrieve a setup intent
Retrieves a SetupIntent by its ID to access saved payment method details.
Fields:
Name | Description | Type |
SetupIntent ID | ID of the setup intent to retrieve | Text |
Return values:
Name | Description | Type |
id | SetupIntent ID | Text |
client_secret | Client secret for client-side confirmation | Text |
customer | Customer ID | Text |
payment_method | Attached payment method ID | Text |
status | Current status of the SetupIntent | Text |
usage | Intended usage: on_session or off_session | Text |
created | Timestamp of creation | Number |
Retrieve all payment intents
Returns a paginated list of payment intents.
Fields:
Name | Description | Type |
limit | Number of objects to return (1–100) | Number |
starting_after | ID of a payment intent for next-page pagination | Text |
ending_before | ID of a payment intent for previous-page pagination | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of payment intent objects | List of Payment Intents |
has_more | Whether more results exist | Boolean |
url | API URL | Text |
Create a payment intent
Creates a new PaymentIntent to initiate a payment flow.
Fields:
Name | Description | Type |
amount | Amount in smallest currency unit (e.g., 100 = $1.00) | Number |
currency | Three-letter ISO currency code in lowercase | Text |
payment_method | ID of the payment method to use | Text |
customer | ID of the customer the payment belongs to | Text |
application_fee_amount | Platform application fee amount | Number |
confirm | Set to true to attempt immediate confirmation | Boolean |
off_session | Set to true if customer is not present during payment | Boolean |
receipt_email | Email to send the receipt to | Text |
capture_method | automatic for instant capture, manual for later capture | Text |
description | Description of the payment | Text |
return_url | Redirect URL after authentication (required when confirm=true) | Text |
automatic_payment_methods[enabled] | Enable automatic payment method selection | Boolean |
automatic_payment_methods[allow_redirects] | always or never — controls redirect-based methods | Text |
transfer_group | Group identifier to link related payments and transfers | Text |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
object | Object type | Text |
amount | Payment amount in cents | Number |
client_secret | Client secret for client-side confirmation | Text |
currency | Currency code | Text |
customer | Customer ID | Text |
status | Payment intent status | Text |
capture_method | Capture method | Text |
transfer_group | Transfer group identifier | Text |
created | Timestamp of creation | Number |
Confirm a payment intent
Confirms a PaymentIntent to attempt to collect payment.
Fields:
Name | Description | Type |
Payment intent ID | ID of the payment intent to confirm | Text |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
amount | Amount in cents | Number |
status | Updated status of the payment intent | Text |
client_secret | Client secret | Text |
next_action type | Type of next required action | Text |
next_action redirect_to_url url | Redirect URL if 3DS required | Text |
currency | Currency code | Text |
customer | Customer ID | Text |
Capture a payment intent
Captures the funds of an existing uncaptured PaymentIntent.
Fields:
Name | Description | Type |
Payment intent ID | ID of the payment intent to capture | Text |
amount_to_capture | Amount to capture (must be ≤ original amount) | Number |
application_fee_amount | Application fee to collect during capture | Number |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
amount | Original payment amount | Number |
amount_received | Amount successfully received | Number |
status | Updated status | Text |
currency | Currency code | Text |
customer | Customer ID | Text |
Cancel a Payment Intent
Cancels an existing PaymentIntent that has not yet been captured.
Fields:
Name | Description | Type |
Payment ID | ID of the payment intent to cancel | Text |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
status | Status after cancellation | Text |
canceled_at | Timestamp of cancellation | Number |
cancellation_reason | Reason for cancellation | Text |
currency | Currency code | Text |
amount | Original amount | Number |
Retrieve a payment intent (Data)
Retrieves a PaymentIntent by its ID. Published as a data call.
Fields:
Name | Description | Type |
Paymentintent ID | ID of the payment intent to retrieve | Text |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
amount | Amount in cents | Number |
client_secret | Client secret | Text |
status | Current status | Text |
currency | Currency code | Text |
customer | Customer ID | Text |
payment_method | Payment method ID | Text |
last_payment_error message | Error message from last failed attempt | Text |
livemode | Whether in live mode | Boolean |
Retrieve a payment intent (action)
Same as above but published as an action call, allowing it to be used in Bubble workflows.
Fields:
Name | Description | Type |
Paymentintent ID | ID of the payment intent to retrieve | Text |
Return values:
Name | Description | Type |
id | Payment intent ID | Text |
amount | Amount in cents | Number |
client_secret | Client secret | Text |
status | Current status | Text |
currency | Currency code | Text |
customer | Customer ID | Text |
latest_charge | ID of the latest associated charge | Text |
livemode | Whether in live mode | Boolean |
Clone a customer’s payment method
Creates a clone of a customer’s payment method for use on a connected account.
Fields:
Name | Description | Type |
customer | ID of the customer to clone the payment method from | Text |
payment_method | ID of the payment method to clone | Text |
Return values:
Name | Description | Type |
id | Cloned payment method ID | Text |
object | Object type | Text |
card brand | Card brand | Text |
card last4 | Last 4 digits | Text |
card exp_month | Expiry month | Number |
card exp_year | Expiry year | Number |
customer | Associated customer ID | Text |
type | Payment method type | Text |
created | Timestamp of creation | Number |
Retrieve a session
Retrieves a Checkout Session by its ID to access payment and customer data after checkout completion.
Fields:
Name | Description | Type |
Session ID | ID of the checkout session to retrieve | Text |
Return values:
Name | Description | Type |
id | Session ID | Text |
amount_total | Total amount in smallest currency unit | Number |
currency | Currency code | Text |
customer | Customer ID | Text |
customer_details email | Customer’s email address | Text |
payment_intent | ID of the created payment intent | Text |
payment_status | Status of the payment | Text |
mode | Session mode ( payment, setup, subscription) | Text |
url | URL of the Checkout session | Text |
success_url | URL redirected to on success | Text |
cancel_url | URL redirected to on cancel | Text |
Create dashboard link (Express only)
Creates a login link for an Express connected account to access their Stripe dashboard.
Fields:
Name | Description | Type |
Seller ID | ID of the Express account to create a dashboard link for | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
created | Timestamp of creation | Number |
url | Dashboard login link URL | Text |
Capture a charge
Captures a previously uncaptured charge.
Fields:
Name | Description | Type |
Charge ID | ID of the charge to capture | Text |
amount | Amount to capture (must be ≤ original amount) | Number |
receipt_email | Email to send the receipt to | Text |
Return values:
Name | Description | Type |
id | Charge ID | Text |
amount | Charge amount | Number |
captured | Whether the charge was captured | Boolean |
currency | Currency code | Text |
status | Charge status | Text |
receipt_url | URL of the receipt | Text |
Create a billing portal session
Creates a Stripe Customer Portal session so a customer can manage their subscriptions and billing.
Fields:
Name | Description | Type |
customer | ID of the existing customer | Text |
return_url | URL to redirect the customer back to your site | Text |
Return values:
Name | Description | Type |
id | Portal session ID | Text |
object | Object type | Text |
created | Timestamp of creation | Number |
customer | Customer ID | Text |
livemode | Whether in live mode | Boolean |
return_url | Return URL | Text |
url | Billing portal URL for the customer | Text |
Retrieve a seller’s balance
Retrieves the current balance of the authenticated Stripe account.
Fields:
(No input parameters required)
Return values:
Name | Description | Type |
object | Object type | Text |
available | List of available balance amounts by currency | List |
available amount | Available amount in smallest currency unit | Number |
available currency | Currency code | Text |
pending | List of pending balance amounts | List |
pending amount | Pending amount | Number |
livemode | Whether in live mode | Boolean |
Retrieve all invoices
Returns a list of invoices, with optional filtering by customer, subscription, and status.
Fields:
Name | Description | Type |
customer | Only return invoices for this customer ID | Text |
subscription | Only return invoices for this subscription ID | Text |
status | Filter by status: draft, open, paid, uncollectible, or void | Text |
ending_before | Cursor for previous-page pagination | Text |
starting_after | Cursor for next-page pagination | Text |
limit | Number of objects to return (1–100, default 10) | Number |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of invoice objects | List of Invoices |
has_more | Whether more results exist | Boolean |
url | API URL for this resource | Text |
Retrieve a customer’s sources
Returns a list of payment sources (cards, bank accounts) associated with a customer.
Fields:
Name | Description | Type |
CustomerID | ID of the customer to retrieve sources for | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of source objects (cards, etc.) | List |
has_more | Whether more results exist | Boolean |
url | API URL for this resource | Text |
Retrieve a customer’s payment methods
Returns a list of payment methods associated with a customer.
Fields:
Name | Description | Type |
customer | ID of the customer to retrieve payment methods for | Text |
type | Required filter by object type (e.g., card) | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of payment method objects | List of Payment Methods |
has_more | Whether more results exist | Boolean |
url | API URL for this resource | Text |
Create an invoice item
Creates an invoice item to be added to a customer’s upcoming invoice.
Fields:
Name | Description | Type |
customer | ID of the customer to bill | Text |
invoice | ID of an existing draft invoice to add this item to | Text |
amount | Amount in smallest currency unit | Number |
currency | Three-letter ISO currency code | Text |
description | Description of the invoice item | Text |
price | ID of the price object | Text |
quantity | Quantity of units | Number |
subscription | ID of the subscription to associate this item with | Text |
unit_amount | Unit price in smallest currency unit | Number |
period.start | Start of the period | Number |
period.end | End of the period | Number |
Return values:
Name | Description | Type |
id | Invoice item ID | Text |
amount | Total amount of the item | Number |
currency | Currency code | Text |
customer | Customer ID | Text |
description | Item description | Text |
invoice | Associated invoice ID | Text |
quantity | Item quantity | Number |
unit_amount | Unit price | Number |
Create an invoice
Creates a new invoice for a customer.
Fields:
Name | Description | Type |
customer | ID of the customer to bill | Text |
collection_method | charge_automatically or send_invoice | Text |
description | Description of the invoice | Text |
subscription | Subscription ID to invoice | Text |
application_fee_amount | Fee to collect for the platform | Number |
days_until_due | Days until the invoice is due (for send_invoice only) | Number |
footer | Footer text displayed on the invoice | Text |
currency | Currency for this invoice | Text |
statement_descriptor | Custom descriptor on the credit card statement | Text |
transfer_data[destination] | Account to transfer invoice funds to | Text |
transfer_data[amount] | Amount to transfer automatically | Number |
Return values:
Name | Description | Type |
id | Invoice ID | Text |
amount_due | Total amount due | Number |
amount_paid | Amount already paid | Number |
amount_remaining | Amount still outstanding | Number |
currency | Currency code | Text |
customer | Customer ID | Text |
status | Invoice status | Text |
hosted_invoice_url | URL to the hosted invoice | Text |
invoice_pdf | URL to the invoice PDF | Text |
payment_intent | Associated payment intent ID | Text |
Verify a bank account
Verifies a customer’s bank account using two microdeposit amounts.
Fields:
Name | Description | Type |
Bank account ID | ID of the bank account to verify | Text |
Customer ID | ID of the customer whose bank account to verify | Text |
amounts[0] | First microdeposit amount in cents | Number |
amounts[1] | Second microdeposit amount in cents | Number |
Return values:
Name | Description | Type |
id | Bank account ID | Text |
bank_name | Name of the bank | Text |
last4 | Last 4 digits of the account | Text |
routing_number | Routing number | Text |
status | Verification status | Text |
currency | Currency | Text |
country | Country code | Text |
Pay an invoice
Triggers immediate payment of a draft or open invoice.
Fields:
Name | Description | Type |
Invoice ID | ID of the invoice to pay | Text |
payment_method | ID of the payment method to charge | Text |
source | ID of a payment source to use | Text |
Return values:
Name | Description | Type |
id | Invoice ID | Text |
amount_paid | Amount paid | Number |
status | Updated invoice status | Text |
paid | Whether the invoice is now paid | Boolean |
hosted_invoice_url | URL to the hosted invoice | Text |
payment_intent | Associated payment intent ID | Text |
Send an invoice
Sends a finalized invoice to the customer via email.
Fields:
Name | Description | Type |
InvoiceID | ID of the invoice to send | Text |
Return values:
Name | Description | Type |
id | Invoice ID | Text |
status | Invoice status | Text |
hosted_invoice_url | URL to the hosted invoice | Text |
customer_email | Email the invoice was sent to | Text |
amount_due | Total amount due | Number |
Create a coupon
Creates a discount coupon that can be applied to customers or subscriptions.
Fields:
Name | Description | Type |
amount_off | Amount to subtract from invoice total (in cents) | Number |
currency | ISO currency code (required if amount_off is set) | Text |
duration | How long the discount applies: forever, once, or repeating | Text |
duration_in_months | Number of months when duration=repeating | Number |
name | Display name of the coupon | Text |
percent_off | Percentage discount (0–100) | Number |
id | Custom coupon code; leave blank to auto-generate | Text |
max_redemptions | Maximum number of times the coupon can be redeemed | Number |
redeem_by | Unix timestamp after which the coupon is no longer valid | Number |
Return values:
Name | Description | Type |
id | Coupon ID / code | Text |
amount_off | Discount amount in cents | Number |
percent_off | Discount percentage | Text |
duration | Duration type | Text |
name | Coupon display name | Text |
valid | Whether the coupon is currently valid | Boolean |
times_redeemed | Number of times used | Number |
Retrieve all coupons
Returns a paginated list of all coupons.
Fields:
Name | Description | Type |
ending_before | Cursor for previous-page pagination | Text |
starting_after | Cursor for next-page pagination | Text |
limit | Number of objects to return (1–100, default 10) | Number |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of coupon objects | List of Coupons |
has_more | Whether more results exist | Boolean |
url | API URL | Text |
Delete a coupon
Permanently deletes a coupon.
Fields:
Name | Description | Type |
Coupon ID | ID of the coupon to delete | Text |
Return values:
Name | Description | Type |
id | Deleted coupon ID | Text |
object | Object type | Text |
deleted | Whether the deletion was successful | Boolean |
Create a plan
Creates a new recurring price (plan) for a product.
Fields:
Name | Description | Type |
unit_amount | Price in cents per billing interval | Number |
currency | Three-letter ISO currency code | Text |
recurring[interval] | Billing interval: day, week, month, or year | Text |
recurring[interval_count] | Number of intervals between billings (e.g., 3 for every 3 months) | Number |
product_data[name] | Product name (required unless product is provided) | Text |
product | ID of an existing product (required unless product_data is provided) | Text |
Return values:
Name | Description | Type |
id | Price/plan ID | Text |
active | Whether the price is active | Boolean |
currency | Currency code | Text |
product | Associated product ID | Text |
recurring interval | Billing interval | Text |
recurring interval_count | Interval count | Number |
unit_amount | Price in cents | Number |
type | Price type | Text |
Retrieve a price/plan
Retrieves a specific price object by ID.
Fields:
Name | Description | Type |
Price ID | ID of the price/plan to retrieve | Text |
Return values:
Name | Description | Type |
id | Price ID | Text |
active | Whether the price is active | Boolean |
currency | Currency code | Text |
product | Product ID | Text |
unit_amount | Price in cents | Number |
recurring interval | Billing interval | Text |
type | Price type | Text |
Retrieve all prices
Returns a list of prices with optional filters.
Fields:
Name | Description | Type |
active | Filter by active ( true) or inactive (false) prices | Boolean |
currency | Filter by currency code | Text |
product | Filter by product ID | Text |
type | Filter by type: recurring or one_time | Text |
ending_before | Cursor for previous-page pagination | Text |
starting_after | Cursor for next-page pagination | Text |
limit | Number of objects to return (1–100, default 10) | Number |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of price objects | List of Prices |
has_more | Whether more results exist | Boolean |
url | API URL | Text |
Create a tax rate
Creates a new tax rate that can be applied to invoices and subscriptions.
Fields:
Name | Description | Type |
display_name | Display name for the tax rate | Text |
description | Description of the tax rate | Text |
jurisdiction | Jurisdiction for the tax rate (e.g., country or state name) | Text |
percentage | Tax percentage | Number |
inclusive | Whether the tax is included in the price | Boolean |
Return values:
Name | Description | Type |
id | Tax rate ID | Text |
active | Whether the tax rate is active | Boolean |
display_name | Tax rate display name | Text |
percentage | Tax percentage | Number |
inclusive | Whether tax is inclusive | Boolean |
jurisdiction | Jurisdiction | Text |
country | Country code | Text |
Create SetupIntent (deprecated)
Creates a SetupIntent to save a payment method for future off-session use.
Fields:
Name | Description | Type |
confirm | Set to true to attempt immediate confirmation | Boolean |
customer | ID of the customer this SetupIntent belongs to | Text |
description | Description of the SetupIntent | Text |
payment_method | ID of the payment method to attach | Text |
payment_method_types[] | Allowed payment method types (e.g., card) | Text |
usage | on_session or off_session | Text |
on_behalf_of | Stripe account ID for which the SetupIntent is created | Text |
return_url | Redirect URL after authentication | Text |
Return values:
Name | Description | Type |
id | SetupIntent ID | Text |
client_secret | Client secret for client-side confirmation | Text |
customer | Customer ID | Text |
payment_method | Payment method ID | Text |
status | Current status | Text |
usage | Intended usage | Text |
Cancel a SetupIntent
Cancels an existing SetupIntent.
Fields:
Name | Description | Type |
id | ID of the SetupIntent to cancel | Text |
Return values:
Name | Description | Type |
id | SetupIntent ID | Text |
cancellation_reason | Reason for cancellation | Text |
status | Updated status | Text |
customer | Customer ID | Text |
List all SetupIntents
Returns a list of SetupIntents filtered by customer or payment method.
Fields:
Name | Description | Type |
customer | Only return SetupIntents for this customer ID | Text |
payment_method | Only return SetupIntents associated with this payment method | Text |
Return values:
Name | Description | Type |
id | SetupIntent ID | Text |
client_secret | Client secret | Text |
customer | Customer ID | Text |
payment_method | Payment method ID | Text |
status | Current status | Text |
Confirm a SetupIntent
Confirms a SetupIntent to attempt to set up the payment method.
Fields:
Name | Description | Type |
id | ID of the payment method or SetupIntent to confirm | Text |
return_url | Redirect URL after authentication | Text |
Return values:
Name | Description | Type |
id | SetupIntent ID | Text |
status | Updated status | Text |
next_action type | Type of required next action | Text |
next_action redirect_to_url url | Redirect URL for authentication | Text |
payment_method | Payment method ID | Text |
Calculate tax
Calculates tax for a given transaction before creating a payment.
Fields:
Name | Description | Type |
currency | Three-letter ISO currency code (e.g., usd) | Text |
customer_details[address][line1] | Customer street address line 1 | Text |
customer_details[address][line2] | Customer street address line 2 | Text |
customer_details[address][postal_code] | ZIP or postal code | Text |
customer_details[address][state] | State/province as ISO 3166-2 subdivision code | Text |
customer_details[address][country] | Two-letter country code | Text |
customer_details[address_source] | Address type: billing or shipping | Text |
line_items[0][amount] | Total line item price in cents | Number |
line_items[0][tax_code] | Tax code ID for this line item | Text |
line_items[0][reference] | Unique reference for this line item | Text |
shipping_cost[amount] | Shipping charge in cents | Number |
Return values:
Name | Description | Type |
id | Tax calculation ID | Text |
amount_total | Total amount including tax | Number |
currency | Currency code | Text |
tax_amount_exclusive | Exclusive tax amount | Number |
tax_amount_inclusive | Inclusive tax amount | Number |
expires_at | Expiry timestamp of the calculation | Number |
Create a tax transaction from a calculation
Creates a tax transaction record from a completed tax calculation.
Fields:
Name | Description | Type |
calculation | Tax Calculation ID to use as input | Text |
reference | Unique order or sale identifier (e.g., myOrder_123) | Text |
Return values:
Name | Description | Type |
id | Tax transaction ID | Text |
currency | Currency code | Text |
reference | Order reference | Text |
type | Transaction type | Text |
created | Timestamp of creation | Number |
Retrieve a tax transaction
Retrieves a tax transaction by its ID.
Fields:
Name | Description | Type |
tax transaction id | ID of the tax transaction to retrieve | Text |
Return values:
Name | Description | Type |
id | Tax transaction ID | Text |
currency | Currency code | Text |
reference | Order reference | Text |
type | Transaction type | Text |
created | Timestamp of creation | Number |
Retrieve a refund
Retrieves a specific refund by its ID.
Fields:
Name | Description | Type |
id_refund | ID of the refund to retrieve | Text |
Return values:
Name | Description | Type |
id | Refund ID | Text |
amount | Refunded amount in cents | Number |
charge | Associated charge ID | Text |
currency | Currency code | Text |
payment_intent | Associated payment intent ID | Text |
reason | Reason for the refund | Text |
status | Refund status | Text |
created | Timestamp of creation | Number |
Cancel a refund
Cancels a pending refund.
Fields:
Name | Description | Type |
id_refund | ID of the refund to cancel | Text |
Return values:
Name | Description | Type |
id | Refund ID | Text |
amount | Refund amount | Number |
status | Updated refund status | Text |
charge | Associated charge ID | Text |
currency | Currency code | Text |
Update a bank account
Updates the details of an external bank account on a connected account.
Fields:
Name | Description | Type |
account_id | ID of the connected account | Text |
bank_account_id | ID of the bank account to update | Text |
account_holder_name | Name of the account holder | Text |
account_holder_type | individual or company | Text |
account_type | checking, savings, futsu, or toza | Text |
default_for_currency | Set as default external account for its currency | Boolean |
Return values:
Name | Description | Type |
id | Bank account ID | Text |
bank_name | Bank name | Text |
last4 | Last 4 digits of the account | Text |
routing_number | Routing number | Text |
status | Account status | Text |
default_for_currency | Whether set as default | Boolean |
currency | Currency code | Text |
Create an account link
Creates an account link for Stripe Connect onboarding or updating an Express or Standard account.
Fields:
Name | Description | Type |
account | ID of the connected account | Text |
refresh_url | URL to redirect to if the link expires or is invalid | Text |
return_url | URL to redirect to after completing the onboarding flow | Text |
type | Link type: account_onboarding or account_update | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
created | Timestamp of creation | Number |
expires_at | Expiry timestamp of the link | Number |
url | Onboarding link URL to redirect the seller to | Text |
Retrieve a subscription
Retrieves the details of a customer’s subscription by its ID.
Fields:
Name | Description | Type |
Subscription ID | ID of the subscription to retrieve | Text |
Return values:
Name | Description | Type |
id | Subscription ID | Text |
status | Subscription status | Text |
customer | Customer ID | Text |
current_period_start | Start of current billing period | Number |
current_period_end | End of current billing period | Number |
cancel_at_period_end | Whether subscription cancels at period end | Boolean |
plan amount | Plan price in cents | Number |
plan interval | Billing interval | Text |
quantity | Number of subscribed units | Number |
latest_invoice | ID of the latest invoice | Text |
Retrieve a promotion code
Retrieves a promotion code by its ID.
Fields:
Name | Description | Type |
promo_id | ID of the promotion code to retrieve | Text |
Return values:
Name | Description | Type |
id | Promotion code ID | Text |
code | The actual promo code string | Text |
active | Whether the code is active | Boolean |
coupon percent_off | Discount percentage from the linked coupon | Number |
coupon duration | Duration type | Text |
times_redeemed | Number of times the code has been redeemed | Number |
expires_at | Expiry timestamp | Text |
List promotion codes
Returns a list of promotion codes with optional filters.
Fields:
Name | Description | Type |
limit | Number of objects to return | Number |
code | Filter by the exact promotion code string | Text |
Return values:
Name | Description | Type |
object | Object type | Text |
data | List of promotion code objects | List |
has_more | Whether more results exist | Boolean |
url | API URL | Text |
Create Card Token
Creates a single-use token that represents a customer’s card details, for use in charge or customer creation.
Fields:
Name | Description | Type |
card[number] | Full card number | Text |
card[exp_month] | Card expiry month | Text |
card[exp_year] | Card expiry year | Text |
card[cvc] | Card CVC/CVV security code | Text |
card[name] | Cardholder name | Text |
Return values:
(No return values are exposed for this call)
cURL Call
A generic POST call to the Stripe tokens endpoint, used to tokenize card data for client-side payment flows.
Fields:
(No input parameters exposed — request body is configured at the API level)
Return values:
Name | Description | Type |
id | Token ID | Text |
object | Object type | Text |
card brand | Card brand | Text |
card last4 | Last 4 digits of the card | Text |
card exp_month | Expiry month | Number |
card exp_year | Expiry year | Number |
card funding | Funding type | Text |
client_ip | IP address of the client | Text |
created | Timestamp of token creation | Number |
livemode | Whether in live mode | Boolean |
type | Token type | Text |
used | Whether the token has been used | Boolean |