Stripe

Create payment intents, manage customers, invoices, and subscriptions with Stripe.

Finance and paymentsAPI key19 actionsAll integrations

On this page

Connect
Call it from a workflow
Actions (19)
create_customer
create_invoice
create_payment_intent
cancel_subscription
create_payment_link
create_price
create_product
create_refund
create_subscription
custom_api_call
deactivate_payment_link
find_invoice
retrieve_customer
retrieve_invoice
retrieve_payment_intent
retrieve_payout
search_customer
search_subscriptions
update_customer
Env keys
Details

Connect

Auth type: API key (secret_text). Paste the API key (or token) from the provider's settings into the connect dialog. It is encrypted at rest and only decrypted on the server when an action runs.

In the editor: Backend panel, Integrations tab, then Connect. This connects it for the project.
For every project in a workspace: Workspace settings, Integrations.
Owners and admins choose which integrations members may connect in the admin panel (Integrations tab), and can attach their own OAuth app there.

Call it from a workflow

Pass the action name and its input. The call resolves with { success, output, error? }; a missing connection resolves with success false and the reason. See ctx.integrations.invoke and ctx.integrations.call.

Native workflow

// .workflow.js (native ctx)
export async function run(ctx) {
  const res = await ctx.integrations.invoke("stripe", "create_customer", {
    "email": "<email>",
    "name": "<name>"
  });
  if (!res.success) throw new Error(res.error);
  ctx.log.info("Stripe answered", { output: res.output });
}

defineWorkflow module

// defineWorkflow module (@app/sdk ctx)
import { defineWorkflow } from "@app/sdk";

export default defineWorkflow({
  id: "stripe-create-customer",
  name: "Stripe: Create Customer",
  description: "Calls Stripe when a row is created.",
  trigger: { type: "entity_event", entity: "tickets", event: "created" },
  async run(ctx, event) {
    const res = await ctx.integrations.call("stripe", {
      "action": "create_customer",
      "email": "<email>",
      "name": "<name>"
    }) as { success: boolean; error?: string };
    if (!res.success) throw new Error(res.error);
  },
});

From an app (connector proxy)

curl -X POST "$APP_ORIGIN/__appbricx/connector-proxy/stripe/create_customer" \
  -H "Authorization: Bearer $APP_KEY" \
  -H "content-type: application/json" \
  -d '{"props":{"email":"<email>","name":"<name>"}}'

Actions

create_customerin catalog

Create Customer. Create a customer in stripe

Input	Type	Description
`email`required	text	Email
`name`required	text	Name
`description`optional	long text	Description
`phone`optional	text	Phone
`line1`optional	text	Address Line 1
`postal_code`optional	text	Postal Code
`city`optional	text	City
`state`optional	text	State
`country`optional	text	Country

create_invoicein catalog

Create Invoice. Create an Invoice in stripe

Input	Type	Description
`customer_id`required	text	Stripe Customer ID
`currency`required	text	Currency for the invoice (e.g., USD)
`description`optional	long text	Description for the invoice

create_payment_intentin catalog

Create Payment (Payment Intent). Creates a new payment intent to start a payment flow.

Input	Type	Description
`amount`required	number	The amount to charge, in a decimal format (e.g., 10.50 for $10.50).
`currency`required	one of "usd" \| "eur" \| "gbp" \| "aud" \| "cad" \| "chf" \| "cny" \| "jpy" \| "inr" \| "sgd"	The three-letter ISO code for the currency.
`customer`required	id (picked from your account)	Customer
`payment_method`optional	text	The ID of the Payment Method to attach (e.g., `pm_...`). Required if you want to confirm the payment immediately.
`confirm`optional	boolean	If true, Stripe will attempt to charge the provided payment method. A `Payment Method ID` is required.
`return_url`optional	text	The URL to redirect your customer back to after they authenticate their payment. Required when confirming the payment.
`description`optional	long text	Description
`receipt_email`optional	text	The email address to send a receipt to. This will override the customer's email address.

cancel_subscription

Cancel Subscription. Cancel an existing subscription, either immediately or at the end of the current billing period.

Input	Type	Description
`subscription`required	id (picked from your account)	Subscription
`cancel_at_period_end`optional	boolean	If true, the subscription remains active until the end of the current billing period. If false, it cancels immediately.

create_payment_link

Create Payment Link. Creates a shareable, Stripe-hosted payment link for one-time purchases or subscriptions.

Input	Type	Description
`line_items`required	array	The products and quantities to include in the payment link.
`after_completion_type`optional	one of "hosted_confirmation" \| "redirect"	Controls the behavior after the purchase is complete. Defaults to showing Stripe's hosted confirmation page.
`after_completion_redirect_url`optional	text	The URL to redirect the customer to after a successful purchase. Only used if the behavior is set to "Redirect to URL".
`allow_promotion_codes`optional	boolean	Enables the user to enter a promotion code on the Payment Link page.
`billing_address_collection`optional	one of "auto" \| "required"	Describes whether Checkout should collect the customer’s billing address.
`metadata`optional	JSON	Metadata

create_price

Create Price. Create a price (one-time or recurring), associated with a product.

Input	Type	Description
`product`required	id (picked from your account)	Product
`unit_amount`required	number	The price amount as a decimal, for example, 25.50 for $25.50.
`currency`required	one of "usd" \| "eur" \| "gbp" \| "inr" \| "aud" \| "cad" \| "chf" \| "cny" \| "jpy" \| "sgd"	The three-letter ISO code for the currency.
`recurring_interval`required	one of "one_time" \| "day" \| "week" \| "month" \| "year"	Specify the billing frequency. Select 'One-Time' for a single, non-recurring payment.
`recurring_interval_count`optional	number	The number of intervals between subscription billings (e.g., for billing every 3 months, set Interval to Monthly and Interval Count to 3). Only used for recurring prices.

