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 keyStep 1
Sign in to your Stripe dashboard at https://dashboard.stripe.com
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
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
{
"$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
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
Payment Intent ID (e.g., pi_1234567890)
Updated amount in cents
Three-letter ISO currency code
Customer ID
Updated description
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
Payment Intent ID (e.g., pi_1234567890)
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
Payment Intent ID (e.g., pi_1234567890)
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
Payment Intent ID (e.g., pi_1234567890)
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
Number of results to return (default 10, max 100)
Filter by customer ID
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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Customer ID (e.g., cus_1234567890)
Updated email address
Updated name
Updated phone number
Updated description
Updated address 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
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
Number of results to return (default 10, max 100)
Filter by email address
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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Subscription ID (e.g., sub_1234567890)
Updated array of items with price IDs
Cancel subscription at period end
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
Subscription ID (e.g., sub_1234567890)
Whether to prorate the cancellation
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
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
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
{
"$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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Invoice ID (e.g., in_1234567890)
Description of the invoice
Set of key-value pairs for storing additional information
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
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
Invoice ID (e.g., in_1234567890)
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
Invoice ID (e.g., in_1234567890)
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
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
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
Number of results to return (default 10, max 100)
Filter by customer ID
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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Charge ID (e.g., ch_1234567890)
Updated description
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
Charge ID (e.g., ch_1234567890)
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
Number of results to return (default 10, max 100)
Filter by customer ID
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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Product ID (e.g., prod_1234567890)
Updated product name
Updated product description
Updated active status
Updated array of image URLs
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
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
Number of results to return (default 10, max 100)
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
Search query using Stripe’s search query syntax
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
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
{
"$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
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
Price ID (e.g., price_1234567890)
Whether the price is active
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
Number of results to return (default 10, max 100)
Filter by product ID
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
Search query using Stripe’s search query syntax
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
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
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
{
"$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.