PayHazeDocsTableau de bord

Abonnements

Relever l’usage

POST/v1/subscriptions/{id}/usagepayments:write

Needs payments:write. Idempotent by external_id: the same record twice returns the one kept, another quantity under the same identifier is refused (409). A negative quantity corrects. A record for a period already invoiced settles at once: billed on the next invoice when it adds, credited by a credit note when it takes back.

En-têtes

AuthorizationBearer pos_test_…obligatoire
Clé de serveur. Jamais dans un navigateur.
X-Merchant-IDstringobligatoire
L’espace marchand concerné (mrc_…).
X-Environment"test"obligatoire
Seule valeur acceptée tant que la production n’est pas ouverte.

Paramètres

iddans le cheminobligatoire

Corps

external_idstring, 0 à 128obligatoire
quantityintegerobligatoire
occurred_atstringobligatoire

Réponses

200Réussi
400Requête invalide
401Clé absente ou invalide
403Autorisation ou espace refusé
404Ressource introuvable
409Conflit avec une demande existante
429Trop de demandes, réessayez plus tard
503Service momentanément indisponible

Une erreur ne vaut jamais paiement. Le corps donne code, message, request_id et retry_action ; renvoyez la même Idempotency-Key si retry_action le propose.