Skip to content

Verament credits endpoints

2 endpoints at https://api.vaif.studio, generated from the API's OpenAPI document. The REST API page covers authentication, and All endpoints lists every group.

GET /credits/org/{orgId}

ParameterInTypeRequired
orgIdpathstringYes
Response 200 (application/json)
{
  credits: {
    id: string;
    orgId: string;
    type: string;
    amount: number;
    reason: string;
    referenceType: null | string;
    referenceId: null | string;
    stripeRefundId: null | string;
    createdByUserId: null | string;
    appliedAt: string (date-time);
    expiresAt: null | string (date-time);
    createdAt: string (date-time);
  }[];
}

GET /credits/org/{orgId}/balance

ParameterInTypeRequired
orgIdpathstringYes
Response 200 (application/json)
{
  balance: number;
  pendingExpiration: number;
  formattedBalance: string;
}