Actions reference

All Actions

This integration provides actions for managing Stripe resources from your WeWeb backend.

Action	Description
List Products	List products
Retrieve Product	Retrieve a product by ID
Create Product	Create a product
Update Product	Update a product
Delete Product	Delete a product
List Prices	List prices
Retrieve Price	Retrieve a price by ID
Create Price	Create a price
Update Price	Update a price
Deactivate Price	Deactivate a price
List Customers	List customers
Retrieve Customer	Retrieve a customer by ID
Create Customer	Create a customer
Update Customer	Update a customer
Delete Customer	Delete a customer
List Invoices	List invoices
Retrieve Invoice	Retrieve an invoice by ID
Create Invoice	Create an invoice
Update Invoice	Update an invoice
Delete Invoice	Delete a draft invoice
List Subscriptions	List subscriptions
Retrieve Subscription	Retrieve a subscription by ID
Create Subscription	Create a subscription
Update Subscription	Update a subscription
Cancel Subscription	Cancel a subscription
List Payment Intents	List payment intents
Retrieve Payment Intent	Retrieve a payment intent by ID
Create Payment Intent	Create a payment intent
Update Payment Intent	Update a payment intent
Cancel Payment Intent	Cancel a payment intent
Refund Payment	Refund a charge or payment intent
Create Checkout Session	Create a Stripe Checkout session (hosted payment page)
Update Checkout Session	Update a checkout session
Retrieve Checkout Session	Retrieve a checkout session by ID
List Checkout Sessions	List checkout sessions
List Checkout Session Line Items	List line items for a checkout session
Expire Checkout Session	Expire a checkout session
Create Invoice Item	Add a line item to a customer (or to a draft invoice)

Action details

List Products

List products from your Stripe account.

Inputs

Display Key	Example Input	Description	Restrictions
Active Optional	true	Filter by active status	true, false, or empty for all
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"prod_123"	Pagination cursor (start after this ID)	Use an ID from the previous result
Ending Before Optional	"prod_456"	Pagination cursor (end before this ID)	Use an ID from the previous result

Example output