create_product

Create Product. Create a new product object in Stripe.

Input	Type	Description
`name`required	text	The product’s name, meant to be displayable to the customer.
`description`optional	long text	The product’s description, meant to be displayable to the customer.
`active`optional	boolean	Whether the product is currently available for purchase. Defaults to true.
`images`optional	array	A list of up to 8 URLs of images for this product.
`url`optional	text	A publicly-accessible online page for this product.
`metadata`optional	JSON	A set of key-value pairs to store additional information about the product.

create_refund

Create a Refund. Create a full or partial refund for a payment.

Input	Type	Description
`payment_intent`required	id (picked from your account)	Payment Intent
`amount`optional	number	The amount to refund (e.g., 12.99). If left blank, a full refund will be issued.
`reason`optional	one of "duplicate" \| "fraudulent" \| "requested_by_customer"	An optional reason for the refund.
`metadata`optional	JSON	A set of key-value pairs to store additional information about the refund.

create_subscription

Create Subscription. Start a subscription for a customer with specified items/prices.

Input	Type	Description
`customer`required	id (picked from your account)	Customer
`items`required	array	A list of prices to subscribe the customer to.
`collection_method`optional	one of "charge_automatically" \| "send_invoice"	How to collect payment. 'charge_automatically' will try to bill the default payment method. 'send_invoice' will email an invoice.
`days_until_due`optional	number	Number of days before an invoice is due. Required if Collection Method is 'Send Invoice'.
`trial_period_days`optional	number	Integer representing the number of trial days the customer receives before the subscription bills for the first time.
`default_payment_method`optional	text	ID of the default payment method for the subscription (e.g., `pm_...`).
`metadata`optional	JSON	Metadata

custom_api_call

Custom API Call. Make a custom API call to a specific endpoint

Input	Type	Description
`url`required	object (depends on other props)	url
`method`required	one of "GET" \| "POST" \| "PATCH" \| "PUT" \| "DELETE" \| "HEAD"	Method
`headers`required	object	Authorization headers are injected automatically from your connection.
`queryParams`required	object	Query Parameters
`body_type`optional	one of "none" \| "json" \| "form_data" \| "raw"	Body Type
`body`optional	object (depends on other props)	Body
`response_is_binary`optional	boolean	Enable for files like PDFs, images, etc.
`failsafe`optional	boolean	No Error on Failure
`timeout`optional	number	Timeout (in seconds)
`followRedirects`optional	boolean	Follow redirects

deactivate_payment_link

Deactivate Payment Link. Disable or deactivate a Payment Link so it can no longer be used.

Input	Type	Description
`payment_link_id`required	id (picked from your account)	Payment Link

find_invoice

Find Invoice. Finds an invoice by its unique ID.

Input	Type	Description
`invoice_id`required	id (picked from your account)	Invoice

retrieve_customer

Retrieve Customer. Retrieve a customer in stripe by id

Input	Type	Description
`id`required	text	ID

retrieve_invoice

Retrieve an Invoice. Retrieves the details of an existing invoice by its ID.

Input	Type	Description
`invoice_id`required	id (picked from your account)	Invoice

retrieve_payment_intent

Find Payment (by Payment Intent ID). Retrieves the details of a payment by its unique Payment Intent ID.

Input	Type	Description
`payment_intent_id`required	id (picked from your account)	Payment Intent

retrieve_payout

Retrieve a Payout. Retrieves the details of an existing payout by its ID.

Input	Type	Description
`payout_id`required	id (picked from your account)	Payout

search_customer

Search Customer. Search for a customer in stripe by email

Input	Type	Description
`email`required	text	Email

search_subscriptions

Search Subscriptions. Search for subscriptions by price ID, status, customer ID and other filters, including customer details

Input	Type	Description
`price_ids`optional	long text	Comma-separated list of price IDs to filter by (e.g., price_1ABC123, price_2DEF456)
`status`optional	one of "" \| "active" \| "past_due" \| "unpaid" \| "canceled" \| "incomplete" \| "incomplete_expired" \| "trialing" \| "paused"	Filter by subscription status
`customer_id`optional	text	Filter by specific customer ID (optional)
`created_after`optional	date-time (ISO)	Filter subscriptions created after this date (YYYY-MM-DD format)
`created_before`optional	date-time (ISO)	Filter subscriptions created before this date (YYYY-MM-DD format)
`limit`optional	number	Maximum number of subscriptions to return (default: 100, set to 0 for all)
`fetch_all`optional	boolean	Fetch all matching subscriptions (ignores limit, may take longer for large datasets)
`include_customer_details`optional	boolean	Fetch detailed customer information for each subscription

update_customer

Update Customer. Modify an existing customer’s details.

Input	Type	Description
`customer`required	id (picked from your account)	Customer
`email`optional	text	Email
`name`optional	text	Name
`description`optional	long text	Description
`phone`optional	text	Phone
`line1`optional	text	Address Line 1
`postal_code`optional	text	Postal Code
`city`optional	text	City
`state`optional	text	State
`country`optional	text	Country

Env keys

When connected, these credential fields are exposed to the project's runtime as environment variables (Stripe payments and subscriptions.). Server keys never reach the browser.

Variable	Field	Where
`STRIPE_SECRET_KEY`	secretKey	server only
`VITE_STRIPE_PUBLISHABLE_KEY`	publishableKey	browser (VITE_)

Details

Id: stripe
Category: Finance and payments
Tags: payments, billing, subscriptions, invoicing
Package: @activepieces/piece-stripe@0.6.7
Tier: Built in