Aller à la documentation
API

Activer ou désactiver le paiement à l’usage

L’interrupteur d’Offres et facturation, et la carte qu’il demande la première fois.

PATCH/billing/pay-as-you-go

Exécute l'un des 2 appels sur votre espace de travail.

PATCH /billing/pay-as-you-go

L’interrupteur d’Offres et facturation, et la carte qu’il demande la première fois.

Exemple

Nécessite billing:write. La désactivation prend effet tout de suite, et l’utilisation s’arrête aux quotas. L’activation prend effet tout de suite quand une carte est enregistrée. La première fois, checkoutUrl est un lien où la personne ajoute une carte, et le paiement à l’usage démarre une fois qu’elle l’a fait. theme et locale habillent la page qu’ouvre le lien.

curl
curl -X PATCH "$OE/billing/pay-as-you-go" -H "$AUTH" -H 'content-type: application/json' \  -d '{ "enabled": true, "locale": "de" }'
Réponse
{  "object": "pay_as_you_go_switch",  "enabled": false,  "suspended": false,  "activating": false,  "checkoutUrl": "https://checkout.example.com/c/7Yw2kq9RzX4mB1vN?locale=de"}

Rien ne se paie par l’API. Le lien ouvre la page du prestataire de paiement, où la personne paie, change la carte ou résilie, comme depuis l’application.

Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.

Après le paiement

Nécessite billing:write. Une fois que la personne a ajouté la carte, POST /billing/pay-as-you-go/confirm vérifie auprès du prestataire de paiement et l’enregistre, comme le fait l’application à son retour. enabled indique si le paiement à l’usage est activé maintenant, et le rappeler est sans risque.

curl
curl -X POST "$OE/billing/pay-as-you-go/confirm" -H "$AUTH"
Réponse
{ "object": "pay_as_you_go_confirmation", "enabled": true }

activating: true renvoyé par l’interrupteur signifie qu’une carte vient d’être enregistrée et que le paiement à l’usage est en cours d’activation, relisez-le donc dans un instant.

Un jeton d'accès OAuth a besoin d'un code de vérification pour cet appel. Tant que l'application n'en a pas vérifié un dans les 60 dernières minutes, l'appel répond 403 step_up_required et ne change rien. On ne le demande jamais à une clé API. La page Authentification montre comment demander un code et le vérifier.

Référence