PayHazeDocsTableau de bord

GuidesEncaisserAbonnements

Abonnements

Vos plans, vos abonnés, leurs échéances : un seul moteur décide de chaque facture, une fois par période, même relancé deux fois.

Créer un plan

POST/v1/planscURL
curl -X POST "$PAYMENT_OS_API/v1/plans" \
  -H "Authorization: Bearer $PAYMENT_OS_KEY" \
  -H "X-Merchant-ID: $MERCHANT_ID" \
  -H "X-Environment: test" \
  -d '{ "name": "Lampe du mois",
        "price": { "model": "fixed", "interval": "month", "unit_minor": "1990", "tax_bp": 2000 } }'

Modèles : fixed, tiered (paliers) et usage. Montants en centimes, TVA en points de base (20 % = 2000). Un plan reste en brouillon jusqu’à POST /v1/plans/{id}/publish ; un prix n’est jamais réécrit, un nouveau prix s’ajoute.

Abonner un acheteur

POST/v1/subscriptionscURL
curl -X POST "$PAYMENT_OS_API/v1/subscriptions" \
  -H "Authorization: Bearer $PAYMENT_OS_KEY" \
  -H "X-Merchant-ID: $MERCHANT_ID" \
  -H "X-Environment: test" \
  -d '{ "plan_id": "pln_…", "customer": { "reference": "client-42", "name": "Julie Robert", "email": "julie@example.test" } }'

Les échéances sont prélevées sur le moyen enregistré par PUT /v1/subscriptions/{id}/payment-method : 4 essais à 5 jours d’écart en cas de refus. Si la banque demande l’acheteur, les essais s’arrêtent : il confirme lui-même depuis son portail (POST /v1/subscriptions/{id}/portal-link).