Le paiement est débité du mode de paiement Stripe enregistré de l'utilisateur et son compte est immédiatement crédité. Cet achat est soumis aux limites par achat et mensuelles définies dans la configuration de facturation de l'API Agent.
DemandePOST https://payments.builtwith.com/v1/billing/api-purchase
Envoyer la clé de facturation de l'agent concernée en tant que Authorization: Bearer YOUR_AGENT_BILLING_KEY, et envoyez un unique Idempotency-Key. Réutilisez cette clé uniquement lors d'une nouvelle tentative d'achat identique.
Corps de la requête| Champ | Taper | Requis | Description |
|---|
credits | number | Oui | Nombre de crédits à acheter par tranches fixes de 2 000. Ne doit pas dépasser max_per_purchase ou le reste de l'allocation mensuelle. |
Réponse de succès (HTTP 200)| Champ | Taper | Description |
|---|
success | boolean | true |
credits_purchased | number | Crédits ajoutés au compte. |
cost_usd | number | Montant facturé en USD. |
payment_id | string | Identifiant Stripe PaymentIntent pour le rapprochement. |
credits_available | number | Solde de crédit disponible mis à jour après l'achat. |
Exemple de requêteAuthorization: Bearer YOUR_AGENT_BILLING_KEY
Idempotency-Key: 72b7b97c-3b6d-4c64-9bbf-20fd2a931514
Content-Type: application/json
{ "credits": 2000 }Exemple de réponse positive{
"success": true,
"credits_purchased": 2000,
"cost_usd": 99.00,
"payment_id": "pi_3abc123xyz",
"credits_available": 10766
}Réponses d'erreur| HTTP | Signification |
|---|
| 400 | Échec de la validation : clé d’idempotence manquante, crédits non fractionnés en 2 000, limite par achat dépassée ou limite mensuelle UTC dépassée. |
| 401 | Clé de facturation de l'agent manquante ou invalide. Comprend un défi d'authentification WWW. |
| 402 | Le paiement Stripe a échoué ou aucun mode de paiement n'est enregistré. |
| 403 | Une clé API générale a été fournie au lieu de la clé de facturation spécifique, ou la facturation du compte est suspendue. |
| 409 | La clé d'idempotence est encore en cours d'application ou a été utilisée précédemment avec des données d'entrée différentes. |
| 405 | Méthode non autorisée - le point de terminaison requiert une méthode POST. |