Update credit currency

PUT

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

Update a credit currency description or set its active/archive status.

AuthorizationBearer

API Key authentication using Bearer token

idstringRequired

Credit currency ID.

Body

descriptionstring or nullOptional

Updated description for this credit currency. Use null to clear the description.

statusenumOptional

Set to archived to archive this credit currency, or active to restore it.

200

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.

400

Bad Request Error

403

Forbidden Error

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.credits.updateCreditCurrencyById("7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf", {
8	description: "Credits consumed by developer API calls for premium features.",
9	status: "archived",
10	});
11	}
12	main();

1	{
2	"id": "7f4f5d4c-55e9-4d5b-a3e7-c9eb3d2d01bf",
3	"name": "API Credits",
4	"key": "api_credits",
5	"status": "archived",
6	"description": "Credits consumed by developer API calls for premium features.",
7	"archivedAt": "2024-04-20T14:45:00Z",
8	"createdAt": "2023-11-10T08:00:00Z",
9	"updatedAt": "2024-04-20T14:45:00Z"
10	}