Create customer group | Paid

Create a new customer group. Names must be unique per org.

AuthorizationBearer

API Key authentication using Bearer token

Body

namestringRequired1-255 characters

descriptionstring or nullOptional<=1000 characters

201

idstringformat: "uuid"

namestring

descriptionstring or null

customerCountinteger

createdAtdatetime

updatedAtdatetime

customerslist of objects

400

Bad Request Error

409

Conflict 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.createCustomerGroup({
8	name: "Premium Customers",
9	});
10	}
11	main();

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "Premium Customers",
4	"description": "Group for customers with premium subscription plans",
5	"customerCount": 42,
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"customers": [
9	{
10	"id": "c1a4f8e2-9d3b-4f7a-8a2e-1b2c3d4e5f6a",
11	"name": "Acme Corporation",
12	"externalId": "ACME-12345"
13	}
14	]
15	}