크레딧 원장

GET

/api/v1/billing/ledger

const url = 'https://dev.api.endueos.com/api/v1/billing/ledger?kind=grant';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://dev.api.endueos.com/api/v1/billing/ledger?kind=grant' \
  --header 'Authorization: Bearer <token>'

원장. 최신순.

인증

파라미터

쿼리 파라미터

kind

string

허용 값: grant topup usage refund adjustment

page

integer format: int32

1 부터. 기본 1.

limit

integer format: int32

기본 20, 최대 200 (넘으면 200 으로 줄인다).

응답

200

성공.

application/json

object

data

필수

Array<object>

원장 한 줄. 추가만 한다 — 고치거나 지우지 않는다.

object

pricing_detail

Any of:

object
null

object

billing_resource_id

필수

string

from

필수

string format: date-time

필수

string format: date-time

posted_credits

필수

string

cost_status

필수

string

entry_id

필수

string

/^led_[0-9A-HJKMNP-TV-Z]{26}$/

kind

필수

string

허용 값: grant topup usage refund adjustment

amount

필수

충전은 +, 사용은 −.

number format: double

balance_after

필수

이 줄을 반영한 뒤의 잔액.

number format: double

metric

필수

Any of:

string
null

string

quantity

필수

Any of:

number
null

number format: double

station_id

필수

Any of:

string
null

string

/^stn_[0-9A-HJKMNP-TV-Z]{26}$/

device_id

필수

Any of:

string
null

Device 의 id — Resource 와 같은 res_ 다 (v0.1.0 이 이미 냈다).

string

/^res_[0-9A-HJKMNP-TV-Z]{26}$/

description

필수

string

created_at

필수

string format: date-time

meta

필수

object

request_id

필수

string

timestamp

필수

string format: date-time

duration

서버 처리 시간(ms).

integer format: int32

pagination

필수

object

page

필수

integer format: int32

limit

필수

integer format: int32

total

필수

integer format: int32

has_next_page

필수

boolean

예시

{
  "data": [
    {
      "entry_id": "led_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
      "kind": "grant",
      "station_id": "stn_01J9ZK3Q8M4XW7D2N5R6T0V1BC",
      "device_id": "res_01J9ZK3Q8M4XW7D2N5R6T0V1BC"
    }
  ]
}

400

요청 형식이 틀렸다 — VALIDATION_ERROR(details.errors[]) 또는 BAD_REQUEST. 본문은 오류 봉투.

401

인증이 없거나 무효다 — UNAUTHORIZED. 본문은 오류 봉투.

403

이 인증 수단으로는 못 하는 일이다 — FORBIDDEN (예: API 키로 클라우드 기기 만들기). 본문은 오류 봉투.

429

한도를 넘었다 — Retry-After 초 뒤에 다시. 본문은 오류 봉투.

500

서버 오류 — INTERNAL_ERROR. 본문은 오류 봉투.

503

의존 서비스에 닿지 못했다 — 잠시 뒤 다시. 본문은 오류 봉투.