Skip to main content
POST
/
v1
/
billing
/
customers
curl
curl -X POST https://api.paybridgenp.com/v1/billing/customers \
  -H "Authorization: Bearer pk_sandbox_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Aarav Sharma",
    "email": "aarav@example.com",
    "externalCustomerId": "user_abc123"
  }'
{
  "id": "bc_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "livemode": true,
  "name": "Aarav Sharma",
  "email": "aarav@example.com",
  "phone": "9801234567",
  "externalCustomerId": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.paybridgenp.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Your PayBridge API key. Obtain one from the dashboard under Settings → API Keys. Prefix: pk_sandbox_ for testing, pk_live_ for production.

Body

application/json
​
name
string
required
Example:

"Aarav Sharma"

​
email
string<email> | null
Example:

"aarav@example.com"

​
phone
string | null
Maximum string length: 20
Example:

"9801234567"

​
externalCustomerId
string | null

Your internal customer ID (for cross-referencing).

Example:

"user_abc123"

​
metadata
object

Response

Customer created.

​
id
string
Example:

"bc_01j9x2k3m4n5p6q7r8s9t0u1v2"

​
livemode
boolean

true when created with a live key, false for sandbox.

​
name
string
Example:

"Aarav Sharma"

​
email
string<email> | null
Example:

"aarav@example.com"

​
phone
string | null
Example:

"9801234567"

​
externalCustomerId
string | null

Your internal customer ID for cross-referencing.

​
metadata
object
​
createdAt
string<date-time>
​
updatedAt
string<date-time>