{ "object": "list", "data": [{ "id": "prod_123", "object": "product" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List products (GET /v1/products)

Retrieve Product

Retrieve a product by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Product ID	"prod_123"	Product ID to retrieve	Required

Example output

{ "id": "prod_123", "object": "product", "name": "Premium Plan" }

Documentation of API endpoint that powers action: Stripe API – Retrieve a product (GET /v1/products/{id})

Create Product

Create a product.

Inputs

Display Key	Example Input	Description	Restrictions
Name	"Premium Plan"	Product name	Required
Active Optional	true	Whether the product is active	true or false
Description Optional	"Premium subscription plan"	Product description	—
Images Optional	["https://example.com/img.jpg"]	Image URLs	Max 8 URLs
URL Optional	"https://example.com/product"	Product URL	—
Metadata Optional	{"internal_id":"123"}	Extra values you want to store	Object

Example output

{ "id": "prod_123", "object": "product", "name": "Premium Plan" }

Documentation of API endpoint that powers action: Stripe API – Create a product (POST /v1/products)

Update Product

Update a product.

Inputs

Display Key	Example Input	Description	Restrictions
Product ID	"prod_123"	Product ID to update	Required
Name Optional	"Premium Plan Updated"	Product name	—
Active Optional	false	Whether the product is active	true or false
Description Optional	"Updated description"	Product description	—
Images Optional	["https://example.com/new.jpg"]	Image URLs	Max 8 URLs
URL Optional	"https://example.com/new-product"	Product URL	—
Default Price Optional	"price_123"	Default price ID	—
Metadata Optional	{"internal_id":"456"}	Extra values you want to store	Object

Example output

{ "id": "prod_123", "object": "product", "name": "Premium Plan Updated" }

Documentation of API endpoint that powers action: Stripe API – Update a product (POST /v1/products/{id})

Delete Product

Delete a product.

Inputs

Display Key	Example Input	Description	Restrictions
Product ID	"prod_123"	Product ID to delete	Required

Example output

{ "id": "prod_123", "object": "product", "deleted": true }

Documentation of API endpoint that powers action: Stripe API – Delete a product (DELETE /v1/products/{id})

List Prices

List prices from your Stripe account.

Inputs

Display Key	Example Input	Description	Restrictions
Product Optional	"prod_123"	Filter by product ID	—
Active Optional	true	Filter by active status	true, false, or empty for all
Currency Optional	"usd"	Filter by currency	ISO code
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"price_123"	Pagination cursor	—
Ending Before Optional	"price_456"	Pagination cursor	—

Example output

{ "object": "list", "data": [{ "id": "price_123", "object": "price" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List prices (GET /v1/prices)

Retrieve Price

Retrieve a price by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Price ID	"price_123"	Price ID to retrieve	Required

Example output

{ "id": "price_123", "object": "price", "currency": "usd" }

Documentation of API endpoint that powers action: Stripe API – Retrieve a price (GET /v1/prices/{id})

Create Price

Create a price.

Inputs

Display Key	Example Input	Description	Restrictions
Currency	"usd"	Currency	Required
Product	"prod_123"	Product ID	Required if Product Data is empty
Unit Amount Optional	1000	Price in cents	—
Recurring Optional	{"interval":"month"}	Recurring billing settings	Object
Nickname Optional	"Monthly Premium"	Short label	—
Metadata Optional	{"internal_id":"123"}	Extra values you want to store	Object
Product Data Optional	{"name":"New Product"}	Create a product inline	Required if Product is empty

Example output

{ "id": "price_123", "object": "price", "currency": "usd" }

Documentation of API endpoint that powers action: Stripe API – Create a price (POST /v1/prices)

Update Price

Update a price.

Inputs

Display Key	Example Input	Description	Restrictions
Price ID	"price_123"	Price ID to update	Required
Active Optional	false	Whether the price is active	true or false
Nickname Optional	"Updated Monthly"	Short label	—
Lookup Key Optional	"premium_monthly_v2"	Lookup key	—
Tax Behavior Optional	"inclusive"	Tax behavior	exclusive, inclusive, unspecified
Metadata Optional	{"internal_id":"456"}	Extra values you want to store	Object

Example output

{ "id": "price_123", "object": "price", "active": false }

Documentation of API endpoint that powers action: Stripe API – Update a price (POST /v1/prices/{id})

Deactivate Price

Deactivate a price by setting Active to false.

Inputs

Display Key	Example Input	Description	Restrictions
Price ID	"price_123"	Price ID to deactivate	Required

Example output

{ "id": "price_123", "object": "price", "active": false }

Documentation of API endpoint that powers action: Stripe API – Update a price (POST /v1/prices/{id})

List Customers

List customers.

Inputs

Display Key	Example Input	Description	Restrictions
Email Optional	"customer@example.com"	Filter by email	—
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"cus_123"	Pagination cursor	—
Ending Before Optional	"cus_456"	Pagination cursor	—

Example output

{ "object": "list", "data": [{ "id": "cus_123", "object": "customer" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List customers (GET /v1/customers)

Retrieve Customer

Retrieve a customer by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Customer ID	"cus_123"	Customer ID to retrieve	Required

Example output

{ "id": "cus_123", "object": "customer", "email": "customer@example.com" }

Documentation of API endpoint that powers action: Stripe API – Retrieve a customer (GET /v1/customers/{id})

Create Customer

Create a customer.

Inputs

Display Key	Example Input	Description	Restrictions
Email Optional	"customer@example.com"	Customer email address	—
Name Optional	"John Doe"	Customer name	—
Phone Optional	"+1234567890"	Customer phone number	—
Description Optional	"Premium customer"	Description	—
Address Optional	{"line1":"123 Main St","city":"NYC","country":"US"}	Address object	Object
Metadata Optional	{"internal_id":"123"}	Extra values you want to store	Object

Example output

{ "id": "cus_123", "object": "customer", "name": "John Doe" }

Documentation of API endpoint that powers action: Stripe API – Create a customer (POST /v1/customers)

Update Customer

Update a customer.

Inputs

Display Key	Example Input	Description	Restrictions
Customer ID	"cus_123"	Customer ID to update	Required
Email Optional	"newemail@example.com"	Customer email address	—
Name Optional	"Jane Doe"	Customer name	—
Phone Optional	"+1987654321"	Customer phone number	—
Address Optional	{"line1":"456 Oak St","city":"LA","country":"US"}	Address object	Object
Metadata Optional	{"internal_id":"456"}	Extra values you want to store	Object

Example output

{ "id": "cus_123", "object": "customer", "email": "newemail@example.com" }

Documentation of API endpoint that powers action: Stripe API – Update a customer (POST /v1/customers/{id})

Delete Customer

Delete a customer.

Inputs

Display Key	Example Input	Description	Restrictions
Customer ID	"cus_123"	Customer ID to delete	Required

Example output

{ "id": "cus_123", "object": "customer", "deleted": true }

Documentation of API endpoint that powers action: Stripe API – Delete a customer (DELETE /v1/customers/{id})

List Invoices

List invoices.

Inputs

Display Key	Example Input	Description	Restrictions
Customer Optional	"cus_123"	Filter by customer ID	—
Status Optional	"open"	Filter by invoice status	Stripe invoice status
Subscription Optional	"sub_123"	Filter by subscription ID	—
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"in_123"	Pagination cursor	—
Ending Before Optional	"in_456"	Pagination cursor	—

Example output

{ "object": "list", "data": [{ "id": "in_123", "object": "invoice" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List invoices (GET /v1/invoices)

Retrieve Invoice

Retrieve an invoice by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Invoice ID	"in_123"	Invoice ID to retrieve	Required

Example output

{ "id": "in_123", "object": "invoice", "status": "draft" }

Documentation of API endpoint that powers action: Stripe API – Retrieve an invoice (GET /v1/invoices/{id})

Create Invoice

Create an invoice for a customer.

Inputs

Display Key	Example Input	Description	Restrictions
Customer	"cus_123"	Customer ID	Required
Auto Advance Optional	true	Automatically finalize invoice	true or false
Collection Method Optional	"charge_automatically"	How the invoice is collected	charge_automatically or send_invoice
Description Optional	"Monthly invoice"	Description	—
Days Until Due Optional	30	Days until due	Positive integer
Due Date Optional	1672531200	Due date	Unix timestamp
Metadata Optional	{"internal_id":"123"}	Extra values you want to store	Object

Example output

{ "id": "in_123", "object": "invoice", "customer": "cus_123" }

Documentation of API endpoint that powers action: Stripe API – Create an invoice (POST /v1/invoices)

Update Invoice

Update an invoice.

Inputs

Display Key	Example Input	Description	Restrictions
Invoice ID	"in_123"	Invoice ID to update	Required
Auto Advance Optional	false	Automatically finalize invoice	true or false
Collection Method Optional	"send_invoice"	How the invoice is collected	charge_automatically or send_invoice
Description Optional	"Updated invoice"	Description	—
Metadata Optional	{"internal_id":"456"}	Extra values you want to store	Object

Example output

{ "id": "in_123", "object": "invoice", "status": "draft" }

Documentation of API endpoint that powers action: Stripe API – Update an invoice (POST /v1/invoices/{id})

Delete Invoice

Delete a draft invoice.

Inputs

Display Key	Example Input	Description	Restrictions
Invoice ID	"in_123"	Invoice ID to delete	Required

Example output

{ "id": "in_123", "object": "invoice", "deleted": true }

Documentation of API endpoint that powers action: Stripe API – Delete a draft invoice (DELETE /v1/invoices/{id})

List Subscriptions

List subscriptions.

Inputs

Display Key	Example Input	Description	Restrictions
Customer Optional	"cus_123"	Filter by customer ID	—
Price Optional	"price_123"	Filter by price ID	—
Status Optional	"active"	Filter by status	Stripe subscription status
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"sub_123"	Pagination cursor	—
Ending Before Optional	"sub_456"	Pagination cursor	—

Example output

{ "object": "list", "data": [{ "id": "sub_123", "object": "subscription" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List subscriptions (GET /v1/subscriptions)

Retrieve Subscription

Retrieve a subscription by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Subscription ID	"sub_123"	Subscription ID to retrieve	Required

Example output

{ "id": "sub_123", "object": "subscription", "status": "active" }

Documentation of API endpoint that powers action: Stripe API – Retrieve a subscription (GET /v1/subscriptions/{id})

Create Subscription

Create a subscription.

Inputs

Display Key	Example Input	Description	Restrictions
Customer	"cus_123"	Customer ID	Required
Items	[{"price":"price_123","quantity":1}]	Subscription items	Required; Price ID required in each item
Cancel at Period End Optional	false	Cancel at end of current period	true or false
Default Payment Method Optional	"pm_123"	Payment method ID	—
Description Optional	"Premium subscription"	Description	—
Collection Method Optional	"charge_automatically"	How the invoice is collected	charge_automatically or send_invoice
Metadata Optional	{"internal_id":"123"}	Extra values you want to store	Object

Example output

{ "id": "sub_123", "object": "subscription", "customer": "cus_123" }

Documentation of API endpoint that powers action: Stripe API – Create a subscription (POST /v1/subscriptions)

Update Subscription

Update a subscription.

Inputs

Display Key	Example Input	Description	Restrictions
Subscription ID	"sub_123"	Subscription ID to update	Required
Cancel at Period End Optional	true	Cancel at end of current period	true or false
Default Payment Method Optional	"pm_456"	Payment method ID	—
Description Optional	"Updated subscription"	Description	—
Items Optional	[{"id":"si_123","price":"price_456"}]	Items to update	Item ID or Price ID
Metadata Optional	{"internal_id":"456"}	Extra values you want to store	Object
Proration Behavior Optional	"create_prorations"	How changes are prorated	create_prorations, none, always_invoice

Example output

{ "id": "sub_123", "object": "subscription", "status": "active" }

Documentation of API endpoint that powers action: Stripe API – Update a subscription (POST /v1/subscriptions/{id})

Cancel Subscription

Cancel a subscription.

Inputs

Display Key	Example Input	Description	Restrictions
Subscription ID	"sub_123"	Subscription ID to cancel	Required

Example output

{ "id": "sub_123", "object": "subscription", "status": "canceled" }

Documentation of API endpoint that powers action: Stripe API – Cancel a subscription (DELETE /v1/subscriptions/{id})

List Payment Intents

List payment intents.

Inputs

Display Key	Example Input	Description	Restrictions
Customer Optional	"cus_123"	Filter by customer ID	—
Limit Optional	10	Number of results to return	1–100
Starting After Optional	"pi_123"	Pagination cursor	—
Ending Before Optional	"pi_456"	Pagination cursor	—

Example output

{ "object": "list", "data": [{ "id": "pi_123", "object": "payment_intent" }], "has_more": false }

Documentation of API endpoint that powers action: Stripe API – List payment intents (GET /v1/payment_intents)

Retrieve Payment Intent

Retrieve a payment intent by its ID.

Inputs

Display Key	Example Input	Description	Restrictions
Payment Intent ID	"pi_123"	Payment intent ID to retrieve	Required

Example output

{ "id": "pi_123", "object": "payment_intent", "status": "requires_payment_method" }

Documentation of API endpoint that powers action: Stripe API – Retrieve a payment intent (GET /v1/payment_intents/{id})

Create Payment Intent

Create a payment intent.

Inputs

Display Key	Example Input	Description	Restrictions
Amount	1000	Amount in cents	Required
Currency	"usd"	Currency	Required
Customer Optional	"cus_123"	Customer ID	—
Payment Method Optional	"pm_123"	Payment method ID	—
Description Optional	"Payment for order #123"	Description	—
Receipt Email Optional	"customer@example.com"	Receipt email	—
Automatic Payment Methods Optional	{"enabled":true}	Let Stripe choose available payment methods	Object
Metadata Optional	{"order_id":"123"}	Extra values you want to store	Object

Example output

{ "id": "pi_123", "object": "payment_intent", "amount": 1000, "currency": "usd" }

Documentation of API endpoint that powers action: Stripe API – Create a payment intent (POST /v1/payment_intents)

Update Payment Intent

Update a payment intent.

Inputs

Display Key	Example Input	Description	Restrictions
Payment Intent ID	"pi_123"	Payment intent ID to update	Required
Amount Optional	1200	Amount in cents	—
Description Optional	"Updated order"	Description	—
Payment Method Optional	"pm_456"	Payment method ID	—
Receipt Email Optional	"customer@example.com"	Receipt email	—
Metadata Optional	{"order_id":"456"}	Extra values you want to store	Object

Example output

{ "id": "pi_123", "object": "payment_intent", "amount": 1200 }

Documentation of API endpoint that powers action: Stripe API – Update a payment intent (POST /v1/payment_intents/{id})

Cancel Payment Intent

Cancel a payment intent.

Inputs

Display Key	Example Input	Description	Restrictions
Payment Intent ID	"pi_123"	Payment intent ID to cancel	Required
Cancellation Reason Optional	"requested_by_customer"	Reason for cancellation	duplicate, fraudulent, requested_by_customer, abandoned

Example output

{ "id": "pi_123", "object": "payment_intent", "status": "canceled" }

Documentation of API endpoint that powers action: Stripe API – Cancel a payment intent (POST /v1/payment_intents/{id}/cancel)

Refund Payment

Refund a charge or a payment intent.

Inputs

Display Key	Example Input	Description	Restrictions
Charge ID Optional	"ch_123"	Charge to refund	Required when refund type is Charge
Payment Intent ID Optional	"pi_123"	Payment intent to refund	Required when refund type is Payment Intent
Amount Optional	1000	Amount to refund in cents	Empty refunds the full amount
Reason Optional	"requested_by_customer"	Refund reason	duplicate, fraudulent, requested_by_customer
Metadata Optional	{"order_id":"12345"}	Extra values you want to store	Object

Example output

{ "id": "re_123", "object": "refund", "status": "succeeded" }

Documentation of API endpoint that powers action: Stripe API – Create a refund (POST /v1/refunds)

Create Checkout Session

Create a Stripe Checkout session. Returns a session object with a url; redirect the customer to that URL to complete payment or subscription on Stripe’s hosted page.

Inputs

Display Key	Example Input	Description	Restrictions
Mode	"payment"	Session mode	Required: payment, subscription, or setup
Line Items	[{"price":"price_123","quantity":1}]	Line items to purchase	Required for payment and subscription
Success URL	"https://yoursite.com/success?session_id={CHECKOUT_SESSION_ID}"	Redirect URL after success	Required; may include {CHECKOUT_SESSION_ID}
Cancel URL	"https://yoursite.com/cancel"	Redirect URL if customer cancels	Required
Customer Optional	"cus_123"	Existing Stripe customer ID	—
Customer Email Optional	"user@example.com"	Customer email (if no Customer)	—
Payment Method Types Optional	["card"]	Allowed payment methods	—
Allow Promotion Codes Optional	true	Allow promo codes on Checkout	Boolean
Metadata Optional	{"order_id":"123"}	Key-value pairs	Object
Subscription Data Optional	{"trial_period_days":14}	Options for subscription mode	Object

Example output

{ "id": "cs_123", "object": "checkout.session", "url": "https://checkout.stripe.com/...", "status": "open" }

Documentation of API endpoint that powers action: Stripe API – Create a checkout session (POST /v1/checkout/sessions)

Update Checkout Session

Update a checkout session (e.g. metadata, line items). Only sessions in open status can be updated.

Inputs

Display Key	Example Input	Description	Restrictions
ID	"cs_123"	Checkout session ID	Required
Metadata Optional	{"order_id":"456"}	Key-value pairs	Object
Line Items Optional	[...]	Replace line items	—
Shipping Options Optional	[...]	Shipping options	—

Documentation of API endpoint that powers action: Stripe API – Update a checkout session (POST /v1/checkout/sessions/{id})

Retrieve Checkout Session

Retrieve a checkout session by ID (e.g. on your success page to show order details).

Inputs

Display Key	Example Input	Description	Restrictions
ID	"cs_123"	Checkout session ID	Required
Expand Optional	["line_items"]	Fields to expand	Array

Example output

{ "id": "cs_123", "object": "checkout.session", "payment_status": "paid", "customer": "cus_123", "amount_total": 2000 }

Documentation of API endpoint that powers action: Stripe API – Retrieve a checkout session (GET /v1/checkout/sessions/{id})

List Checkout Sessions

List checkout sessions, optionally filtered by customer, subscription, status, etc.

Inputs

Display Key	Example Input	Description	Restrictions
Customer Optional	"cus_123"	Filter by customer	—
Status Optional	"complete"	Filter by status	open, complete, expired
Limit Optional	10	Number of results	1–100
Starting After Optional	"cs_123"	Pagination cursor	—
Ending Before Optional	"cs_456"	Pagination cursor	—

Documentation of API endpoint that powers action: Stripe API – List checkout sessions (GET /v1/checkout/sessions)

List Checkout Session Line Items

List line items for a checkout session.

Inputs

Display Key	Example Input	Description	Restrictions
ID	"cs_123"	Checkout session ID	Required
Limit Optional	10	Number of results	1–100
Starting After Optional	"li_123"	Pagination cursor	—
Ending Before Optional	"li_456"	Pagination cursor	—

Documentation of API endpoint that powers action: Stripe API – List line items (GET /v1/checkout/sessions/{id}/line_items)

Expire Checkout Session

Expire an open checkout session so it can no longer be used.

Inputs

Display Key	Example Input	Description	Restrictions
ID	"cs_123"	Checkout session ID	Required

Documentation of API endpoint that powers action: Stripe API – Expire a session (POST /v1/checkout/sessions/{id}/expire)

Create Invoice Item

Add a line item to a customer (for their next invoice) or to a specific draft invoice. Use this to add one-off charges, usage-based lines, or credits.

Inputs

Display Key	Example Input	Description	Restrictions
Customer	"cus_123"	Customer ID	Required (unless attaching to an invoice)
Invoice Optional	"in_123"	Draft invoice ID to add the line to	—
Price Optional	"price_123"	Price ID	Use Price or Amount + Currency
Amount Optional	1000	Amount in cents	—
Currency Optional	"usd"	Currency	Required if using Amount
Quantity Optional	1	Quantity	Default 1
Description Optional	"One-time setup fee"	Line description	—
Metadata Optional	{"ref":"123"}	Key-value pairs	Object

Example output

{ "id": "ii_123", "object": "line_item", "customer": "cus_123", "amount": 1000 }

Documentation of API endpoint that powers action: Stripe API – Create an invoice item (POST /v1/invoiceitems)