> ## Documentation Index
> Fetch the complete documentation index at: https://docs.modulex.dev/llms.txt
> Use this file to discover all available pages before exploring further.
# Stripe Integration for AI Agents & Workflows
> Integrate Stripe into the workflow. Manage payment intents, customers, subscriptions, invoices, charges, products, prices, and events through the Stripe REST API.
{/* Self-hosted logo — build-time vendored from modulex.json / Iconify (see scripts/lib/logo.js). */}
## Overview
Add **Stripe** to any ModuleX agent or workflow. Process payments and manage commerce data through the Stripe REST API (`api.stripe.com/v1`). Covers payment intents, customers, subscriptions, invoices, charges, products, prices, and events — 50 actions in all.
**Categories**: Finance & Payments · Payments · Subscriptions · **Auth**: API Key · **Actions**: 50
## Authentication
### API Key Authentication
Authenticate using your Stripe secret API key
Sign in to your Stripe dashboard at [https://dashboard.stripe.com](https://dashboard.stripe.com)
Open the Developers section and click 'API keys'
Reveal or create a secret key (it starts with sk\_test\_ or sk\_live\_)
Paste the secret key below
#### Required Credentials
| Field | Description | Required | Format |
| ----------------- | ---------------------------------------------------- | -------- | ------------- |
| Stripe Secret Key | Your Stripe secret API key from the Stripe dashboard | Yes | `sk_test_...` |
## Available Actions
### Parameters
Amount in cents (e.g., 2000 for \$20.00)
Three-letter ISO currency code (e.g., usd, eur)
Customer ID to associate with this payment
Payment method ID
Description of the payment
Email address to send receipt to
Set of key-value pairs for storing additional information
Enable automatic payment methods (e.g., \{"enabled": true})
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Payment Intent ID (e.g., pi\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Payment Intent ID (e.g., pi\_1234567890)
Updated amount in cents
Three-letter ISO currency code
Customer ID
Updated description
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Payment Intent ID (e.g., pi\_1234567890)
Payment method ID to confirm with
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Payment Intent ID (e.g., pi\_1234567890)
Amount to capture in cents (defaults to full amount)
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Payment Intent ID (e.g., pi\_1234567890)
Reason for cancellation (duplicate, fraudulent, requested\_by\_customer, abandoned)
### Response
```json theme={null}
{
"$defs": {
"PaymentIntentMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PaymentIntentMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Payment Intent"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PaymentIntentMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by customer ID
Filter by creation date (e.g., \{"gt": 1633024800})
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intents": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Payment Intents",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"payment_intents": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Payment Intents",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PaymentIntentListOutput",
"type": "object"
}
```
### Parameters
Customer email address
Customer full name
Customer phone number
Description of the customer
Customer address object
Set of key-value pairs for storing additional information
Payment method ID to attach
### Response
```json theme={null}
{
"$defs": {
"CustomerMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"title": "CustomerMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customer": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/CustomerMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CustomerOutput",
"type": "object"
}
```
### Parameters
Customer ID (e.g., cus\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"CustomerMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"title": "CustomerMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customer": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/CustomerMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CustomerOutput",
"type": "object"
}
```
### Parameters
Customer ID (e.g., cus\_1234567890)
Updated email address
Updated name
Updated phone number
Updated description
Updated address object
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"CustomerMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Email"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
}
},
"title": "CustomerMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customer": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/CustomerMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CustomerOutput",
"type": "object"
}
```
### Parameters
Customer ID (e.g., cus\_1234567890)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
}
},
"required": [
"success"
],
"title": "CustomerDeleteOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by email address
Filter by creation date
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customers": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Customers",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CustomerListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"customers": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Customers",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "CustomerListOutput",
"type": "object"
}
```
### Parameters
Customer ID to subscribe
Array of items with price IDs (e.g., \[\{"price": "price\_xxx", "quantity": 1}])
Number of trial days
Payment method ID
Cancel subscription at period end
Set of key-value pairs for storing additional information
### Response
```json theme={null}
{
"$defs": {
"SubscriptionMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"customer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
}
},
"title": "SubscriptionMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscription": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Subscription"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/SubscriptionMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionOutput",
"type": "object"
}
```
### Parameters
Subscription ID (e.g., sub\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"SubscriptionMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"customer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
}
},
"title": "SubscriptionMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscription": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Subscription"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/SubscriptionMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionOutput",
"type": "object"
}
```
### Parameters
Subscription ID (e.g., sub\_1234567890)
Updated array of items with price IDs
Cancel subscription at period end
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"SubscriptionMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"customer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
}
},
"title": "SubscriptionMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscription": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Subscription"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/SubscriptionMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionOutput",
"type": "object"
}
```
### Parameters
Subscription ID (e.g., sub\_1234567890)
Whether to prorate the cancellation
Whether to invoice immediately
### Response
```json theme={null}
{
"$defs": {
"SubscriptionMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"customer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
}
},
"title": "SubscriptionMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscription": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Subscription"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/SubscriptionMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionOutput",
"type": "object"
}
```
### Parameters
Subscription ID (e.g., sub\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"SubscriptionMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"customer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Customer"
}
},
"title": "SubscriptionMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscription": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Subscription"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/SubscriptionMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by customer ID
Filter by status (active, past\_due, unpaid, canceled, incomplete, incomplete\_expired, trialing, all)
Filter by price ID
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscriptions": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Subscriptions",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"subscriptions": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Subscriptions",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "SubscriptionListOutput",
"type": "object"
}
```
### Parameters
Customer ID (e.g., cus\_1234567890)
Description of the invoice
Set of key-value pairs for storing additional information
Auto-finalize the invoice
Collection method: charge\_automatically or send\_invoice
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
Description of the invoice
Set of key-value pairs for storing additional information
Auto-finalize the invoice
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
}
},
"required": [
"success"
],
"title": "InvoiceDeleteOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
Auto-advance the invoice
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
Mark invoice as paid out of band
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Invoice ID (e.g., in\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"InvoiceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount_due": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount Due"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "InvoiceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoice": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Invoice"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/InvoiceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by customer ID
Filter by invoice status
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoices": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Invoices",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"invoices": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Invoices",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "InvoiceListOutput",
"type": "object"
}
```
### Parameters
Amount in cents (e.g., 2000 for \$20.00)
Three-letter ISO currency code (e.g., usd, eur)
Customer ID to associate with this charge
Payment source ID (e.g., card token or saved card ID)
Description of the charge
Set of key-value pairs for storing additional information
Whether to immediately capture the charge (defaults to true)
### Response
```json theme={null}
{
"$defs": {
"ChargeMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"paid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paid"
}
},
"title": "ChargeMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charge": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Charge"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ChargeMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeOutput",
"type": "object"
}
```
### Parameters
Charge ID (e.g., ch\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"ChargeMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"paid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paid"
}
},
"title": "ChargeMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charge": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Charge"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ChargeMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeOutput",
"type": "object"
}
```
### Parameters
Charge ID (e.g., ch\_1234567890)
Updated description
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"ChargeMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"paid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paid"
}
},
"title": "ChargeMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charge": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Charge"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ChargeMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeOutput",
"type": "object"
}
```
### Parameters
Charge ID (e.g., ch\_1234567890)
Amount to capture in cents (defaults to full amount)
### Response
```json theme={null}
{
"$defs": {
"ChargeMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Status"
},
"amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
},
"paid": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Paid"
}
},
"title": "ChargeMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charge": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Charge"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ChargeMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by customer ID
Filter by creation date (e.g., \{"gt": 1633024800})
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charges": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Charges",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"charges": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Charges",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ChargeListOutput",
"type": "object"
}
```
### Parameters
Product name
Product description
Whether the product is active
Array of image URLs for the product
Set of key-value pairs for storing additional information
### Response
```json theme={null}
{
"$defs": {
"ProductMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
}
},
"title": "ProductMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ProductMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ProductOutput",
"type": "object"
}
```
### Parameters
Product ID (e.g., prod\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"ProductMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
}
},
"title": "ProductMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ProductMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ProductOutput",
"type": "object"
}
```
### Parameters
Product ID (e.g., prod\_1234567890)
Updated product name
Updated product description
Updated active status
Updated array of image URLs
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"ProductMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Name"
},
"active": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Active"
}
},
"title": "ProductMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"product": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ProductMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ProductOutput",
"type": "object"
}
```
### Parameters
Product ID (e.g., prod\_1234567890)
### Response
```json theme={null}
{
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"deleted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Deleted"
},
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
}
},
"required": [
"success"
],
"title": "ProductDeleteOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by active status
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"products": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Products",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ProductListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"products": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Products",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "ProductListOutput",
"type": "object"
}
```
### Parameters
Product ID (e.g., prod\_1234567890)
Three-letter ISO currency code (e.g., usd, eur)
Amount in cents (e.g., 1000 for \$10.00)
Recurring billing configuration (interval: day/week/month/year)
Set of key-value pairs for storing additional information
Billing scheme (per\_unit or tiered)
### Response
```json theme={null}
{
"$defs": {
"PriceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"product": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"unit_amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PriceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"price": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PriceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PriceOutput",
"type": "object"
}
```
### Parameters
Price ID (e.g., price\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"PriceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"product": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"unit_amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PriceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"price": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PriceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PriceOutput",
"type": "object"
}
```
### Parameters
Price ID (e.g., price\_1234567890)
Whether the price is active
Updated metadata
### Response
```json theme={null}
{
"$defs": {
"PriceMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"product": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Product"
},
"unit_amount": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Unit Amount"
},
"currency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Currency"
}
},
"title": "PriceMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"price": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Price"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/PriceMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PriceOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by product ID
Filter by active status
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"prices": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Prices",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PriceListOutput",
"type": "object"
}
```
### Parameters
Search query using Stripe's search query syntax
Number of results to return (default 10, max 100)
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"prices": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Prices",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "PriceListOutput",
"type": "object"
}
```
### Parameters
Event ID (e.g., evt\_1234567890)
### Response
```json theme={null}
{
"$defs": {
"EventMetadata": {
"additionalProperties": false,
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Id"
},
"type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Type"
},
"created": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Created"
}
},
"title": "EventMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"event": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"title": "Event"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/EventMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "EventOutput",
"type": "object"
}
```
### Parameters
Number of results to return (default 10, max 100)
Filter by event type (e.g., payment\_intent.created)
Filter by creation date (e.g., \{"gt": 1633024800})
### Response
```json theme={null}
{
"$defs": {
"ListMetadata": {
"additionalProperties": false,
"description": "Pagination summary for list/search responses.",
"properties": {
"count": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Count"
},
"has_more": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"title": "Has More"
}
},
"title": "ListMetadata",
"type": "object"
}
},
"additionalProperties": false,
"properties": {
"success": {
"title": "Success",
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Error"
},
"events": {
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Events",
"type": "array"
},
"metadata": {
"anyOf": [
{
"$ref": "#/$defs/ListMetadata"
},
{
"type": "null"
}
],
"default": null
}
},
"required": [
"success"
],
"title": "EventListOutput",
"type": "object"
}
```
## Limits & Quotas
* **Rate limits**: Stripe allows \~100 read and \~100 write requests per
second in live mode (lower in test mode). Search endpoints have their
own, lower limits.
* **Request format**: requests are sent as
`application/x-www-form-urlencoded` with Stripe's bracketed key
notation for nested objects and arrays.
* **Error model**: non-2xx responses and timeouts are caught and
returned as `success=False` + `error` rather than raising. Plan for
retries on the agent side based on the error string.
## Related integrations
## Links
* [Stripe](https://stripe.com)