第28章 Billing API

Billing API により、共通的な請求プロセスを自動化することができます。

Billing API のすべてのエンドポイントは、管理ポータルの Documentation (?) > 3scale API Docs > Billing API で確認することができます。

Billing API には、以下の要件を満たす有効なアクセストークンが必要です。

  • プロバイダーアカウントの管理ユーザーまたは「Billing」権限を持つメンバーユーザーのいずれかに属していること
  • 「Billing API」スコープが含まれていること

パラメーターとして請求書 ID が必要な場合には、平易な請求書 ID ではなく 請求書 ID を指す点に注意してください。

API エンドポイントの XML レスポンスは見て直ぐに理解でき、請求書のフィールドは Web および PDF 版の情報と同じ内容を示しています。

注意を要するレスポンスのフィールド

  • creation_type:「manual」(手動で作成された請求書の場合) または「background」(3scale の自動請求プロセスにより作成された請求書の場合) どちらかの値をとります。
  • provider: API プロバイダー (管理アカウント) の詳細で、請求書の Issued by セクションに対応します。
  • buyer: 開発者アカウントの詳細で、請求書の Issued to セクションに対応します。

XML 版の請求書には、line-items フィールドに費用項目のリストも含まれます。

一部の費用項目 (特に自動的に作成された項目) では、一般的な名前、説明、量、および費用 (価格) 以外に、以下の項目が表示されます。

  • type: 費用項目のタイプで、以下の値を取ります。

    • LineItem::PlanCost: 定額プランの費用項目の場合
    • LineItem::VariableCost: 変動費の費用項目の場合
  • metric_id: 変動費の費用項目用で、費用が関連付けられているメトリクスの ID
  • contract_id: 費用が関連付けられているサービスまたはアプリケーションの ID