Update customer by external ID

PUT

https://api.agentpaid.io/api/v2/customers/external/:externalId

PUT

/api/v2/customers/external/:externalId

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

{
  "id": "cus_abc123",
  "name": "string",
  "legalName": "string",
  "email": "string",
  "phone": "string",
  "website": "string",
  "externalId": "string",
  "billingAddress": {
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "zipCode": "string",
    "country": "string"
  },
  "creationState": "draft",
  "status": "active",
  "churnDate": "2024-01-15T09:30:00Z",
  "vatNumber": "string",
  "metadata": {},
  "defaultCurrency": "string",
  "connections": {
    "stripe": {
      "customerId": "cus_stripe_xyz"
    }
  },
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z"
}

Update a customer by external ID. Changing externalId follows the organization-wide id rule: a new id that another customer already holds as its external id, a unit id or an alias, ignoring letter case, is refused with 409 EXTERNAL_ID_IN_USE; the same id in the same case stays 400 DUPLICATE_EXTERNAL_ID. When the id changes, the previous id is kept as an alias of the customer, so signals that still use it keep resolving to it.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

externalIdstringRequired

Customer ID from the integrator’s system, stored on Paid as externalId.

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

Stable Paid customer display ID. Use this value as the {id} path parameter for customer routes, for example GET /api/v2/customers/cus_abc123/state.

namestring

legalNamestring or null

emailstring

phonestring

websitestring

externalIdstring or null

billingAddressobject

Customer billing address, or null when no address is set.

creationStateenum

Allowed values:

statusenum

Customer status: churned when the customer is marked as churned, active otherwise.

Allowed values:

churnDatedatetime or null

vatNumberstring or null

metadatamap from strings to any or null

defaultCurrencystringformat: "^[A-Z]{3}$"

ISO 4217 currency code, for example USD, EUR, or GBP.

connectionsobject

Linked external system IDs for this customer.

createdAtdatetime

updatedAtdatetime

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

500

Internal Server Error