API 레퍼런스
로그인
본문으로 건너뛰기

조직에 부여된 프로모션 크레딧, 만료 이른 순

GET/v1/organizations/{org_id}/credit/promotions

콘솔 세션 전용입니다, 조직 역할 owner, admin만 부를 수 있고 API 키로 부르면 403 console_only입니다

Headers

  • Cookie: string
    콘솔 로그인 세션 쿠키, 콘솔 전용 엔드포인트라 API 키로 부르면 403 console_only입니다

Parameters

  • org_id: string
    조직 ID
    형식 ^org_[A-Za-z0-9]+$
  • include_empty: optional boolean
    true면 다 쓴 것과 만료된 프로모션도 포함
    기본값 false

Returns

200 application/json

  • PromoCreditList: object
    • data: array of PromoCredit { id, name, credit_micro_usd, … }
      프로모션 크레딧 목록, 만료 이른 순
      • id: string
        프로모션 로트 ID
        형식 ^lot_[A-Za-z0-9]+$
      • name: string
        고객에게 보이는 이름
      • credit_micro_usd: integer
        부여 금액(µUSD 정수)
        최소 0
      • credit_usd: string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
      • remaining_micro_usd: integer
        남은 금액(µUSD 정수)
        최소 0
      • remaining_usd: string
        같은 금액의 USD 문자열(센트, 소수 2자리)
        형식 ^-?[0-9]+\.[0-9]{2}$
      • applies_to: array of object { kind, id } or null
        적용 대상, null이면 모든 잡. runner 항목은 러너 종류(GET /v1/runners의 id), path 항목은 시작 경로(api는 API 키, console은 콘솔)를 제한
        • kind: "runner" or "path"
          runner 또는 path
        • id: string
          러너 ID 또는 api, console
      • granted_at: string
        부여 시각(UTC)
        RFC 3339 UTC 시각
      • expires_at: string
        만료 시각(UTC)
        RFC 3339 UTC 시각
      • expired: boolean
        만료됐는지

오류

  • invalid_request: HTTP 400
    본문이나 쿼리가 검증에 실패했습니다, error.details.fields에 문제 필드가 있습니다
  • session_required: HTTP 401
    콘솔 엔드포인트를 유효한 콘솔 세션 쿠키 없이 불렀습니다
  • console_only: HTTP 403
    콘솔 세션 전용 엔드포인트입니다, API 키로는 결제, 키, 멤버 관리를 할 수 없습니다
  • insufficient_permission: HTTP 403
    역할이나 키 권한(run/read)이 이 요청을 허용하지 않습니다
  • not_found: HTTP 404
    자원이 없거나 이 호출자에게 보이지 않습니다
  • rate_limited: HTTP 429, 다시 시도 가능
    이 키 또는 조직의 요청이 너무 많습니다, retry_after_s만큼 기다리세요
  • internal_error: HTTP 500, 다시 시도 가능
    예상하지 못한 오류입니다, 다시 시도하고 반복되면 request_id와 함께 알려 주세요