Get customer group | Paid

Returns group details including member list (capped at 500).

AuthorizationBearer

API Key authentication using Bearer token

idstringRequiredformat: "uuid"

200

idstringformat: "uuid"

namestring

descriptionstring or null

customerCountinteger

createdAtdatetime

updatedAtdatetime

customerslist of objects

404

Not Found Error

500

Internal Server Error

1	import { PaidClient } from "@paid-ai/paid-node";
2
3	async function main() {
4	const client = new PaidClient({
5	token: "YOUR_TOKEN_HERE",
6	});
7	await client.customerGroups.getCustomerGroup("id");
8	}
9	main();

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "Premium Customers",
4	"description": "Group of customers with premium subscription plans",
5	"customerCount": 120,
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-04-10T11:45:00Z",
8	"customers": [
9	{
10	"id": "c1234567-89ab-4def-0123-456789abcdef",
11	"name": "Alice Johnson",
12	"externalId": "EXT-1001"
13	}
14	]
15	}