Skip to main content
POST
/
customers
Create a customer
curl --request POST \
  --url https://api.notchpay.co/customers \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "john@example.com",
  "phone": 237600000000,
  "name": "John Doe",
  "company_name": "ACME Inc",
  "metadata": {},
  "address": {
    "country": "CM",
    "state": "<string>",
    "city": "Douala",
    "postal_code": "<string>",
    "address_line1": "123 Main St",
    "address_line2": "<string>"
  },
  "billing": {
    "country": "CM",
    "state": "<string>",
    "city": "Douala",
    "postal_code": "<string>",
    "address_line1": "123 Main St",
    "address_line2": "<string>"
  }
}'
{
  "code": 201,
  "status": "Created",
  "message": "Customer created successfully",
  "customer": {
    "id": "cus_123456789",
    "name": "John Doe",
    "email": "john@example.com",
    "phone": 237600000000,
    "company_name": "ACME Inc",
    "address": {
      "country": "CM",
      "city": "Douala",
      "address_line1": "123 Main St"
    },
    "created_at": "2023-01-01T12:00:00.000Z",
    "updated_at": "2023-01-02T12:00:00.000Z",
    "blocked": false
  }
}

Authorizations

​
Authorization
string
header
required

Body

application/json
  • Option 1
  • Option 2
​
email
string
required
Example:

"john@example.com"

​
phone
string
Example:

237600000000

​
name
string
Example:

"John Doe"

​
company_name
string
Example:

"ACME Inc"

​
metadata
object
​
address
object
​
billing
object

Response

Customer created

​
code
integer
required
Example:

201

​
status
string
required
Example:

"Created"

​
message
string
required
Example:

"Customer created successfully"

​
customer
any
required