28장. 청구 API

청구 API는 일반적인 청구 프로세스를 자동화하는 방법을 제공합니다.

billing API의 모든 엔드포인트는 문서(?) > 3scale API Docs > billing API 의 관리 포털에서 확인할 수 있습니다.

청구 API에는 다음 요구 사항을 충족하는 유효한 액세스 토큰이 필요합니다.

  • 이는 공급자 계정의 admin 사용자 또는 "Billing" 권한이 있는 멤버 사용자에 속해야 합니다.
  • "Billing API" 범위를 포함해야 합니다.

송장 ID가 매개 변수로 필요한 경우 Friendly invoice ID가 아닌 송장 ID를 참조합니다.

API 엔드포인트의 XML 응답은 대부분 자체 설명이며 Invoice 필드는 웹 및 PDF 표현과 동일한 정보를 나타냅니다.

응답의 몇 가지 주목할 만한 필드:

  • creation_type: 3scale 자동 청구 프로세스에서 만든 송장 의 경우 '수동 '의 송장 값을 가질 수 있습니다.
  • Provider: API 공급자의 세부 정보(관리 계정)는 송장의 문제 섹션에 해당합니다.
  • customer: 개발자 계정의 세부 정보는 송장의 관련 섹션에 해당합니다.

송장의 XML 표현에는 line-items 필드 아래의 줄 항목 목록도 포함되어 있습니다.

일부 줄 항목(일반적으로 자동으로 생성된 항목)의 경우 예상 이름, 설명, 수량 및 비용(비용)을 제외하고 다음을 확인할 수 있습니다.

  • type: 라인 항목의 유형은 다음과 같은 값을 가질 수 있습니다:

    • lineitem ::PlanCost - 고정 계획 비용의 라인 항목
    • lineitem ::VariableCost - 변수 비용의 행 항목
  • metric_id: 변수 비용 줄 항목의 경우 - 비용이 연결된 메트릭의 ID
  • contract_id: 비용이 연결된 서비스 또는 애플리케이션의 ID