Passer au contenu principal
Dans ce guide, nous verrons comment implémenter un abonnement Hyperline dans le contexte d’un produit en libre-service.

Contexte

Vous avez une page de tarifs sur votre site marketing et souhaitez que vos clients souscrivent en cliquant sur une offre.

Prérequis

  1. Créer un compte Hyperline
  2. Suivre les étapes pour configurer votre compte
  3. Une idée claire des plans que vous souhaitez vendre et de leurs prix associés
  4. Une clé API pour utiliser l’API Hyperline
Une fois inscrit et connecté à Hyperline, vous pouvez utiliser le mode test pour expérimenter avant de passer en production.

Étapes

1. Modéliser vos produits et modèles dans Hyperline

La première chose à faire est de créer vos produits et (facultativement) vos modèles d’abonnement dans Hyperline. Vous n’aurez à effectuer cette opération qu’une seule fois, mais vous pourrez facilement itérer sur votre tarification pour expérimenter et ajuster par la suite. Si vous avez besoin d’aide pour représenter au mieux votre offre ou de conseils, vous pouvez contacter le support via le chat « Help ».

2. Implémenter un flux d’abonnement

Voici un exemple de flux pour initier l’abonnement d’un prospect à votre produit. Bien sûr, cela peut varier selon votre cas d’usage et votre produit, et peut être ajusté à vos besoins.
1

Le prospect crée un compte

Pour cet exemple, le prospect s’inscrit d’abord à votre produit en créant un compte de votre côté.
2

Créer un client Hyperline

Lorsque le prospect s’est inscrit, votre backend crée un client sur Hyperline lié au client nouvellement inscrit dans votre système.
curl --request POST \
  --url https://api.hyperline.co/v1/customers \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "My customer",
    "currency": "EUR",
    "external_id": <(optional) ID of the customer in your system>,
    "available_payment_methods": <(optional) list of authorized payment methods>
  }'
3

Attribuer un abonnement

Vous pouvez ensuite attribuer un abonnement à partir du modèle (représentant vos plans/offres) sélectionné par le client.Vous devez utiliser l’identifiant correspondant au modèle précédemment créé, que vous trouverez dans les modèles Hyperline (à côté du nom du modèle).Cet exemple crée une page de paiement dédiée sur laquelle votre client renseignera ses informations de facturation, ajoutera son moyen de paiement et souscrira. Nous démarrerons l’abonnement à la date du jour et redirigerons le client vers une URL spécifique (https://acme.com/api/callback) de votre côté après finalisation du paiement.
curl --request POST \
  --url https://api.hyperline.co/v2/subscriptions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "customer_id": <ID from the previous call>,
    "template_id": "subt_ji3uPodOneXk6R",
    "starts_at": "2025-12-20T00:00:00Z",
    "activation_strategy": "checkout",
    "checkout_session": {
      "redirect_url": "https://myservice.com/api/callback"
    }
  }'
Si vous souhaitez personnaliser la quantité de produits, vous pouvez utiliser un paramètre supplémentaire dans le corps de la requête.
{
  "products": [
    {
      "id": "itm_4vea8Gj0a5HZr9",
      "count": 23
    }
  ]
}
4

Rediriger vers le checkout d'abonnement

Après création de l’abonnement, vous recevrez une URL de checkout dans la charge utile de la réponse.
"checkout_session": {
  "status": "opened",
  "url": "https://billing.hyperline.co/checkout/che_hEUPdVG7IgjpW1"
}
Redirigez votre client vers cette URL pour qu’il souscrive.
5

Gérer l'abonnement

Une fois terminé, le client sera redirigé vers l’URL finale de votre côté (préalablement configurée lors de la création de l’abonnement). Le client est désormais abonné à votre service avec succès.Vous pouvez stocker cette information de votre côté ou vous reposer entièrement sur Hyperline et récupérer à tout moment le statut d’abonnement du client.
curl --request GET \
  --url https://api.hyperline.co/v1/customers/<customer ID> \
  --header 'Authorization: Bearer <token>'
{
  "id": "cus_Typ0px2W0aiEtl",
  "name": "My customer",
  "currency": "EUR",
  "subscriptions": [
    {
      "id": "sub_0kIc7jrF7gV00V",
      "status": "active"
    }
  ]
}
Si vous souhaitez récupérer la quantité des produits de l’abonnement ou les détails complets, vous pouvez utiliser l’API des abonnements.
curl --request GET \
  --url https://api.hyperline.co/v2/subscriptions/<subscription ID> \
  --header 'Authorization: Bearer <token>'
{
  "status": "active",
  "products": [
    {
      "id": "itm_4vea8Gj0a5HZr9",
      "type": "seat",
      "count": 23
    }
  ]
  // ...
}
Et voilà ! Vous pouvez ensuite poursuivre votre flux produit comme souhaité. Votre client sera automatiquement facturé et son moyen de paiement débité conformément à la configuration de l’abonnement créé.

3. Suivre l’abonnement

Vous pouvez récupérer à tout moment un lien de portail unique pour que votre client suive son abonnement, modifie son moyen de paiement ou télécharge ses factures. Nous recommandons d’ajouter un bouton dans votre produit redirigeant vers cette page pour que votre client puisse « gérer sa facturation ».
curl --request GET \
  --url https://api.hyperline.co/v1/customers/<customer ID>/portal \
  --header 'Authorization: Bearer <token>'
{
  "url": "https://..."
}
Vous pouvez également suivre et gérer les abonnements de vos clients sur Hyperline.