系统会从用户保存的 Stripe 付款方式中扣款,并立即将款项记入账户。此次购买受代理 API 计费配置中设置的单次购买和每月限额的限制。
要求POST https://payments.builtwith.com/v1/billing/api-purchase
发送指定范围的代理计费密钥 Authorization: Bearer YOUR_AGENT_BILLING_KEY, 并发送一个独特的 Idempotency-Key. 仅在重新尝试购买同一商品时才使用该密钥。
请求正文| 场地 | 类型 | 必需的 | 描述 |
|---|
credits | number | 是的 | 以 2,000 为单位购买固定数量的积分。不得超过 max_per_purchase 或剩余的月度津贴。 |
成功响应(HTTP 200)| 场地 | 类型 | 描述 |
|---|
success | boolean | true |
credits_purchased | number | 账户已添加积分。 |
cost_usd | number | 以美元计价的金额。 |
payment_id | string | Stripe PaymentIntent ID 用于对账。 |
credits_available | number | 购买后更新可用信用余额。 |
示例请求Authorization: Bearer YOUR_AGENT_BILLING_KEY
Idempotency-Key: 72b7b97c-3b6d-4c64-9bbf-20fd2a931514
Content-Type: application/json
{ "credits": 2000 }成功回应示例{
"success": true,
"credits_purchased": 2000,
"cost_usd": 99.00,
"payment_id": "pi_3abc123xyz",
"credits_available": 10766
}错误响应| HTTP | 意义 |
|---|
| 400 | 验证失败 - 缺少幂等密钥、积分不是 2,000 的增量、单次购买限额已超出或 UTC 月度限额已超出。 |
| 401 | 缺少或无效的代理计费密钥。包含 WWW-Authenticate 验证。 |
| 402 | Stripe支付失败或账户中没有可用的支付方式。 |
| 403 | 如果提供的是范围广泛的 API 密钥而不是限定范围的计费密钥,则帐户计费将被暂停。 |
| 409 | 幂等性密钥仍在开发中,或者之前曾用于不同的输入。 |
| 405 | 方法不允许 - 端点需要 POST 请求。 |