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": "c3f1a9e2-8b4d-4f7a-9d2e-1a2b3c4d5e6f",
  "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": {},
  "defaultCurrency": "USD",
  "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

defaultCurrencystringOptional

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

defaultCurrencystring

createdAtdatetime

updatedAtdatetime

billingAddressobject

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error