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.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();

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

creationSourceenumOptional

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

phonestring

employeeCountdouble

annualRevenuedouble

taxExemptStatusenum

creationSourceenum

creationStateenum

websitestring

billingAddressobject

metadataobject

Flexible JSON field for storing custom metadata about the customer

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