Stripe

Stripe Customers API

This object represents a customer of your business. Use it to create recurring charges and track payments that belong to the same customer.

GitHub OpenAPI

Operations 47

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/customers List customers · Get customers #
Ask an LLM
“How do I pull a list of all my customers, newest first?”
“Can I look up customers by email address when listing them?”
Tell an agent
List my most recent customers.
List customers with the email {email}.
POST /v1/customers Create a customer · Post customers #
Ask an LLM
“How do I add a new customer record in Stripe?”
“Can I attach a payment method when I create a customer?”
Tell an agent
Create a customer named {name} with email {email}.
Add a new customer with phone number {phone}.
GET /v1/customers/search Search customers with a query · Get customers search #
Ask an LLM
“How do I search my customers by name, email or metadata?”
“Is customer search safe to use right after I create a customer?”
Tell an agent
Search customers matching {query}.
Find customers where {query} and return the next page {page}.
DELETE /v1/customers/{customer} Permanently delete a customer · Delete customers customer #
Ask an LLM
“How do I permanently remove a customer?”
“What happens to a customer's active subscriptions when I delete them?”
Tell an agent destructive · confirm first
Delete customer {customer} permanently.
Remove customer {customer} and cancel their active subscriptions.
GET /v1/customers/{customer} Retrieve a customer · Get customers customer #
Ask an LLM
“How do I fetch the full details of one customer?”
“What information comes back when I look up a single customer?”
Tell an agent
Get customer {customer}.
Show me the details on file for customer {customer}.
POST /v1/customers/{customer} Update a customer's details · Post customers customer #
Ask an LLM
“How do I change a customer's email or address?”
“Can I set a different default payment source for an existing customer?”
Tell an agent
Change the email of customer {customer} to {email}.
Update customer {customer}'s name to {name}.
GET /v1/customers/{customer}/balance_transactions List a customer's credit balance changes · Get customers customer balance transactions #
Ask an LLM
“How do I see every change made to a customer's credit balance?”
“Where can I audit credits and debits applied to a customer's account balance?”
Tell an agent
List the balance transactions for customer {customer}.
Show the last {limit} credit balance changes for customer {customer}.
POST /v1/customers/{customer}/balance_transactions Adjust a customer's credit balance · Post customers customer balance transactions #
Ask an LLM
“How do I give a customer account credit?”
“Can I change a credit balance transaction after I create it?”
Tell an agent
Credit customer {customer} with {amount} in {currency}.
Add a balance adjustment of {amount} {currency} to customer {customer} noting {description}.
GET /v1/customers/{customer}/balance_transactions/{transaction} Retrieve one customer balance transaction · Get customers customer balance transactions transaction #
Ask an LLM
“How do I look up a single credit balance adjustment for a customer?”
“Can I see the details of one specific customer balance change?”
Tell an agent
Get balance transaction {transaction} for customer {customer}.
Show me credit adjustment {transaction} on customer {customer}.
POST /v1/customers/{customer}/balance_transactions/{transaction} Edit a customer balance transaction's note · Post customers customer balance transactions transaction #
Ask an LLM
“Which fields of a customer balance transaction can I still edit?”
“Can I relabel a credit adjustment with a better description?”
Tell an agent
Change the description of balance transaction {transaction} on customer {customer} to {description}.
Update the metadata on customer {customer}'s balance transaction {transaction}.
GET /v1/customers/{customer}/bank_accounts List a customer's bank accounts · Get customers customer bank accounts #
Ask an LLM
“How do I see which bank accounts a customer has saved?”
“Are all of a customer's bank accounts shown on the customer record?”
Tell an agent
List the bank accounts saved for customer {customer}.
Show up to {limit} bank accounts belonging to customer {customer}.
POST /v1/customers/{customer}/bank_accounts Add a bank account to a customer · Post customers customer bank accounts #
Ask an LLM
“How do I save a bank account on a customer from a token?”
“Does adding a bank account to a customer make it their default?”
Tell an agent
Attach bank account token {bank_account} to customer {customer}.
Save a new bank account for customer {customer} using source {source}.
DELETE /v1/customers/{customer}/bank_accounts/{id} Remove a customer's bank account · Delete customers customer bank accounts id #
Ask an LLM
“How do I delete a bank account a customer no longer uses?”
“Can I detach a saved bank account from a customer?”
Tell an agent destructive · confirm first
Delete bank account {id} from customer {customer}.
Remove customer {customer}'s saved bank account {id}.
GET /v1/customers/{customer}/bank_accounts/{id} Retrieve a customer's bank account · Get customers customer bank accounts id #
Ask an LLM
“How do I get the details of one bank account a customer saved?”
“Can I look up a customer's older bank account that isn't in the recent list?”
Tell an agent
Get bank account {id} for customer {customer}.
Show me customer {customer}'s bank account {id}.
POST /v1/customers/{customer}/bank_accounts/{id} Update a customer's bank account · Post customers customer bank accounts id #
Ask an LLM
“How do I fix the account holder name on a customer's bank account?”
“Can I change whether a saved bank account belongs to an individual or a company?”
Tell an agent
Set the account holder name on bank account {id} for customer {customer} to {account_holder_name}.
Mark bank account {id} of customer {customer} as holder type {account_holder_type}.
POST /v1/customers/{customer}/bank_accounts/{id}/verify Verify a customer's bank account · Post customers customer bank accounts id verify #
Ask an LLM
“How do I verify a customer's bank account with the micro-deposit amounts?”
“What do I need to confirm a customer's bank account before charging it?”
Tell an agent
Verify bank account {id} for customer {customer} with deposit amounts {amounts}.
Confirm customer {customer}'s bank account {id} using the two micro-deposits {amounts}.
GET /v1/customers/{customer}/cards List a customer's cards · Get customers customer cards #
Ask an LLM
“How do I list every card a customer has saved?”
“Can I get more than the ten most recent cards for a customer?”
Tell an agent
List the cards on file for customer {customer}.
Show {limit} saved cards for customer {customer}.
POST /v1/customers/{customer}/cards Add a card to a customer · Post customers customer cards #
Ask an LLM
“How do I save a new card on a customer?”
“Does a new card become the default if the customer has none?”
Tell an agent
Add card {card} to customer {customer}.
Save the card from token {source} on customer {customer}.
DELETE /v1/customers/{customer}/cards/{id} Remove a customer's card · Delete customers customer cards id #
Ask an LLM
“How do I delete a card from a customer's account?”
“Can I remove an expired card a customer no longer uses?”
Tell an agent destructive · confirm first
Delete card {id} from customer {customer}.
Remove the saved card {id} on customer {customer}.
GET /v1/customers/{customer}/cards/{id} Retrieve a customer's card · Get customers customer cards id #
Ask an LLM
“How do I get details about one specific card a customer saved?”
“Can I look up a customer's card by its ID?”
Tell an agent
Get card {id} for customer {customer}.
Show me the saved card {id} on customer {customer}.
POST /v1/customers/{customer}/cards/{id} Update a customer's card · Post customers customer cards id #
Ask an LLM
“How do I update the expiry date on a customer's saved card?”
“Can I change the billing address on a card a customer already saved?”
Tell an agent
Update card {id} on customer {customer} to expire {exp_month}/{exp_year}.
Set the billing ZIP of customer {customer}'s card {id} to {address_zip}.
GET /v1/customers/{customer}/cash_balance Retrieve a customer's cash balance · Get customers customer cash balance #
Ask an LLM
“How much cash balance does a customer currently hold?”
“Where do I check funds a customer has sent by bank transfer?”
Tell an agent
Get the cash balance for customer {customer}.
Show how much unapplied cash customer {customer} has.
POST /v1/customers/{customer}/cash_balance Change a customer's cash balance settings · Post customers customer cash balance #
Ask an LLM
“How do I control how a customer's cash balance gets applied to payments?”
“Can I change the reconciliation settings on a customer's cash balance?”
Tell an agent
Update the cash balance settings of customer {customer} to {settings}.
Switch customer {customer}'s cash balance reconciliation using settings {settings}.
GET /v1/customers/{customer}/cash_balance_transactions List a customer's cash balance activity · Get customers customer cash balance transactions #
Ask an LLM
“How do I see the history of funds added to or applied from a customer's cash balance?”
“Can I list every change to a customer's cash balance?”
Tell an agent
List cash balance transactions for customer {customer}.
Show the latest {limit} cash balance movements for customer {customer}.
GET /v1/customers/{customer}/cash_balance_transactions/{transaction} Retrieve one cash balance transaction · Get customers customer cash balance transactions transaction #
Ask an LLM
“How do I look up one specific movement on a customer's cash balance?”
“Can I see what a single cash balance transaction was applied to?”
Tell an agent
Get cash balance transaction {transaction} for customer {customer}.
Show me cash movement {transaction} on customer {customer}'s balance.
DELETE /v1/customers/{customer}/discount Remove a customer's discount · Delete customers customer discount #
Ask an LLM
“How do I take a discount off a customer?”
“Can I end a coupon that's applied to a customer's account?”
Tell an agent destructive · confirm first
Remove the discount from customer {customer}.
Delete the coupon currently applied to customer {customer}.
GET /v1/customers/{customer}/discount Retrieve a customer's discount · Get customers customer discount #
Ask an LLM
“How do I check which discount is applied to a customer?”
“Does this customer currently have a coupon applied?”
Tell an agent
Get the discount applied to customer {customer}.
Show the active coupon discount on customer {customer}.
POST /v1/customers/{customer}/funding_instructions Get bank transfer instructions for a customer · Post customers customer funding instructions #
Ask an LLM
“How do I give a customer bank details to fund their cash balance?”
“Which currency can I request bank transfer funding instructions in?”
Tell an agent
Get bank transfer funding instructions for customer {customer} in {currency}.
Create funding instructions of type {funding_type} for customer {customer}.
GET /v1/customers/{customer}/payment_methods List a customer's payment methods · Get customers customer payment methods #
Ask an LLM
“How do I see every payment method saved for a customer?”
“Can I list only a customer's cards or only one payment method type?”
Tell an agent
List payment methods for customer {customer}.
Show customer {customer}'s saved payment methods of type {type}.
GET /v1/customers/{customer}/payment_methods/{payment_method} Retrieve a customer's payment method · Get customers customer payment methods payment method #
Ask an LLM
“How do I get a specific PaymentMethod belonging to a customer?”
“Can I confirm a PaymentMethod actually belongs to a given customer?”
Tell an agent
Get payment method {payment_method} for customer {customer}.
Check PaymentMethod {payment_method} on customer {customer}.
GET /v1/customers/{customer}/sources List a customer's payment sources · Get customers customer sources #
Ask an LLM
“How do I list all the payment sources on a customer?”
“Can I list only one kind of source, like bank accounts, for a customer?”
Tell an agent
List payment sources for customer {customer}.
Show customer {customer}'s sources of object type {object}.
POST /v1/customers/{customer}/sources Attach a payment source to a customer · Post customers customer sources #
Ask an LLM
“How do I attach a source or token to an existing customer?”
“What happens to the default source when I attach a new one?”
Tell an agent
Attach source {source} to customer {customer}.
Add a payment source to customer {customer} with metadata {metadata}.
DELETE /v1/customers/{customer}/sources/{id} Detach a customer's payment source · Delete customers customer sources id #
Ask an LLM
“How do I detach a payment source from a customer?”
“Can I remove any kind of saved source from a customer, not only cards?”
Tell an agent destructive · confirm first
Detach source {id} from customer {customer}.
Delete payment source {id} belonging to customer {customer}.
GET /v1/customers/{customer}/sources/{id} Retrieve a customer's payment source · Get customers customer sources id #
Ask an LLM
“How do I fetch one payment source attached to a customer?”
“Can I look up any source on a customer, not just cards?”
Tell an agent
Get source {id} for customer {customer}.
Show payment source {id} attached to customer {customer}.
POST /v1/customers/{customer}/sources/{id} Update a customer's payment source · Post customers customer sources id #
Ask an LLM
“How do I update the owner details on a customer's payment source?”
“Can I change the billing address stored on a customer's source?”
Tell an agent
Update the owner of source {id} on customer {customer} to {owner}.
Set the billing country of customer {customer}'s source {id} to {address_country}.
POST /v1/customers/{customer}/sources/{id}/verify Verify a customer's bank source · Post customers customer sources id verify #
Ask an LLM
“How do I verify a bank account source using micro-deposits?”
“What amounts do I send to verify a customer's bank source?”
Tell an agent
Verify source {id} on customer {customer} with amounts {amounts}.
Complete micro-deposit verification of source {id} for customer {customer} using {amounts}.
GET /v1/customers/{customer}/subscriptions List a customer's subscriptions · Get customers customer subscriptions #
Ask an LLM
“How do I see which active subscriptions a customer has?”
“Can I list more than the ten subscriptions shown on the customer?”
Tell an agent
List active subscriptions for customer {customer}.
Show {limit} of customer {customer}'s subscriptions.
POST /v1/customers/{customer}/subscriptions Subscribe a customer to a plan · Post customers customer subscriptions #
Ask an LLM
“How do I start a subscription for an existing customer?”
“Can I give a customer a free trial when I subscribe them?”
Tell an agent
Subscribe customer {customer} to items {items}.
Start a subscription for customer {customer} with a {trial_period_days}-day trial on {items}.
DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id} Cancel a customer's subscription · Delete customers customer subscriptions subscription exposed id #
Ask an LLM
“How do I cancel a customer's subscription?”
“Can I invoice the customer for pending usage when I cancel their subscription?”
Tell an agent destructive · confirm first
Cancel subscription {subscription_exposed_id} for customer {customer}.
Cancel customer {customer}'s subscription {subscription_exposed_id} and invoice now: {invoice_now}.
GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id} Retrieve a customer's subscription · Get customers customer subscriptions subscription exposed id #
Ask an LLM
“How do I look up one subscription belonging to a customer?”
“Can I check a customer's subscription status by its ID?”
Tell an agent
Get subscription {subscription_exposed_id} for customer {customer}.
Show customer {customer}'s subscription {subscription_exposed_id}.
POST /v1/customers/{customer}/subscriptions/{subscription_exposed_id} Change a customer's subscription · Post customers customer subscriptions subscription exposed id #
Ask an LLM
“How do I upgrade or change the plan on a customer's subscription?”
“Can I control proration when I change a customer's subscription?”
Tell an agent
Change subscription {subscription_exposed_id} for customer {customer} to items {items}.
Set customer {customer}'s subscription {subscription_exposed_id} to cancel at period end: {cancel_at_period_end}.
DELETE /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount Remove a subscription's discount · Delete customers customer subscriptions subscription exposed id discount #
Ask an LLM
“How do I take a coupon off one of a customer's subscriptions?”
“Can I remove a discount from a subscription without touching the customer's other discounts?”
Tell an agent destructive · confirm first
Remove the discount from subscription {subscription_exposed_id} of customer {customer}.
Delete the coupon on customer {customer}'s subscription {subscription_exposed_id}.
GET /v1/customers/{customer}/subscriptions/{subscription_exposed_id}/discount Retrieve a subscription's discount · Get customers customer subscriptions subscription exposed id discount #
Ask an LLM
“How do I see the discount applied to one of a customer's subscriptions?”
“Is there a coupon on this particular subscription?”
Tell an agent
Get the discount on subscription {subscription_exposed_id} for customer {customer}.
Show which coupon applies to customer {customer}'s subscription {subscription_exposed_id}.
GET /v1/customers/{customer}/tax_ids List a customer's tax IDs · Get customers customer tax ids #
Ask an LLM
“How do I see the VAT or tax IDs stored for a customer?”
“Can a customer have more than one tax ID on file?”
Tell an agent
List tax IDs for customer {customer}.
Show all tax registration numbers saved on customer {customer}.
POST /v1/customers/{customer}/tax_ids Add a tax ID to a customer · Post customers customer tax ids #
Ask an LLM
“How do I add a VAT number to a customer so it shows on invoices?”
“Which tax ID types can I store on a customer?”
Tell an agent
Add tax ID {value} of type {type} to customer {customer}.
Save {type} number {value} on customer {customer}.
DELETE /v1/customers/{customer}/tax_ids/{id} Delete a customer's tax ID · Delete customers customer tax ids id #
Ask an LLM
“How do I remove an outdated tax ID from a customer?”
“Can I delete a VAT number I added to a customer by mistake?”
Tell an agent destructive · confirm first
Delete tax ID {id} from customer {customer}.
Remove the tax registration {id} on customer {customer}.
GET /v1/customers/{customer}/tax_ids/{id} Retrieve a customer's tax ID · Get customers customer tax ids id #
Ask an LLM
“How do I look up one tax ID stored on a customer?”
“Can I check the verification status of a customer's tax ID?”
Tell an agent
Get tax ID {id} for customer {customer}.
Show customer {customer}'s tax ID record {id}.

Documentation

📖
Documentation
https://stripe.com/docs/api/customers
📖
APIReference
https://docs.stripe.com/api/customers

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-customers-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/overlays/stripe-customers-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/stripe-customers-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

stripe-customers-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Stripe Customers API
  description: Needs description.
  contact:
    email: dev-platform@stripe.com
    name: Stripe Dev Platform Team
    url: https://stripe.com
  termsOfService: https://stripe.com/us/terms/
  version: '2023-10-16'
  x-stripeSpecFilename: spec3
servers:
- url: https://api.stripe.com/
security:
- basicAuth: []
- bearerAuth: []
tags:


# --- truncated at 32 KB (268 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/stripe/refs/heads/main/openapi/stripe-customers-api-openapi.yml