stripe_get_customer

Pack: stripe_connect · Endpoint: https://gateway.pipeworx.io/stripe_connect/mcp

Get a Stripe customer by ID.

Parameters

NameTypeRequiredDescription
_apiKeystringyesStripe secret or restricted API key (sk_…)
idstringyesCustomer ID (cus_…)

Example call

Arguments

{
  "_apiKey": "your-stripe_connect-api-key",
  "id": "cus_ABC123"
}

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_get_customer","arguments":{"_apiKey":"your-stripe_connect-api-key","id":"cus_ABC123"}}}'

TypeScript (@pipeworx/sdk)

import { Pipeworx } from '@pipeworx/sdk';
const pipeworx = new Pipeworx();

const result = await pipeworx.call('stripe_get_customer', {
  "_apiKey": "your-stripe_connect-api-key",
  "id": "cus_ABC123"
});

Response shape

FieldTypeDescription
idstringCustomer ID
objectstringObject type (customer)
addressobject | nullCustomer address
balanceintegerAccount balance in cents
createdintegerCreation timestamp
currencystring | nullCustomer currency
default_sourcestring | nullDefault payment source ID
delinquentbooleanAccount delinquent status
descriptionstring | nullCustomer description
discountobject | nullApplied discount
emailstring | nullCustomer email
invoice_prefixstringInvoice prefix
invoice_settingsobjectInvoice settings
livemodebooleanLive mode indicator
metadataobjectCustom metadata
namestring | nullCustomer name
phonestring | nullCustomer phone
preferred_localesarrayPreferred locales
shippingobject | nullShipping address
tax_exemptstringTax exempt status
test_clockstring | nullTest clock ID
Full JSON Schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Customer ID"
    },
    "object": {
      "type": "string",
      "description": "Object type (customer)"
    },
    "address": {
      "type": [
        "object",
        "null"
      ],
      "description": "Customer address"
    },
    "balance": {
      "type": "integer",
      "description": "Account balance in cents"
    },
    "created": {
      "type": "integer",
      "description": "Creation timestamp"
    },
    "currency": {
      "type": [
        "string",
        "null"
      ],
      "description": "Customer currency"
    },
    "default_source": {
      "type": [
        "string",
        "null"
      ],
      "description": "Default payment source ID"
    },
    "delinquent": {
      "type": "boolean",
      "description": "Account delinquent status"
    },
    "description": {
      "type": [
        "string",
        "null"
      ],
      "description": "Customer description"
    },
    "discount": {
      "type": [
        "object",
        "null"
      ],
      "description": "Applied discount"
    },
    "email": {
      "type": [
        "string",
        "null"
      ],
      "description": "Customer email"
    },
    "invoice_prefix": {
      "type": "string",
      "description": "Invoice prefix"
    },
    "invoice_settings": {
      "type": "object",
      "description": "Invoice settings"
    },
    "livemode": {
      "type": "boolean",
      "description": "Live mode indicator"
    },
    "metadata": {
      "type": "object",
      "description": "Custom metadata"
    },
    "name": {
      "type": [
        "string",
        "null"
      ],
      "description": "Customer name"
    },
    "phone": {
      "type": [
        "string",
        "null"
      ],
      "description": "Customer phone"
    },
    "preferred_locales": {
      "type": "array",
      "description": "Preferred locales"
    },
    "shipping": {
      "type": [
        "object",
        "null"
      ],
      "description": "Shipping address"
    },
    "tax_exempt": {
      "type": "string",
      "description": "Tax exempt status"
    },
    "test_clock": {
      "type": [
        "string",
        "null"
      ],
      "description": "Test clock ID"
    }
  }
}

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.

Regenerated from source · build May 9, 2026