Create credit currency

POST

https://api.agentpaid.io/api/v2/credits/currencies

Creates a credit currency for the organization.

Authentication

AuthorizationBearer

API Key authentication using Bearer token

Request

Body

namestringRequired>=1 character

Human-readable name shown for this credit currency.

keystringRequiredformat: "^[a-z0-9_-]+$">=1 character

Stable machine-readable key for this credit currency. Use lowercase letters, numbers, underscores, and hyphens. Keys are unique within an organization.

descriptionstring or nullOptional

Optional description for this credit currency.

Response

201

idstring

Unique identifier for this credit currency.

namestring

Human-readable name shown for this credit currency.

keystring

Stable machine-readable key for this credit currency. Keys are unique within an organization.

statusenum

Whether this credit currency is active or archived.

descriptionstring or null

Optional description for this credit currency.

archivedAtdatetime or null

When this credit currency was archived. Null means the currency is active.

createdAtdatetime

When this credit currency was created.

updatedAtdatetime

When this credit currency was last updated.

Errors

400

Bad Request Error

403

Forbidden 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.credits.createCreditCurrency({
8	name: "API Credits",
9	key: "api_credits",
10	description: "Credits consumed by API calls.",
11	});
12	}
13	main();

1	{
2	"id": "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf",
3	"name": "API Credits",
4	"key": "api_credits",
5	"status": "active",
6	"description": "Credits consumed by API calls.",
7	"archivedAt": "2024-01-15T09:30:00Z",
8	"createdAt": "2024-01-15T09:30:00Z",
9	"updatedAt": "2024-01-15T09:30:00Z"
10	}