credits

Update credit currency

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

put/credits/currencies/{id}

Request

  • Base URL: https://api.agentpaid.io/api/v2
  • URL: https://api.agentpaid.io/api/v2/credits/currencies/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Credit currency ID.

Request body

descriptionstring nullable

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

status'active' | 'archived'

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

Response

200

idstring required

Unique identifier for this credit currency.

namestring required

Human-readable name shown for this credit currency.

keystring required

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

status'active' | 'archived' required

Whether this credit currency is active or archived.

descriptionstring nullable required

Optional description for this credit currency.

archivedAtstring date-time nullable required

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

createdAtstring date-time required

When this credit currency was created.

updatedAtstring date-time required

When this credit currency was last updated.

Changes

No recorded changes to this operation across all 1 revision of this API.