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 key1
Step 1
Sign in to your Stripe dashboard at https://dashboard.stripe.com
2
Step 2
Open the Developers section and click ‘API keys’
3
Step 3
Reveal or create a secret key (it starts with sk_test_ or sk_live_)
4
Step 4
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
create_payment_intent — Create a new Payment Intent to process a payment.
create_payment_intent — Create a new Payment Intent to process a payment.
Parameters
integer
required
Amount in cents (e.g., 2000 for $20.00)
string
required
Three-letter ISO currency code (e.g., usd, eur)
string
Customer ID to associate with this payment
string
Payment method ID
string
Description of the payment
string
Email address to send receipt to
object
Set of key-value pairs for storing additional information
object
Enable automatic payment methods (e.g., {“enabled”: true})
Response
{
"$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"
}
retrieve_payment_intent — Retrieve an existing Payment Intent by ID.
retrieve_payment_intent — Retrieve an existing Payment Intent by ID.
Parameters
string
required
Payment Intent ID (e.g., pi_1234567890)
Response
{
"$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"
}
update_payment_intent — Update an existing Payment Intent.
update_payment_intent — Update an existing Payment Intent.
Parameters
string
required
Payment Intent ID (e.g., pi_1234567890)
integer
Updated amount in cents
string
Three-letter ISO currency code
string
Customer ID
string
Updated description
object
Updated metadata
Response
{
"$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"
}
confirm_payment_intent — Confirm a Payment Intent to complete the payment.
confirm_payment_intent — Confirm a Payment Intent to complete the payment.
Parameters
string
required
Payment Intent ID (e.g., pi_1234567890)
string
Payment method ID to confirm with
Response
{
"$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"
}
capture_payment_intent — Capture an authorized Payment Intent.
capture_payment_intent — Capture an authorized Payment Intent.
Parameters
string
required
Payment Intent ID (e.g., pi_1234567890)
integer
Amount to capture in cents (defaults to full amount)
Response
{
"$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"
}
cancel_payment_intent — Cancel a Payment Intent.
cancel_payment_intent — Cancel a Payment Intent.
Parameters
string
required
Payment Intent ID (e.g., pi_1234567890)
string
Reason for cancellation (duplicate, fraudulent, requested_by_customer, abandoned)
Response
{
"$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"
}
list_payment_intents — List all Payment Intents.
list_payment_intents — List all Payment Intents.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by customer ID
object
Filter by creation date (e.g., {“gt”: 1633024800})
Response
{
"$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"
}
search_payment_intents — Search for Payment Intents using query syntax.
search_payment_intents — Search for Payment Intents using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_customer — Create a new customer object.
create_customer — Create a new customer object.
Parameters
string
Customer email address
string
Customer full name
string
Customer phone number
string
Description of the customer
object
Customer address object
object
Set of key-value pairs for storing additional information
string
Payment method ID to attach
Response
{
"$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"
}
retrieve_customer — Retrieve an existing customer by ID.
retrieve_customer — Retrieve an existing customer by ID.
Parameters
string
required
Customer ID (e.g., cus_1234567890)
Response
{
"$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"
}
update_customer — Update an existing customer.
update_customer — Update an existing customer.
Parameters
string
required
Customer ID (e.g., cus_1234567890)
string
Updated email address
string
Updated name
string
Updated phone number
string
Updated description
object
Updated address object
object
Updated metadata
Response
{
"$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"
}
delete_customer — Permanently delete a customer.
delete_customer — Permanently delete a customer.
Parameters
string
required
Customer ID (e.g., cus_1234567890)
Response
{
"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"
}
list_customers — List all customers.
list_customers — List all customers.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by email address
object
Filter by creation date
Response
{
"$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"
}
search_customers — Search for customers using query syntax.
search_customers — Search for customers using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_subscription — Create a new subscription for a customer.
create_subscription — Create a new subscription for a customer.
Parameters
string
required
Customer ID to subscribe
array
required
Array of items with price IDs (e.g., [{“price”: “price_xxx”, “quantity”: 1}])
integer
Number of trial days
string
Payment method ID
boolean
Cancel subscription at period end
object
Set of key-value pairs for storing additional information
Response
{
"$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"
}
retrieve_subscription — Retrieve an existing subscription by ID.
retrieve_subscription — Retrieve an existing subscription by ID.
Parameters
string
required
Subscription ID (e.g., sub_1234567890)
Response
{
"$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"
}
update_subscription — Update an existing subscription.
update_subscription — Update an existing subscription.
Parameters
string
required
Subscription ID (e.g., sub_1234567890)
array
Updated array of items with price IDs
boolean
Cancel subscription at period end
object
Updated metadata
Response
{
"$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"
}
cancel_subscription — Cancel a subscription.
cancel_subscription — Cancel a subscription.
Parameters
string
required
Subscription ID (e.g., sub_1234567890)
boolean
Whether to prorate the cancellation
boolean
Whether to invoice immediately
Response
{
"$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"
}
resume_subscription — Resume a subscription that was scheduled for cancellation.
resume_subscription — Resume a subscription that was scheduled for cancellation.
Parameters
string
required
Subscription ID (e.g., sub_1234567890)
Response
{
"$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"
}
list_subscriptions — List all subscriptions.
list_subscriptions — List all subscriptions.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by customer ID
string
Filter by status (active, past_due, unpaid, canceled, incomplete, incomplete_expired, trialing, all)
string
Filter by price ID
Response
{
"$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"
}
search_subscriptions — Search for subscriptions using query syntax.
search_subscriptions — Search for subscriptions using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_invoice — Create a new invoice.
create_invoice — Create a new invoice.
Parameters
string
required
Customer ID (e.g., cus_1234567890)
string
Description of the invoice
object
Set of key-value pairs for storing additional information
boolean
Auto-finalize the invoice
string
Collection method: charge_automatically or send_invoice
Response
{
"$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"
}
retrieve_invoice — Retrieve an existing invoice by ID.
retrieve_invoice — Retrieve an existing invoice by ID.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
Response
{
"$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"
}
update_invoice — Update an existing invoice.
update_invoice — Update an existing invoice.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
string
Description of the invoice
object
Set of key-value pairs for storing additional information
boolean
Auto-finalize the invoice
Response
{
"$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"
}
delete_invoice — Permanently delete a draft invoice.
delete_invoice — Permanently delete a draft invoice.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
Response
{
"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"
}
finalize_invoice — Finalize a draft invoice.
finalize_invoice — Finalize a draft invoice.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
boolean
Auto-advance the invoice
Response
{
"$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"
}
pay_invoice — Pay an invoice.
pay_invoice — Pay an invoice.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
boolean
Mark invoice as paid out of band
Response
{
"$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"
}
void_invoice — Void an invoice.
void_invoice — Void an invoice.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
Response
{
"$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"
}
send_invoice — Send an invoice to the customer.
send_invoice — Send an invoice to the customer.
Parameters
string
required
Invoice ID (e.g., in_1234567890)
Response
{
"$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"
}
list_invoices — List all invoices.
list_invoices — List all invoices.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by customer ID
string
Filter by invoice status
Response
{
"$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"
}
search_invoices — Search for invoices using query syntax.
search_invoices — Search for invoices using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_charge — Create a new charge to process a payment.
create_charge — Create a new charge to process a payment.
Parameters
integer
required
Amount in cents (e.g., 2000 for $20.00)
string
required
Three-letter ISO currency code (e.g., usd, eur)
string
Customer ID to associate with this charge
string
Payment source ID (e.g., card token or saved card ID)
string
Description of the charge
object
Set of key-value pairs for storing additional information
boolean
Whether to immediately capture the charge (defaults to true)
Response
{
"$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"
}
retrieve_charge — Retrieve an existing charge by ID.
retrieve_charge — Retrieve an existing charge by ID.
Parameters
string
required
Charge ID (e.g., ch_1234567890)
Response
{
"$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"
}
update_charge — Update an existing charge.
update_charge — Update an existing charge.
Parameters
string
required
Charge ID (e.g., ch_1234567890)
string
Updated description
object
Updated metadata
Response
{
"$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"
}
capture_charge — Capture an uncaptured charge.
capture_charge — Capture an uncaptured charge.
Parameters
string
required
Charge ID (e.g., ch_1234567890)
integer
Amount to capture in cents (defaults to full amount)
Response
{
"$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"
}
list_charges — List all charges.
list_charges — List all charges.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by customer ID
object
Filter by creation date (e.g., {“gt”: 1633024800})
Response
{
"$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"
}
search_charges — Search for charges using query syntax.
search_charges — Search for charges using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_product — Create a new product object.
create_product — Create a new product object.
Parameters
string
required
Product name
string
Product description
boolean
Whether the product is active
array
Array of image URLs for the product
object
Set of key-value pairs for storing additional information
Response
{
"$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"
}
retrieve_product — Retrieve an existing product by ID.
retrieve_product — Retrieve an existing product by ID.
Parameters
string
required
Product ID (e.g., prod_1234567890)
Response
{
"$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"
}
update_product — Update an existing product.
update_product — Update an existing product.
Parameters
string
required
Product ID (e.g., prod_1234567890)
string
Updated product name
string
Updated product description
boolean
Updated active status
array
Updated array of image URLs
object
Updated metadata
Response
{
"$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"
}
delete_product — Permanently delete a product.
delete_product — Permanently delete a product.
Parameters
string
required
Product ID (e.g., prod_1234567890)
Response
{
"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"
}
list_products — List all products.
list_products — List all products.
Parameters
integer
Number of results to return (default 10, max 100)
boolean
Filter by active status
Response
{
"$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"
}
search_products — Search for products using query syntax.
search_products — Search for products using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
create_price — Create a new price for a product.
create_price — Create a new price for a product.
Parameters
string
required
Product ID (e.g., prod_1234567890)
string
required
Three-letter ISO currency code (e.g., usd, eur)
integer
Amount in cents (e.g., 1000 for $10.00)
object
Recurring billing configuration (interval: day/week/month/year)
object
Set of key-value pairs for storing additional information
string
Billing scheme (per_unit or tiered)
Response
{
"$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"
}
retrieve_price — Retrieve an existing price by ID.
retrieve_price — Retrieve an existing price by ID.
Parameters
string
required
Price ID (e.g., price_1234567890)
Response
{
"$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"
}
update_price — Update an existing price.
update_price — Update an existing price.
Parameters
string
required
Price ID (e.g., price_1234567890)
boolean
Whether the price is active
object
Updated metadata
Response
{
"$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"
}
list_prices — List all prices.
list_prices — List all prices.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by product ID
boolean
Filter by active status
Response
{
"$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"
}
search_prices — Search for prices using query syntax.
search_prices — Search for prices using query syntax.
Parameters
string
required
Search query using Stripe’s search query syntax
integer
Number of results to return (default 10, max 100)
Response
{
"$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"
}
retrieve_event — Retrieve an existing Event by ID.
retrieve_event — Retrieve an existing Event by ID.
Parameters
string
required
Event ID (e.g., evt_1234567890)
Response
{
"$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"
}
list_events — List all Events.
list_events — List all Events.
Parameters
integer
Number of results to return (default 10, max 100)
string
Filter by event type (e.g., payment_intent.created)
object
Filter by creation date (e.g., {“gt”: 1633024800})
Response
{
"$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-urlencodedwith Stripe’s bracketed key notation for nested objects and arrays. - Error model: non-2xx responses and timeouts are caught and
returned as
success=False+errorrather than raising. Plan for retries on the agent side based on the error string.