Update customer group | Paid

Update a customer group's name or description.

AuthorizationBearer

API Key authentication using Bearer token

idstringRequiredformat: "uuid"

Body

namestringOptional1-255 characters

descriptionstring or nullOptional<=1000 characters

200

idstringformat: "uuid"

namestring

descriptionstring or null

customerCountinteger

createdAtdatetime

updatedAtdatetime

customerslist of objects

404

Not Found 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.updateCustomerGroup("id", {});
8	}
9	main();

1	{
2	"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3	"name": "Premium Customers",
4	"description": "Group for customers with premium subscriptions",
5	"customerCount": 42,
6	"createdAt": "2024-01-15T09:30:00Z",
7	"updatedAt": "2024-01-15T09:30:00Z",
8	"customers": [
9	{
10	"id": "c1a4f8d2-9b3e-4f7a-8d2a-1f2b3c4d5e6f",
11	"name": "John Doe",
12	"externalId": "JD12345"
13	}
14	]
15	}