Abonnements

Page générée depuis la spécification OpenAPI que la passerelle sert (GET /v1/openapi.json). Ne la modifiez pas à la main : elle est réécrite à chaque build.

Méthode	Chemin	Description
GET	/v1/subscriptions	Lister les abonnements
POST	/v1/subscriptions	Créer un abonnement
GET	/v1/subscriptions/{id}	Consulter un abonnement
DELETE	/v1/subscriptions/{id}	Résilier un abonnement

GET /v1/subscriptions

Lister les abonnements

ⓘ Liste plate, plafonnée à cinquante, sans pagination — un compte qui dépasse cinquante instructions permanentes exploite un produit de facturation, et cela se lit dans le tableau de bord. Dire le plafond vaut mieux qu'un paramètre page qui ne signifierait rien.

Paramètres

Nom	Emplacement	Requis	Description
status	query	non	Filtre sur le statut (active, past_due, cancelled…).

Réponses

• 200 — OK
• 401 — Clé API manquante ou rejetée
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

POST /v1/subscriptions

Créer un abonnement

Ouvre une instruction permanente de facturer un client au rythme d'un plan.

⚠️ UN ABONNEMENT NE PRÉLÈVE JAMAIS DE LUI-MÊME. Il émet une facture à échéance et encaisse sur un moyen de paiement enregistré ; il n'existe aucun mandat de prélèvement sur cette plateforme, et aucun rail ici n'en porte. C'est pourquoi la création demande le scope can_initiate_payment : le pouvoir qu'un abonnement confère est exactement celui d'encaisser, accordé une fois pour une série indéfinie.

Le plan se crée dans le tableau de bord ; plan_id est son identifiant public.

Paramètres

Nom	Emplacement	Requis	Description
Idempotency-Key	header	non	Clé d'idempotence propre à CETTE opération.

Réponses

• 201 — Abonnement créé
• 401 — Clé API manquante ou rejetée
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
• 422 — Plan introuvable, inactif, ou appartenant à un autre compte
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

GET /v1/subscriptions/{id}

Consulter un abonnement

L'abonnement et ses compteurs. retry_count non nul signale un recouvrement en cours d'échec sur le cycle courant.

Paramètres

Nom	Emplacement	Requis	Description
id	path	oui

Réponses

• 200 — OK
• 401 — Clé API manquante ou rejetée
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
• 404 — Aucun abonnement de cet identifiant
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After

DELETE /v1/subscriptions/{id}

Résilier un abonnement

Résiliation immédiate par défaut. ?at_period_end=true laisse la période payée courir jusqu'au bout et résilie au lieu de renouveler à l'échéance suivante.

ⓘ Ni l'une ni l'autre ne rembourse ce qui a déjà été encaissé : un remboursement est une opération à part, délibérément.

Paramètres

Nom	Emplacement	Requis	Description
id	path	oui
at_period_end	query	non	true = résilier à la fin de la période payée plutôt qu'immédiatement.

Réponses

• 200 — Résilié
• 401 — Clé API manquante ou rejetée
• 403 — La clé ne porte pas le scope requis, ou le compte n'est pas actif
• 404 — Aucun abonnement de cet identifiant
• 422 — L'abonnement n'est pas résiliable dans son état courant
• 429 — Budget de requêtes de la clé épuisé (300/min) — honorer Retry-After