크레딧 현황 조회 API

비즈니스의 크레딧 사용량을 조회할 수 있는 API를 제공합니다.

GET kit-api/v1/credit-usages/status

Method: GET Endpoint: kit-api/v1/credit-usages/status

Example

...kit-api/v1/credit-usages/status

Response

{
  "ok": true,
  "data": {
    "renewalDate": "2024-12-08T15:00:00.000Z",
    "credit": {
      "defaultCount": 5, // 기본 무료 크레딧
      "remainingDefaultCount": 3, // 잔여 무료 크레딧
      "paidCreditCount": 0, // 구매한 크레딧
      "remainingCount": 3 // 남은 전체 크레딧
    }
  }
}

{
  "ok": false, // api 실패
  "message": "error message", // Error가 존재하면 message(string)로 전달
  "errorCode": "ERROR_CODE"
}

Error Codes

Status Code	Error Code	Description
500	FAILED_GET_CREDIT	조회 과정에서 알 수 없는 에러가 발생한 경우