Create a new customer | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.createCustomer({
        name: "Acme Corporation",
    });
}
main();

{
  "id": "a1b2c3d4-e5f6-7890-ab12-cd34ef56gh78",
  "name": "Acme Corporation",
  "legalName": "Acme Corporation Ltd.",
  "email": "contact@acmecorp.com",
  "phone": "+1-555-123-4567",
  "website": "https://www.acmecorp.com",
  "externalId": "ACME-2024-001",
  "creationState": "draft",
  "churnDate": "2024-01-15T09:30:00Z",
  "vatNumber": "US123456789",
  "metadata": {},
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "billingAddress": {
    "line1": "123 Elm Street",
    "line2": "Suite 400",
    "city": "Springfield",
    "state": "IL",
    "zipCode": "62704",
    "country": "USA"
  }
}

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

Allowed values:

vatNumberstring or nullOptional

metadatamap from strings to any or nullOptional

Response

201

idstring

namestring

legalNamestring or null

emailstring

phonestring

websitestring

externalIdstring or null

creationStateenum

Allowed values:

churnDatedatetime or null

vatNumberstring or null

metadatamap from strings to any or null

createdAtdatetime

updatedAtdatetime

billingAddressobject or null

Authentication

Request

Response

Errors