stripe_list_invoices
Pack: stripe_connect · Endpoint: https://gateway.pipeworx.io/stripe_connect/mcp
List invoices.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
_apiKey | string | yes | Stripe secret or restricted API key (sk_…) |
limit | number | no | Max results (1-100, default 10) |
customer | string | no | Filter by customer ID |
status | string | no | Filter by status (draft, open, paid, void, uncollectible) |
Example call
Arguments
{
"_apiKey": "your-stripe_connect-api-key",
"status": "paid",
"limit": 30
}curl
curl -X POST https://gateway.pipeworx.io/stripe_connect/mcp \
-H 'Content-Type: application/json' \
-d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"stripe_list_invoices","arguments":{"_apiKey":"your-stripe_connect-api-key","status":"paid","limit":30}}}'TypeScript (@pipeworx/sdk)
import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();
const result = await pipeworx.call('stripe_list_invoices', {
"_apiKey": "your-stripe_connect-api-key",
"status": "paid",
"limit": 30
});More examples
{
"_apiKey": "your-stripe_connect-api-key",
"customer": "cus_ABC123",
"status": "open"
}Response shape
| Field | Type | Description |
|---|---|---|
object | string | Object type (list) |
data | array | Array of invoice objects |
has_more | boolean | Whether more results exist |
url | string | API endpoint URL |
Full JSON Schema
{
"type": "object",
"properties": {
"object": {
"type": "string",
"description": "Object type (list)"
},
"data": {
"type": "array",
"description": "Array of invoice objects",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Invoice ID"
},
"object": {
"type": "string",
"description": "Object type (invoice)"
},
"account_country": {
"type": [
"string",
"null"
],
"description": "Account country"
},
"account_name": {
"type": [
"string",
"null"
],
"description": "Account name"
},
"account_tax_ids": {
"type": [
"array",
"null"
],
"description": "Account tax IDs"
},
"amount_due": {
"type": "integer",
"description": "Amount due in cents"
},
"amount_paid": {
"type": "integer",
"description": "Amount paid in cents"
},
"amount_remaining": {
"type": "integer",
"description": "Amount remaining in cents"
},
"application": {
"type": [
"string",
"null"
],
"description": "Application ID"
},
"application_fee": {
"type": [
"string",
"null"
],
"description": "Application fee ID"
},
"attempt_count": {
"type": "integer",
"description": "Attempt count"
},
"attempted": {
"type": "boolean",
"description": "Collection attempted"
},
"auto_advance": {
"type": "boolean",
"description": "Auto advance setting"
},
"automatic_tax": {
"type": "object",
"description": "Automatic tax settings"
},
"billing_reason": {
"type": [
"string",
"null"
],
"description": "Billing reason"
},
"charge": {
"type": [
"string",
"null"
],
"description": "Charge ID"
},
"collection_method": {
"type": "string",
"description": "Collection method"
},
"created": {
"type": "integer",
"description": "Creation timestamp"
},
"currency": {
"type": "string",
"description": "Currency code"
},
"custom_fields": {
"type": [
"array",
"null"
],
"description": "Custom fields"
},
"customer": {
"type": [
"string",
"null"
],
"description": "Customer ID"
},
"customer_address": {
"type": [
"object",
"null"
],
"description": "Customer address"
},
"customer_email": {
"type": [
"string",
"null"
],
"description": "Customer email"
},
"customer_name": {
"type": [
"string",
"null"
],
"description": "Customer name"
},
"customer_phone": {
"type": [
"string",
"null"
],
"description": "Customer phone"
},
"customer_shipping": {
"type": [
"object",
"null"
],
"description": "Customer shipping"
},
"customer_tax_exempt": {
"type": "string",
"description": "Customer tax exempt status"
},
"customer_tax_ids": {
"type": "array",
"description": "Customer tax IDs"
},
"default_payment_method": {
"type": [
"string",
"null"
],
"description": "Default payment method"
},
"default_source": {
"type": [
"string",
"null"
],
"description": "Default source ID"
},
"default_tax_rates": {
"type": "array",
"description": "Default tax rates"
},
"description": {
"type": [
"string",
"null"
],
"description": "Invoice description"
},
"discount": {
"type": [
"object",
"null"
],
"description": "Applied discount"
},
"discounts": {
"type": "array",
"description": "Applied discounts"
},
"due_date": {
"type": [
"integer",
"null"
],
"description": "Due date timestamp"
},
"ending_balance": {
"type": [
"integer",
"null"
],
"description": "Ending balance"
},
"footer": {
"type": [
"string",
"null"
],
"description": "Invoice footer"
},
"from_invoice": {
"type": [
"string",
"null"
],
"description": "From invoice ID"
},
"hosted_invoice_url": {
"type": [
"string",
"null"
],
"description": "Hosted invoice URL"
},
"invoice_pdf": {
"type": [
"string",
"null"
],
"description": "Invoice PDF URL"
},
"last_finalization_error": {
"type": [
"object",
"null"
],
"description": "Last finalization error"
},
"latest_revision": {
"type": [
"string",
"null"
],
"description": "Latest revision ID"
},
"lines": {
"type": "object",
"description": "Invoice line items"
},
"livemode": {
"type": "boolean",
"description": "Live mode"
},
"metadata": {
"type": "object",
"description": "Custom metadata"
},
"next_payment_attempt": {
"type": [
"integer",
"null"
],
"description": "Next payment attempt timestamp"
},
"number": {
"type": [
"string",
"null"
],
"description": "Invoice number"
},
"on_behalf_of": {
"type": [
"string",
"null"
],
"description": "On behalf of account ID"
},
"paid": {
"type": "boolean",
"description": "Invoice paid"
},
"paid_out_of_band": {
"type": "boolean",
"description": "Paid out of band"
},
"payment_intent": {
"type": [
"string",
"null"
],
"description": "Payment intent ID"
},
"payment_settings": {
"type": "object",
"description": "Payment settings"
},
"period_end": {
"type": "integer",
"description": "Period end timestamp"
},
"period_start": {
"type": "integer",
"description": "Period start timestamp"
},
"post_payment_credit_notes_amount": {
"type": "integer",
"description": "Post-payment credit notes amount"
},
"pre_payment_credit_notes_amount": {
"type": "integer",
"description": "Pre-payment credit notes amount"
},
"quote": {
"type": [
"string",
"null"
],
"description": "Quote ID"
},
"receipt_number": {
"type": [
"string",
"null"
],
"description": "Receipt number"
},
"rendering": {
"type": [
"object",
"null"
],
"description": "Rendering options"
},
"rendering_options": {
"type": [
"object",
"null"
],
"description": "Rendering options"
},
"revisions": {
"type": "object",
"description": "Revisions list"
},
"scheduled_for_cancellation": {
"type": "boolean",
"description": "Scheduled for cancellation"
},
"starting_balance": {
"type": "integer",
"description": "Starting balance"
},
"statement_descriptor": {
"type": [
"string",
"null"
],
"description": "Statement descriptor"
},
"status": {
"type": [
"string",
"null"
],
"description": "Invoice status"
},
"status_transitions": {
"type": "object",
"description": "Status transitions"
},
"subscription": {
"type": [
"string",
"null"
],
"description": "Subscription ID"
},
"subtotal": {
"type": "integer",
"description": "Subtotal in cents"
},
"subtotal_excluding_tax": {
"type": [
"integer",
"null"
],
"description": "Subtotal excluding tax"
},
"tax": {
"type": [
"integer",
"null"
],
"description": "Tax amount in cents"
},
"test_clock": {
"type": [
"string",
"null"
],
"description": "Test clock ID"
},
"total": {
"type": "integer",
"description": "Total in cents"
},
"total_discount_amounts": {
"type": "array",
"description": "Total discount amounts"
},
"total_excluding_tax": {
"type": [
"integer",
"null"
],
"description": "Total excluding tax"
},
"total_tax_amounts": {
"type": "array",
"description": "Total tax amounts"
},
"transfer_data": {
"type": [
"object",
"null"
],
"description": "Transfer data"
},
"url": {
"type": [
"string",
"null"
],
"description": "Invoice URL"
},
"use_inclusive_taxing": {
"type": "boolean",
"description": "Use inclusive taxing"
},
"webhooks_delivered_at": {
"type": [
"integer",
"null"
],
"description": "Webhooks delivered timestamp"
}
}
}
},
"has_more": {
"type": "boolean",
"description": "Whether more results exist"
},
"url": {
"type": "string",
"description": "API endpoint URL"
}
}
}Connect
Add this to your MCP client config, or use one-click install buttons:
{
"mcpServers": {
"stripe_connect": {
"url": "https://gateway.pipeworx.io/stripe_connect/mcp"
}
}
}See Getting Started for client-specific install steps.