POST /v1/customers
Creates a new customer object.
Servers
- https://api.stripe.com/
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
source |
String | No | |
tax |
Object | No |
Tax details about the customer. |
tax.validate_location |
String | No |
Possible values:
|
tax.ip_address |
No | ||
description |
String | No |
An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
No |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
payment_method |
String | No | |
next_invoice_sequence |
Integer | No |
The sequence to be used on the customer's next invoice. Defaults to 1. |
email |
String | No |
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. |
name |
String | No |
The customer's full name or business name. |
test_clock |
String | No |
ID of the test clock to attach to the customer. |
cash_balance |
Object | No |
Balance information and default balance settings for this customer. |
cash_balance.settings |
Object | No | |
cash_balance.settings.reconciliation_mode |
String | No |
Possible values:
|
invoice_prefix |
String | No |
The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers. |
phone |
String | No |
The customer's phone number. |
balance |
Integer | No |
An integer amount in cents (or local equivalent) 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. |
shipping |
No |
The customer's shipping information. Appears on invoices emailed to this customer. |
|
preferred_locales[] |
Array | No |
Customer's preferred languages, ordered by preference. |
tax_id_data[] |
Array | No |
The customer's tax IDs. |
tax_id_data[].type |
String | Yes |
Possible values:
|
tax_id_data[].value |
String | Yes | |
address |
No |
The customer's address. |
|
tax_exempt |
String | No |
The customer's tax exemption. One of Possible values:
|
invoice_settings |
Object | No |
Default invoice settings for this customer. |
invoice_settings.default_payment_method |
String | No | |
invoice_settings.rendering_options |
No | ||
invoice_settings.custom_fields |
No | ||
invoice_settings.footer |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.