Update customer | Paid | Documentation

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

{
  "id": "c1234567-89ab-4def-0123-456789abcdef",
  "name": "Acme Corporation",
  "legalName": "Acme Corporation LLC",
  "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"
  }
}

Update a customer by ID

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequired

Request

Body

namestringOptional>=1 character

legalNamestring or nullOptional

emailstringOptionalformat: "email"

phonestringOptional

websitestringOptional

externalIdstring or nullOptional

billingAddressobjectOptional

creationStateenumOptional

Allowed values:

churnDatedatetime or nullOptional

vatNumberstring or nullOptional

metadatamap from strings to any or nullOptional

Response

200

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

404

Not Found Error

500

Internal Server Error