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