Create a new customer

POST

https://api.agentpaid.io/api/v2/customers/

POST

/api/v2/customers/

1 import { PaidClient } from "@paid-ai/paid-node";
2 
3 async function main() {
4     const client = new PaidClient({
5         token: "YOUR_TOKEN_HERE",
6     });
7     await client.customers.createCustomer({
8         name: "Acme Corporation",
9     });
10 }
11 main();

1 {
2   "id": "cus_9f8b7c6d",
3   "name": "Acme Corporation",
4   "legalName": "Acme Corporation Ltd.",
5   "email": "contact@acmecorp.com",
6   "phone": "+1-555-123-4567",
7   "website": "https://www.acmecorp.com",
8   "externalId": "ACME-2024-001",
9   "billingAddress": {
10     "line1": "123 Elm Street",
11     "line2": "Suite 400",
12     "city": "Springfield",
13     "state": "IL",
14     "zipCode": "62704",
15     "country": "USA"
16   },
17   "creationState": "draft",
18   "status": "active",
19   "churnDate": "2024-01-15T09:30:00Z",
20   "vatNumber": "US123456789",
21   "metadata": {},
22   "defaultCurrency": "USD",
23   "connections": {
24     "stripe": {
25       "customerId": "cus_stripe_xyz"
26     }
27   },
28   "createdAt": "2024-01-15T09:30:00Z",
29   "updatedAt": "2024-01-15T09:30:00Z"
30 }

Creates a new customer for the organization

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

namestringRequired>=1 character

legalNamestring or nullOptional

emailstringOptionalformat: "email"

phonestringOptional

websitestringOptional

externalIdstring or nullOptional

billingAddressobjectOptional

creationStateenumOptional

vatNumberstring or nullOptional

metadatamap from strings to any or nullOptional

defaultCurrencystringOptional

Response

201

idstring

Stable Paid customer display ID. Use this value as the {id} path parameter for customer routes, for example GET /api/v2/customers/cus_abc123/state.

namestring

legalNamestring or null

emailstring

phonestring

websitestring

externalIdstring or null

billingAddressobject

Customer billing address, or null when no address is set.

creationStateenum

statusenum

Customer status: churned when the customer is marked as churned, active otherwise.

churnDatedatetime or null

vatNumberstring or null

metadatamap from strings to any or null

defaultCurrencystringformat: "^[A-Z]{3}$"

ISO 4217 currency code, for example USD, EUR, or GBP.

connectionsobject

Linked external system IDs for this customer.

createdAtdatetime

updatedAtdatetime

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error