Stripe API
customers public
1
Node
JavaScript
Python beta
Ruby beta
Shell
curl
Hey! Want to build awesome, scalable APIs like this one?
Sign up with Standard Library today and build your own API or connect to others in seconds.
We hope you enjoy documentation for the Stripe customers API on Standard Library! This API can be used via the command line (shell), Node, Ruby, Python or as a generic HTTP call in any language. Check the code examples on the right associated with each API method for how to use this API in your language of choice.
API Description
No "description" field found in package.json
# API Documentation This file should contain documentation introducing your API to **end-users**. It will display on your service's [Standard Library](https://stdlib.com/) documentation page if you choose to publish it. Usage examples and additional information around calling your API belong here.
Create a Customer
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
address
object
The customer’s address.
optional, default value is
null
optional, current value set to
enter a test value
balance
number
An integer amount in cents that represents the customer’s current balance, which affect the customer’s future invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.
optional, default value is
null
optional, current value set to
enter a test value
coupon
string
If you provide a coupon code, the customer will have a discount applied on all recurring charges. Charges you create through the API will not have the discount.
optional, default value is
null
optional, current value set to
enter a test value
description
string
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.
optional, default value is
null
optional, current value set to
enter a test value
email
string
Customer’s email address. It’s displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to 512 characters.
optional, default value is
null
optional, current value set to
enter a test value
invoice_prefix
string
The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.
optional, default value is
null
optional, current value set to
enter a test value
invoice_settings
object
Default invoice settings for this customer.
optional, default value is
null
optional, current value set to
enter a test value
metadata
object
Set of key-value pairs that you can attach to an object.
optional, default value is
null
optional, current value set to
enter a test value
name
string
The customer’s full name or business name.
optional, default value is
null
optional, current value set to
enter a test value
payment_method
string
The ID of the PaymentMethod to attach to the customer.
optional, default value is
null
optional, current value set to
enter a test value
phone
string
The customer's phone number
optional, default value is
null
optional, current value set to
enter a test value
shipping
object
The customer’s shipping information. Appears on invoices emailed to this customer.
optional, default value is
null
optional, current value set to
enter a test value
source
any
When using payment sources created via the Token or Sources APIs, passing source will create a new source object, make it the new customer default source, and delete the old customer default if one exists. If you want to add additional sources instead of replacing the existing default, use the card creation API. Whenever you attach a card to a customer, Stripe will automatically validate the card.
optional, default value is
null
optional, current value set to
enter a test value
tax_exempt
string
The customer’s tax exemption. One of none, exempt, or reverse.
optional, default value is
null
optional, current value set to
enter a test value
tax_id_data
array
The customer’s tax IDs.
optional, default value is
null
optional, current value set to
enter a test value
Retrieve Customer details by id
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
id
string
(no description)
optional, default value is
"cus_00000000000000"
optional, current value set to
enter a test value
List Customers
Authenticated   |   Pricing  ·  Free   |   Limit  ·  no rate limit
Unauthenticated   |   Limit  ·  no rate limit
Parameters
email
string
A filter on the list based on the customer’s "email" field.
optional, default value is
null
optional, current value set to
enter a test value
created
object
A filter on the list based on the coupon "created" field.
optional, default value is
null
optional, current value set to
enter a test value
ending_before
string
A cursor for use in pagination. ending_before is an object ID that defines your place in the list.
optional, default value is
null
optional, current value set to
enter a test value
starting_after
string
A cursor for use in pagination. starting_after is an object ID that defines your place in the list.
optional, default value is
null
optional, current value set to
enter a test value
limit
number
A limit on the number of objects to be returned. Limit can range between 1 and 100.
optional, default value is
null
optional, current value set to
enter a test value
Made with by the Stripe team with the help of Standard Library.