Skip to main content
POST
Create Customer

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
name
string
default:""
required

Customer's name

email
string
default:""
required

Customer's email address

country
string
required

Customer's country. ISO 3166 standard alpha-2 code. eg: SG, IN, US, etc.

reference_id
string

The unique reference_id on your system representing the customer

phone
object

Phone contact details

billing_address
object[]

Customer's billing details

shipping_address
object[]

Customer's shipping details

metadata
string<json>

Set of key-value pairs that can be attached to the object (JSON string format)

Example:

"{\"key1\": \"value1\", \"key2\": \"value2\"}"

Response

200 - application/json

200

status
string

Indicates whether the request was successful.

message
string

Describes the result or status of the operation.

data
object

Contains all the details of the created customer.