18장. 청구 API

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

빌링 API의 모든 끝점은 문서(?) > 3scale API Docs > Billing API 의 관리 포털에서 확인할 수 있습니다.

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

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

송장 ID가 매개변수로 필요한 경우, 귀하의 송장 ID를 참조하고, Passoly invoice ID가 아니라 송장 ID를 참조합니다.

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

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

  • creation_type: 3scale 자동 청구 프로세스에서 생성한 송장의 경우 'manual' 은 수동으로 생성된 송장 또는 'background' 값을 가질 수 있습니다.
  • provider: API 공급자의 세부 정보(관리자 계정)는 송장의 섹션에 발급된 문제에 해당합니다.
  • subscriber: 개발자 계정의 세부 사항은 송장의 문제에 해당합니다.

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

예상 이름, 설명, 수량 및 비용(가격)과 별도로 일부 라인 항목(일반적으로 자동으로 생성된 항목)의 경우 다음을 참조하십시오.

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

    • lineitem ::PlanCost - 수정된 계획 비용을 위한 라인 항목의 경우
    • lineitem::VariableCost - 변수 비용의 줄 항목의 경우
  • metric_id: 변수 비용 라인 항목의 경우 - 비용과 관련된 메트릭의 ID
  • contract_id: 비용과 관련된 서비스 또는 애플리케이션의 ID