第 18 章 账单 API
Billing API 提供了一种方式来自动化常见计费流程。
Billing API 的所有端点均可在管理门户的 Documentation(?)> 3scale API Docs > Billing API 下找到。
Billing API 需要有效的访问令牌,它满足以下要求:
- 它应属于 provider 帐户的 admin 用户或具有"Billing"权限的成员用户
- 它应包含"Billing API"范围
请注意,当需要发票 ID 作为参数时,它指的是发票 ID,而不是 友好发票 ID。
API 端点的 XML 响应大多自我解释,Invoice 的字段表示的信息与 web 和 PDF 表示法中的信息相同。
响应中的一些显著字段:
- creation_type :对于手动创建的发票为 'manual',对于 3scale 自动账单流程创建的发票为 'background'
- provider :API 提供程序(管理员帐户)的详细信息,对应于发票的 Issued by 部分。
- buyer :开发人员帐户的详细信息,对应于发票的 Issued to 部分。
发票的 XML 表示法还包括 line-items
字段下的行项目列表。
除了预期名称、描述、数量和成本(价格)之外的一些项目(通常是自动创建的项目),您可以看到以下内容:
type
:行项的类型,可以是以下值:-
LineItem::PlanCost
- 用于固定计划成本的行项 -
LineItem::VariableCost
- 用于行项目的变量成本
-
-
metric_id
:用于变量成本行项目 - 成本关联的指标 ID -
contract_id
:与成本相关联的服务或应用程序的 ID