Create a customer

POST/v1/customers

Request

Authorization: Basic Auth

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string [{Username]}:[{Password]}

Example

Authorization: Basic YWRtaW46MTIzNDU2

address

object (Address)

optional

The customer’s address.

city

string

optional

City, district, suburb, town, or village.

country

string

optional

Two-letter country code (ISO 3166-1 alpha-2 ).

line1

string

optional

Address line 1 (e.g., street, PO Box, or company name).

line2

string

optional

Address line 2 (e.g., apartment, suite, unit, or building).

postal_code

string

optional

ZIP or postal code.

state

string

optional

State, county, province, or region.

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

string

optional

The customer’s email address.

metadata

object

optional

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.

name

string

optional

The customer’s full name or business name.

phone

string

optional

The customer’s phone number.

shipping

object

optional

Mailing and shipping address for the customer.

address

object (Address)

optional

name

string

optional

Recipient name.

phone

string

optional

Recipient phone (including extension).

invoice_prefix

string

optional

The prefix for the customer used to generate unique invoice numbers.

invoice_settings

object

optional

The customer’s default invoice settings.

custom_fields

object

optional

Default custom fields to be displayed on invoices for this customer.

default_payment_method

string

optional

ID of a payment method that’s attached to the customer, to be used as the customer’s default payment method for subscriptions and invoices.

{
  "address": {
    "city": "string",
    "country": "string",
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "state": "string"
  },
  "description": "string",
  "email": "string",
  "metadata": {},
  "name": "string",
  "phone": "string",
  "shipping": {
    "address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "name": "string",
    "phone": "string"
  },
  "invoice_prefix": "string",
  "invoice_settings": {
    "custom_fields": {
      "name": "string",
      "value": "string"
    },
    "default_payment_method": "string"
  }
}

Request samples

Responses

OK(200)

HTTP Code: 200

Content Type : JSONapplication/json

string

optional

Unique identifier for the object, like "cus_XXX".

object

string

optional

'customer'

address

object (Address)

optional

The customer’s address.

city

string

optional

City, district, suburb, town, or village.

country

string

optional

Two-letter country code (ISO 3166-1 alpha-2 ).

line1

string

optional

Address line 1 (e.g., street, PO Box, or company name).

line2

string

optional

Address line 2 (e.g., apartment, suite, unit, or building).

postal_code

string

optional

ZIP or postal code.

state

string

optional

State, county, province, or region.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO code for the currency the customer can be charged in for recurring billing purposes.

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

string

optional

The customer’s email address.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

metadata

object

optional

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.

name

string

optional

The customer’s full name or business name.

phone

string

optional

The customer’s phone number.

preferred_locales

array[string]

optional

The customer’s preferred locales (languages), ordered by preference.

shipping

object

optional

Mailing and shipping address for the customer.

address

object (Address)

optional

name

string

optional

Recipient name.

phone

string

optional

Recipient phone (including extension).

{
  "id": "string",
  "object": "string",
  "address": {
    "city": "string",
    "country": "string",
    "line1": "string",
    "line2": "string",
    "postal_code": "string",
    "state": "string"
  },
  "created": 0,
  "currency": "string",
  "description": "string",
  "email": "string",
  "livemode": true,
  "metadata": {},
  "name": "string",
  "phone": "string",
  "preferred_locales": [
    "string"
  ],
  "shipping": {
    "address": {
      "city": "string",
      "country": "string",
      "line1": "string",
      "line2": "string",
      "postal_code": "string",
      "state": "string"
    },
    "name": "string",
    "phone": "string"
  }
}

Last modified: 1 年前