Create a new customer | Paid

import { PaidClient } from "@paid-ai/paid-node";
async function main() {
    const client = new PaidClient({
        environment: "https://api.agentpaid.io/api/v1",
        token: "YOUR_TOKEN_HERE",
    });
    await client.customers.create({
        name: "Acme, Inc.",
        externalId: "acme-inc",
        contacts: [
            {
                salutation: "Mr.",
                firstName: "John",
                lastName: "Doe",
                email: "john.doe@acme.com",
                accountName: "Acme, Inc.",
                phone: "+1-555-0100",
                billingStreet: "123 Main Street",
                billingCity: "San Francisco",
                billingStateProvince: "CA",
                billingCountry: "USA",
                billingPostalCode: "94102",
            },
        ],
    });
}
main();

{
  "id": "63fd642c-569d-44f9-8d67-5cf4944a16cc",
  "organizationId": "string",
  "name": "Acme, Inc.",
  "externalId": "acme-inc"
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

namestringRequired

externalIdstringOptional

phonestringOptional

employeeCountdoubleOptional

annualRevenuedoubleOptional

taxExemptStatusenumOptional

Allowed values:

creationSourceenumOptional

Allowed values:

websitestringOptional

billingAddressobjectOptional

metadataobjectOptional

Flexible JSON field for storing custom metadata about the customer

contactslist of objectsOptional

Array of contacts to create for this customer

Response

Success response - customer already exists with this externalId

idstring

organizationIdstring

namestring

externalIdstring or null

phonestring or null

employeeCountdouble or null

annualRevenuedouble or null

taxExemptStatusenum or null

Allowed values:

creationSourceenum or null

Allowed values:

creationStateenum or null

Allowed values:

websitestring or null

billingAddressobject or null

metadataobject or null

Flexible JSON field for storing custom metadata about the customer