Stripe
API actions for the Stripe integration.
Stripe
Accept payments and automate billing workflows with the Stripe API.
Confirm a payment intent
Confirm a payment intent with a payment method to complete the payment.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
payment_intent_id | string | Yes | Stripe payment intent ID |
payment_method | string | Yes | Payment method ID (e.g., pm_card_visa for test mode) |
Response
{
"id": "pi_123",
"status": "succeeded"
}Create a Stripe customer
Create a new Stripe customer with contact details.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Customer email |
name | string | No | Customer name |
description | string | No | Customer description |
phone | string | No | Customer phone number |
Response
{
"email": "customer@example.com",
"id": "cus_123",
"name": "Example Customer"
}Create a payment intent
Create a payment intent for a custom charge.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
amount | number | Yes | Amount in the smallest currency unit |
currency | string | Yes | Currency code |
customer_id | string | No | Optional customer to link |
description | string | No | Payment description |
Response
{
"amount": 500,
"currency": "usd",
"id": "pi_123"
}Create a Stripe payment link
Generate a payment link for a price.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
price_id | string | Yes | Stripe price ID |
quantity | number | No | Quantity to purchase |
Response
{
"id": "plink_123",
"url": "https://pay.stripe.com/test"
}Create a Stripe price
Create a one-time or recurring price for a product.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
product_id | string | Yes | Stripe product ID |
unit_amount | number | Yes | Price amount in the smallest currency unit |
currency | string | Yes | Currency code (e.g. usd) |
interval | string | No | Recurring interval (day, week, month, year) |
interval_count | number | No | Number of intervals for recurring prices |
Response
{
"currency": "usd",
"id": "price_123",
"unit_amount": 500
}Create a Stripe product
Create a product to sell with Stripe.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Product name |
description | string | No | Product description |
Response
{
"id": "prod_123",
"name": "Example Product"
}List Stripe customers
List recent Stripe customers with an optional limit.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
limit | number | No | Maximum customers to return |
Response
[
{
"email": "customer@example.com",
"id": "cus_123"
},
{
"email": "other@example.com",
"id": "cus_124"
}
]Refund a Stripe payment
Refund a payment intent, optionally partially.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
payment_intent_id | string | Yes | Stripe payment intent ID |
amount | number | No | Amount to refund in the smallest currency unit |
Response
{
"amount": 200,
"id": "re_123"
}Retrieve a Stripe customer
Fetch a Stripe customer by ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
customer_id | string | Yes | Stripe customer ID |
Response
{
"email": "customer@example.com",
"id": "cus_123"
}