Lorsqu'un espace de travail atteint ses quotas ou demande une fonctionnalité réservée à un plan supérieur, vous pouvez générer par l'API un lien de paiement hébergé qui mène directement à l'écran de règlement. C'est le chemin de conversion standard : un espace en plan Free appelle POST /v1/billing/checkout-link, reçoit une URL Stripe Checkout prête à l'emploi, et l'ouvre dans son navigateur pour souscrire Pro ou Ultra. Cette page couvre la création du lien de paiement et la gestion de l'adresse de facturation (raison sociale, numéro de TVA, pays) associée à l'espace.
Générer un lien de paiement
L'endpoint crée une session Stripe Checkout en mode hébergé et renvoie une URL directement cliquable. Vous précisez le plan visé et, en option, la périodicité (monthly par défaut, ou annual pour la facturation annuelle). Le plan Pro ouvre automatiquement un essai de 14 jours ; Ultra est souscrit sans essai. La page de règlement est présentée en français et accepte les codes promotionnels.
/v1/billing/checkout-linkCrée une session Stripe Checkout et renvoie l'URL de paiement pour un upgrade vers Pro ou Ultra.Corps de la requête. Seul plan est obligatoire :
| Champ | Type | Requis | Description |
|---|---|---|---|
| plan | string | oui | Plan visé : pro ou ultra. |
| cycle | string | non | Périodicité : monthly (défaut) ou annual. |
| return_url | string | non | URL absolue (commençant par http) vers laquelle revenir après le paiement. Sert à la fois de page de succès et d'annulation. À défaut, les pages hébergées de Coffrify sont utilisées. |
Réponse. Ouvrez url dans le navigateur de l'utilisateur pour qu'il finalise son paiement :
Cas d'usage : faire payer un upgrade
Le scénario type consiste à proposer la montée en gamme quand l'espace approche d'une limite. Interrogez d'abord les quotas, puis, si la consommation est trop élevée, présentez le lien de paiement. Cet enchaînement transforme un blocage de quota en parcours d'abonnement fluide :
Adresse de facturation
Chaque espace de travail dispose d'une adresse de facturation qui alimente les factures et la TVA intracommunautaire. Vous la lisez avec GET /v1/billing/address et vous la mettez à jour avec PATCH /v1/billing/address. Renseigner ces informations avant de générer un lien de paiement garantit des factures correctes dès la première échéance.
/v1/billing/addressRécupère l'adresse de facturation et fiscale de l'espace de travail./v1/billing/addressCrée ou met à jour l'adresse de facturation. Seuls les champs fournis sont modifiés.| Champ | Type | Description |
|---|---|---|
| company_name | string | Raison sociale figurant sur les factures. |
| vat_id | string | Numéro de TVA intracommunautaire (ex. FR12345678901). |
| tax_country | string | Pays fiscal sur deux lettres (ex. FR). |
| address_line1 | string | Adresse, ligne 1. |
| address_line2 | string | Adresse, ligne 2 (complément). |
| city | string | Ville. |
| postal_code | string | Code postal. |
| country | string | Pays sur deux lettres (ex. FR). |
| billing_email | string | Adresse e-mail destinataire des factures. |
Lecture puis mise à jour. La réponse encapsule l'adresse sous la clé address ; elle vaut null tant qu'aucune adresse n'a été enregistrée. Le premier PATCH la crée, les suivants la modifient. Pour vider un champ, passez une chaîne vide ou null :
Exemple de réponse après mise à jour :