28장. 청구 API
billing API는 일반적인 청구 프로세스를 자동화하는 방법을 제공합니다.
billing API의 모든 끝점은 문서 (?) > 3scale API 문서 > billing API 의 관리 포털에서 확인할 수 있습니다.
billing API에는 다음 요구 사항을 충족하는 유효한 액세스 토큰이 필요합니다.
- 공급자 계정의 admin 사용자 또는 "Billing" 권한이 있는 멤버 사용자에게 속해야 합니다.
- "Billing API" 범위가 포함되어야 합니다.
송장 ID가 매개 변수로 필요한 경우 Friendly invoice ID가 아닌 송장 ID를 나타냅니다.
API 끝점의 XML 응답은 대부분 자체 설명하며, Invoice의 필드는 웹 및 PDF 표현과 동일한 정보를 나타냅니다.
응답의 몇 가지 주목할 만한 필드:
- creation_type: 수동으로 생성한 송장의 경우 'manual' 또는 3scale 자동 청구 프로세스에서 생성한 송장에 대한 ' manual' 값을 가질 수 있습니다.
- provider: API 공급자의 세부 정보(관리자 계정)는 송장의 섹션에 의해 발행된 항목에 해당합니다.
- Buyer: 개발자 계정의 세부 사항은 송장의 섹션과 일치합니다.
송장의 XML 표현에는 line-items 필드 아래에 있는 라인 항목 목록도 포함되어 있습니다.
일부 라인 항목, 일반적으로 예상되는 이름, 설명, 수량 및 비용 가격과 별도로 자동으로 생성된 항목의 경우 다음을 확인할 수 있습니다.
type: 라인 항목의 유형은 다음 값을 가질 수 있습니다.-
line
item::PlanCost- 고정 계획 비용을 위한 라인 항목의 경우입니다. -
line
item::VariableCost- 변수 비용을 위한 라인 항목의 경우입니다.
-
line
-
metric_id: 변수 비용 라인 항목의 경우 - 비용이 연결된 메트릭의 ID입니다. -
contract_id: 비용이 연결된 서비스 또는 애플리케이션의 ID입니다.
