유닛 잔액 조회

스페이스의 현재 보유 유닛, 초과 사용 상태와 차단 상태를 한 번에 확인합니다.

잔액은 유닛 단위 문자열이며 초과 사용 허용과 차단 상태를 함께 반환합니다.

OpenAPI v0.0.2-dev3 · 공개 문서 기준문서용 JSON 열기

요청 파라미터

별도 쿼리 또는 경로 파라미터가 없습니다.

응답

200성공 응답

heldobject필수
현재 사용할 수 있는 유닛입니다.
- promostring필수
  프로모션으로 지급된 유닛입니다.
  패턴 ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
- paidstring필수
  구매한 유닛입니다.
  패턴 ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
- totalstring필수
  현재 사용할 수 있는 전체 유닛입니다.
  패턴 ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
overageobject필수
한도를 초과해 사용한 유닛과 허용 상태입니다.
- accruedstring필수
  누적된 초과 사용 유닛입니다.
  패턴 ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
- allowedboolean필수
  초과 사용 허용 여부입니다.
blockedboolean필수
현재 사용 차단 여부입니다.

422요청 검증 오류

detailarray<object>
요청 검증에 실패한 항목 목록입니다.
- locarray<string | integer>필수
  오류가 발생한 요청 위치입니다.
- msgstring필수
  오류 설명입니다.
- typestring필수
  오류 유형입니다.

코드 예시

요청 예시

curl 'https://openapi.letsur.ai/v1/balance' \
  --header 'Authorization: Bearer mk_...'

200 응답 예시

{
  "held": {
    "promo": "0.00",
    "paid": "0.00",
    "total": "0.00"
  },
  "overage": {
    "accrued": "0.00",
    "allowed": false
  },
  "blocked": false
}

예시는 스키마의 형식을 설명하기 위한 값이며 실제 계정 데이터가 아닙니다.

관리 API 키를 보내는 방법은 인증, 문서에서 검증한 기계 판독용 스키마는 OpenAPI 스키마에서 확인합니다.