Create customer

Create a new customer.

Query Params
int32
required

The unique identifier of the site associated with your account.

Body Params
string

The customer's email address, which must be valid and under the same account. The email format is validated against RFC standards and DNS validations are performed to ensure it is deliverable. When not provided, at least one of the following attributes should be present: old_provider_id or display_name. Required for accounts with an active TAP payment gateway.

boolean

When set, the DNS validations performed on the email address are skipped.

string

The customer's first name. If provided, must be a string containing a maximum of 255 characters. Required for accounts with an active TAP payment gateway.

string

The customer's last name. If provided, must be a string containing a maximum of 255 characters. Required for accounts with an active TAP payment gateway.

string

Customer phone number. Non-numeric characters are stripped. Resulting digits must be between 5 and 20.

boolean

Whether the customer has authorized receiving telemarketing communications.

boolean

Whether the customer has authorized receiving email marketing communications.

boolean

A boolean on whether delivery attempts on the customer's email address result in permanent failures (ie: hard bounces).

metadata
object

Set of key-value pairs for storing additional information about the customer in a structured format.

string

The unique identifier of this customer from the previous provider. If provided, must be unique under the same account. If email is not provided, either this attribute or display_name is required.

string

The customer's display name. If provided, must be a string containing a maximum of 100 characters. If email is not provided, either this attribute or old_provider_id is required.

string

The customer's organization. If provided, must be a string containing a maximum of 255 characters.

boolean

Whether this customer was imported from an external system.

string

The customer's tax identification number.

string

The customer password. If provided, must match the password_bcrypt algorithm format by default, unless specified otherwise via password_type attribute.

string
enum

The algorithm used on the provided password string. One of: plain_text, password_bcrypt, md5, drupal_v8.2.x, bcrypt_wordpress, crypt.

Allowed:
string

The customer's username. If provided, must be a string containing a maximum of 100 alpha-numeric characters in the ASCII range (0-9, a-z, A-Z), dashes or underscores.

string

The customer's title. If provided, must be a string containing a maximum of 255 characters.

string

The customer's salutation. If provided, must be a string containing a maximum of 255 characters.

string

The customer's time zone. If provided, must be a valid identifier or alias, see list of supported values.

string
enum

The customer's language as a two-letter code, defined by ISO 639-1 standard.

Allowed:
string

The unique identifier for customer on your current payment gateway provider (e.g. Stripe). You can pass this identifier during a migration in-order to import the customer's payment methods from the payment gateway so that you can re-create the subscriptions using the payment methods. Once imported from the gateway, you can find the default source in the customer list API endpoint which can be used to re-create the subscriptions.

boolean

A boolean on whether to import payment methods associated with the provided payment_gateway_id from the current payment gateway provider. This is used to import the payment methods during a migration in order to re-create the subscriptions using those payment methods.

This capability is only available for accounts having an active stripe payment gateway.

file

Square image, minimum 150x150px. Accepted formats: jpg, png, jpeg, jfif.

boolean

When true, marks the customer's email as verified (skips email confirmation flow).

string

The customer's billing email.

Headers
string
required
Defaults to Bearer eyJ***
Responses

Language
Credentials
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json