List customer units

GET

https://api.agentpaid.io/api/v2/customers/:id/customer-units

GET

/api/v2/customers/:id/customer-units

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

{
  "data": [
    {
      "id": "cu_7f3k2m9x",
      "externalId": "team-research",
      "customerId": "cus_abc123",
      "customerExternalId": "acme",
      "name": "Research team",
      "externalType": "string",
      "status": "ACTIVE",
      "parentExternalId": "dept-rnd",
      "isRoot": true,
      "billable": true,
      "effectiveBillable": true,
      "metadata": {},
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ],
  "pagination": {
    "limit": 1,
    "offset": 1,
    "total": 1,
    "hasMore": true
  }
}

Lists the customer’s units as a flat list, newest last; assemble the tree from parentExternalId (null on the root unit, isRoot: true). Deleted units are hidden unless status=DELETED is given, drafts unless status=DRAFT. Filter by externalType, or by parentExternalId for one level of the tree. Use the value returned as customer.id, for example cus_abc123; if you have your own customer ID, use the /api/v2/customers/external/{externalId}/… twin.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Path parameters

idstringRequiredformat: "^cus_.+"

Paid customer display id

Query parameters

limitintegerOptional1-100Defaults to 10

offsetintegerOptional>=0

statusenumOptional

Filter by status (default ACTIVE; drafts are listed only with DRAFT).

Allowed values:

externalTypestringOptional1-64 characters

Filter by external type.

parentExternalIdstringOptional>=1 character

Your external ID of the parent unit; lists its direct children.

Response

200

datalist of objects

Flat list ordered by creation time; assemble the tree client-side from parentExternalId (null on the root).

paginationobject

Errors

400

Bad Request Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error