エージェントストライプクレジットチャージAPI

導入

Agent Stripe Credit Top-Up APIを使用すると、AIエージェントがアカウントのAPIクレジット残高を確認し、ユーザーが設定した限度額内で、アカウントに保存されているStripe決済方法に課金してアカウントクレジットを追加できます。

このAPIはX402に対応していません。 既存の BuiltWith アカウントと、別途スコープが設定されたエージェント請求キーが必要です。アカウントなしの Base USDC 支払いには、 BuiltWith x402 payments page.

3つの主要エンドポイントはすべて、 payments.builtwith.com.

エージェントがこれらのエンドポイントを使用する前に、ユーザーはエージェント API 課金を有効にし、支出制限を設定する必要があります。 https://payments.builtwith.com/agent-payment-api-config.

手動で有効化した後、エージェントは従来のmppxパスエイリアスを使用して同じStripeトップアップ操作を行うことができます。 https://api.builtwith.com/mppx. これらのエイリアスは、X402エラーや支払い認証プロトコルではありません。

認証

請求設定ページから、スコープが個別に設定されたエージェント請求キーをコピーし、Authorization ヘッダーに含めて送信してください。一般的な BuiltWith API キーおよび一時的な bw- デバイストークンではクレジットを購入できません。

Authorization: Bearer YOUR_AGENT_BILLING_KEY

従来のKEYクエリパラメータは、URL内の認証情報がログやブラウザの履歴に保持される可能性があるため、非推奨となりました。

キーが欠落、無効、または無効化されているリクエストはHTTP 401を返します。請求が停止されているアカウントはHTTP 403を返します。

🤖 AIエージェントプロンプト

Reference https://api.builtwith.com/llms.txt and
https://raw.githubusercontent.com/builtwith/builtwith-ai-sdk/refs/heads/main/README.md
Add BuiltWith Agent Stripe Credit Top-Up API support to my app. This is saved-card
account billing, not x402. Check the account API-credit balance and, if below 1000,
purchase 2000 more using a unique Idempotency-Key and the scoped Agent Billing Key.
If the legacy mppx path aliases are desired, use
https://api.builtwith.com/mppx/openapi.json and the Agent Payment API routes
https://api.builtwith.com/mppx/api-discovery,
https://api.builtwith.com/mppx/api-configuration, and
https://api.builtwith.com/mppx/api-purchase.

mppx Stripe Credit Top-Up Path Aliases

これらの従来のmppxパスは、保存済みのStripeメソッドによるクレジットチャージAPIをプロキシします。これらはx402認証に対応しておらず、payment-challengeヘッダーを返したり受け入れたりしません。

発見

GET https://api.builtwith.com/mppx/openapi.json

ルート

GET https://api.builtwith.com/mppx/api-discovery

GET https://api.builtwith.com/mppx/api-configuration

POST https://api.builtwith.com/mppx/api-purchase

{ "credits": 2000 }

認証：ベアラーでスコープ付きエージェント請求キーを送信し、購入時に一意の冪等性キーを含めます。

GET /v1/billing/api-discovery — 貸方残高

アカウントの現在のAPIクレジット残高を返します。

リクエスト

GET https://payments.builtwith.com/v1/billing/api-discovery
Authorization: Bearer YOUR_AGENT_BILLING_KEY

回答欄

分野	タイプ	説明
`credits_total`	`number`	当該口座にこれまでに割り当てられたクレジットの総額。
`credits_used`	`number`	これまでにAPI呼び出しによって消費されたクレジット。
`credits_available`	`number`	残りの使用可能なクレジット（合計から使用済みを差し引いたもの）。エージェントはAPI呼び出しを行う前に、この値を確認する必要があります。

回答例

{
  "credits_total": 10000,
  "credits_used": 1234,
  "credits_available": 8766
}

GET /v1/billing/api-configuration — 支出制限

設定された支出限度額と、月間限度額のうち既に使用された金額を返します。エージェントは、購入リクエストが拒否されるのを避けるため、購入を試みる前にこれを確認する必要があります。

リクエスト

GET https://payments.builtwith.com/v1/billing/api-configuration
Authorization: Bearer YOUR_AGENT_BILLING_KEY

回答欄

分野	タイプ	説明
`max_per_purchase`	`number`	代理店が1回の取引で購入できる最大クレジット数。
`max_monthly`	`number`	エージェントが現在のUTC暦月中に購入できる最大クレジット数。
`monthly_purchased`	`number`	代理店が今月既に購入したクレジット。
`monthly_remaining`	`number`	今月、月間上限に達するまでにあと何クレジット購入できますか？
`cost_per_2000_credits_usd`	`number`	最低購入額2,000クレジットの米ドル建て価格です。この価格を参考に、購入予定額の概算を行ってください。

回答例

{
  "max_per_purchase": 5000,
  "max_monthly": 20000,
  "monthly_purchased": 5000,
  "monthly_remaining": 15000,
  "cost_per_2000_credits_usd": 99.00
}

POST /v1/billing/api-purchase — クレジットを購入

ユーザーが登録したStripe決済方法に請求を行い、アカウントに即座にクレジットを付与します。購入は、エージェントAPIの請求設定で設定された購入ごとの上限および月間上限の対象となります。

リクエスト

POST https://payments.builtwith.com/v1/billing/api-purchase

スコープ付きエージェント請求キーを次のように送信します Authorization: Bearer YOUR_AGENT_BILLING_KEY, そしてユニークなものを送る Idempotency-Key. そのキーは、同一の購入を再度試みる場合にのみ再利用してください。

リクエストボディ

分野	タイプ	必須	説明
`credits`	`number`	はい	購入するクレジット数は2,000単位で固定されます。上限は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認証チャレンジが含まれています。
402	Stripeでの支払いが失敗したか、登録されている支払い方法が有料ではありません。
403	スコープを限定した課金キーではなく、広範囲なAPIキーが提供されたか、アカウントの課金が停止されています。
409	冪等性キーはまだ処理中であるか、以前に別の入力で使用されていました。
405	許可されていないメソッドです - エンドポイントはPOSTメソッドを必要とします。

特別ドメイン

ドメイン検索の際に使用する2つのリストを用意しています。無視リストとBuiltWithサフィックスリストです。

無視リスト
Tこれは、インデックスに登録しないドメインの社内リストです。これらのドメインはブロックされているか、誤解を招く技術が多すぎるか、ユーザー生成コンテンツを含むサブドメインが多すぎるため、インデックスに登録しません。

BuiltWith サフィックスリスト
これは、パブリックサフィックスリストただし、トップレベルドメインと見なされるサブドメインを持つ企業の追加エントリが多数含まれています。このリストにより、内部 Web サイトの可視性が向上します。たとえば、northernbeaches.nsw.gov.au が nsw.gov.au よりもトップレベルに表示されるようになります。

ドメインを無視 (XML, JSON or TXT)

https://api.builtwith.com/ignoresv1/api.json

サフィックスドメイン (XML, JSON or TXT)

https://api.builtwith.com/suffixv1/api.json

エラーコード

注意: この形式のエラーメッセージは保証されません。実装では、200 以外の応答コードもエラーとして扱う必要があります。エラーがサーバー関連の場合、Lookup プロパティは null (json) または提供されません (xml)。すべての潜在的なエラーコードを表示する.

利用規約

私たちの標準用語当社のすべての API の使用をカバーします。

一般的に、API は様々な方法で製品を拡張するために使用できます。唯一の制限は、データをそのまま再販したり、builtwith.com および関連サービスに重複した機能を提供したりできないことです。