Get customer entitlements | Paid

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

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "organizationId": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "productId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "entitlementId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "customerId": "9b2d7f3a-3c4e-4f1a-9a2b-1f3e4d5c6b7a",
    "startDate": "2024-01-01T00:00:00Z",
    "total": 100,
    "available": 75,
    "used": 25,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-02-10T12:45:00Z",
    "endDate": "2024-12-31T23:59:59Z"
  }
]

Authentication

AuthorizationBearer

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

Path parameters

customerIdstringRequired

The customer ID

Response

Success response

idstringformat: "uuid"

organizationIdstringformat: "uuid"

productIdstringformat: "uuid"

entitlementIdstringformat: "uuid"

customerIdstringformat: "uuid"

startDatedatetime

totallong

Total entitlement amount

availablelong

Available entitlement amount

usedlong

Used entitlement amount

createdAtdatetime or null

updatedAtdatetime or null

endDatedatetime or null

Authentication

Path parameters

Response

Errors