Skip to content
ABUNA
DocumentationApplications

Référence de l'API

Applications

Lisez l'application à laquelle appartient une clé : son mode, ses clés et ses réglages de paiement.

Voir en Markdown

Récupérez l'application de votre clé secrète, avec ses réglages de facturation et ce qui lui manque pour encaisser des paiements. Une application contient vos produits, vos prix, vos clients et vos abonnements, et possède un mode Production et un mode Test.

L'API donne à chaque mode son propre ID d'application et ses propres clés. Cette page parle donc de l'application en production et de l'application Test. Une clé secrète ne fonctionne que pour son propre mode.

L'objet app

Attributs

  • idstring

    Identifiant unique de l'application.
  • team_idstring

    L'équipe qui possède l'application.
  • namestring

    Le nom de l'application. Ses modes Production et Test le partagent.
  • slugstring

    Une forme du nom utilisable dans une URL. Le slug d'une application Test se termine par -test.
  • environmentstring

    live ou test.
  • project_idstring

    L'ID de l'application en production. Pour l'application en production, c'est son propre ID.
  • live_app_idstring

    L'ID de l'application en production. Toujours identique à project_id.
  • test_app_idstring

    L'ID de l'application Test. Pour l'application Test, c'est son propre ID. Absent quand l'application n'a pas de mode Test.
  • base_currencystring

    La devise de l'application : XAF, XOF ou USD.
  • grace_period_daysinteger

    Le délai de paiement : le nombre de jours que vous laissez à vos clients pour payer un renouvellement, de 1 à 14. Ils comptent depuis le début de la période et ne dépassent jamais sa fin. Si le renouvellement reste impayé au-delà, Abuna résilie l'abonnement et prévient le client. Les nouvelles applications démarrent à 3.
  • renewal_lead_daysinteger

    Combien de jours avant la fin d'une période payée part la facture de renouvellement, de 0 à 7, pour que le client puisse payer en avance. La nouvelle période commence quand même à la date de renouvellement, même si le client paie en avance. Avec 0, la facture part à la date de renouvellement. Elle ne part jamais avant le milieu de la période payée : sur un prix journalier, elle part donc 12 heures avant la fin. Les nouvelles applications démarrent à 3. Modifiez-le dans le tableau de bord sous Paramètres, Renouvellements et délai de paiement. Voir Renouvellements et abonnements impayés.
  • invoice_prefixstring

    Ce qui précède le compteur dans les numéros de facture de l'application, comme MYST dans MYST-000124 : 2 à 10 lettres majuscules (A à Z) ou chiffres. Les nouvelles applications démarrent avec les 4 premières lettres et chiffres du nom de l'application, ou INV quand le nom en compte moins de 2. Un changement s'applique aux factures émises ensuite. Les numéros déjà émis restent tels quels. Les modes Production et Test ont chacun leur propre valeur. Modifiez-le dans le tableau de bord sous Paramètres, Numéros de facture.
  • customer_cancelstring

    Ce qui se passe quand un client résilie depuis son espace client. at_period_end (par défaut) garde l'abonnement jusqu'à la fin de la période payée. immediate le termine maintenant. Une période impayée se termine toujours maintenant. Les modes Production et Test ont chacun leur propre valeur. Modifiez-le dans le tableau de bord sous Paramètres, Quand les clients résilient.
  • publishable_keystring

    La clé des liens d'abonnement, comme pk_test_ suivi de 48 caractères hexadécimaux.
  • secret_key_prefixstring

    Le début de la première clé secrète de l'application : son préfixe et les 8 caractères suivants.
  • webhook_urlstringnullable

    Où Abuna envoie les webhooks.
  • webhook_eventsarray

    Les types d'événements envoyés à webhook_url. La liste peut contenir des événements alors que webhook_url vaut null, mais rien n'est envoyé tant qu'aucune URL n'est définie. Retirer l'URL ne vide pas la liste. Une application créée avant le 10 octobre 2026 liste tous les types d'événements qui existaient à cette date, jusqu'à ce que vous changiez ses événements. Modifiez-les dans le tableau de bord, dans Webhooks. Voyez Choisissez vos événements.
  • webhook_configuredboolean

    true quand webhook_url est défini.
  • webhook_testedboolean

    true une fois qu'un Envoyer un événement test depuis le tableau de bord a atteint le webhook_url actuel. Changer l'URL le remet à false.
  • success_urlstringnullable

    Où la page d'abonnement envoie le client après son paiement. Une session de checkout peut définir la sienne.
  • cancel_urlstringnullable

    Où la page d'abonnement envoie le client quand il la quitte sans payer. Une session de checkout peut définir la sienne.
  • support_emailstringnullable

    L'e-mail d'assistance que voient vos clients. Les modes Production et Test le partagent. Une application en production a besoin de cet e-mail ou de support_url pour accepter des paiements.
  • support_urlstringnullable

    La page d'assistance que voient vos clients. Les modes Production et Test la partagent. Une application en production a besoin de cette page ou de support_email pour accepter des paiements.
  • terms_urlstringnullable

    La page de conditions générales que voient vos clients.
  • timezonestring

    Le fuseau horaire IANA, comme Africa/Douala, des dates et heures de chaque e-mail sur l'application. Les nouvelles applications démarrent avec Africa/Douala. Un changement de prix programmé démarre à minuit dans ce fuseau. Les modes Production et Test le partagent. Modifiez-le dans le tableau de bord sous Paramètres, Général, Fuseau horaire.
  • brandingobject

    L'apparence de vos pages clients. Les modes Production et Test la partagent.
    Afficher les attributsMasquer les attributs
    • accent_colorstringnullable

      La couleur du bouton principal, des liens et des choix sélectionnés sur vos pages d'abonnement et de paiement, l'espace client et vos factures, comme #1F6FEB. Si elle se lit mal sur la page, les liens et les contours de sélection en prennent une nuance plus foncée ou plus claire. Le texte du bouton est blanc ou noir, selon ce qui se lit le mieux. null garde les couleurs d'Abuna. Modifiez-la dans le tableau de bord sous Paramètres, Général, Image de marque.
  • telegram_updatesboolean

    Si les clients peuvent choisir Telegram pour recevoir leurs messages, sur la page d'abonnement une fois le paiement fait et dans leur espace client. Quand il vaut false, la page d'abonnement ne le propose pas et les messages Telegram s'arrêtent pour tous les clients. Ils reçoivent toujours les e-mails. Les nouvelles applications démarrent avec true. Les modes Production et Test ont chacun leur propre valeur. Modifiez-le dans le tableau de bord sous Paramètres, Général, Messages aux clients. Voyez Messages aux clients.
  • whatsapp_updatesboolean

    Si les clients peuvent choisir WhatsApp pour recevoir leurs messages, sur la page d'abonnement une fois le paiement fait et dans leur espace client. Quand il vaut false, la page d'abonnement ne le propose pas et les messages WhatsApp s'arrêtent pour tous les clients. Ils reçoivent toujours les e-mails. Les nouvelles applications démarrent avec false. En production, votre équipe doit avoir le forfait Plus ou supérieur. En mode Test, il fonctionne avec tous les forfaits. Les modes Production et Test ont chacun leur propre valeur. Modifiez-le dans le tableau de bord sous Paramètres, Général, Messages aux clients. Voyez Messages aux clients.
  • daily_remindersboolean

    Si les clients reçoivent un rappel chaque jour après la date de renouvellement jusqu'à leur paiement, et un dernier rappel la veille de la résiliation de leur abonnement. Quand il vaut false, ils ne reçoivent un message que lorsque la facture de renouvellement part et lorsque l'abonnement est résilié faute de paiement. Les nouvelles applications démarrent avec false. En production, votre équipe doit avoir le forfait Plus ou supérieur. Au forfait Free, l'application n'envoie que ces deux messages, même quand il vaut true. En mode Test, il fonctionne avec tous les forfaits. Les modes Production et Test ont chacun leur propre valeur. Modifiez-le dans le tableau de bord sous Paramètres, Général, Messages aux clients. Voyez Rappels quotidiens.
  • paymentsobject

    Si l'application peut accepter des paiements, et ce qui lui manque si ce n'est pas le cas.
    Afficher les attributsMasquer les attributs
    • readyboolean

      true quand email_verified, provider_connected et support_contact sont tous vrais.
    • email_verifiedboolean

      Si le propriétaire de l'équipe a vérifié son e-mail. Toujours vrai en mode Test.
    • provider_connectedboolean

      Si un compte de paiement est connecté. Toujours vrai en mode Test.
    • support_contactboolean

      Si l'application possède un support_email ou un support_url. Toujours vrai en mode Test.
    • providers_availableboolean

      S'il existe au moins un prestataire de paiement que vous pouvez connecter dans ce mode.
    • webhook_confirmedboolean

      Si un propriétaire de l'équipe a confirmé dans le tableau de bord que l'URL du webhook est définie chez le prestataire de paiement. Toujours vrai en mode Test.
    • webhook_receivedboolean

      Si le webhook de votre prestataire de paiement est parvenu à Abuna au moins une fois. Toujours vrai en mode Test.
    • provider_namestringnullable

      Le nom du prestataire de paiement connecté, ou Abuna avec abuna_payments.enabled. null quand aucun n'est connecté, et toujours en mode Test.
    • account_idstringnullable

      L'ID du compte de paiement qu'utilise l'application. null chaque fois que provider_name l'est, et avec abuna_payments.enabled.
    • account_namestringnullable

      Le nom de ce compte, tel qu'il apparaît sur la page Comptes de paiement de votre équipe. null chaque fois que provider_name l'est, et avec abuna_payments.enabled.
    • abuna_paymentsobject

      Paiements Abuna pour cette application : si vous pouvez l'activer, et s'il est activé.
      Afficher les attributsMasquer les attributs
      • availableboolean

        Si cette application peut activer Paiements Abuna. Toujours faux en mode Test.
      • enabledboolean

        Si Paiements Abuna est activé pour cette application. Quand il vaut true, provider_connected, webhook_confirmed et webhook_received sont vrais. Un propriétaire de l'équipe l'active dans le tableau de bord sous Paramètres, Paiements.
  • liveobject

    Où en est l'application avant de passer en production. Absent pour une application Test.
    Afficher les attributsMasquer les attributs
    • readyboolean

      true une fois que payments.ready est vrai et que payments.webhook_confirmed ou payments.webhook_received est vrai. Aucun premier paiement n'est nécessaire.
    • steps_doneinteger

      Le nombre d'étapes faites pour passer en production : le propriétaire de l'équipe vérifie son e-mail, vous connectez un compte de paiement, vous ajoutez un contact d'assistance et vous définissez l'URL du webhook chez le prestataire.
    • steps_totalinteger

      Le nombre d'étapes pour passer en production : 4.
  • read_onlyboolean

    true quand cette application en production dépasse les limites du forfait de l'équipe et passe en lecture seule. Les écritures échouent alors avec 403. Toujours faux en mode Test.
  • whatsapp_availabilityobject

    Si whatsapp_updates peut être activé.
    Afficher les attributsMasquer les attributs
    • availableboolean

      true quand l'application peut proposer les messages WhatsApp.
    • reasonstringnullable

      Pourquoi elle ne le peut pas, ou null quand elle le peut : whatsapp_unavailable quand Abuna ne peut pas envoyer de messages WhatsApp pour le moment, ou whatsapp_plan_required quand une application en production a besoin du forfait Plus ou supérieur.
  • daily_reminders_availableboolean

    Si le forfait de votre équipe permet à cette application d'envoyer des daily_reminders. Toujours vrai en mode Test.
  • bills_plansboolean

    Toujours false pour vos applications. Vous pouvez l'ignorer.
  • created_attimestamp

    Quand l'application a été créée, en secondes Unix.
L'objet app
{
  "id": "8ddhXCDW",
  "team_id": "01J9ZQ3A1B2C3D4E5F6G7H8J9K",
  "name": "My store",
  "slug": "my-store-test",
  "environment": "test",
  "project_id": "Q7mKp2Rt",
  "live_app_id": "Q7mKp2Rt",
  "test_app_id": "8ddhXCDW",
  "base_currency": "XAF",
  "grace_period_days": 3,
  "renewal_lead_days": 3,
  "invoice_prefix": "MYST",
  "customer_cancel": "at_period_end",
  "publishable_key": "pk_test_...",
  "secret_key_prefix": "sk_test_3f9c1a2b",
  "webhook_url": "https://example.com/webhooks",
  "webhook_events": ["session.completed", "subscription.paid", "subscription.canceled", "invoice.paid"],
  "webhook_configured": true,
  "webhook_tested": true,
  "success_url": null,
  "cancel_url": null,
  "support_email": "support@example.com",
  "support_url": null,
  "terms_url": null,
  "timezone": "Africa/Douala",
  "branding": {
    "accent_color": "#1F6FEB"
  },
  "telegram_updates": true,
  "whatsapp_updates": false,
  "daily_reminders": false,
  "payments": {
    "ready": true,
    "email_verified": true,
    "provider_connected": true,
    "support_contact": true,
    "providers_available": true,
    "webhook_confirmed": true,
    "webhook_received": true,
    "provider_name": null,
    "account_id": null,
    "account_name": null,
    "abuna_payments": {
      "available": false,
      "enabled": false
    }
  },
  "read_only": false,
  "whatsapp_availability": {
    "available": true,
    "reason": null
  },
  "daily_reminders_available": true,
  "bills_plans": false,
  "created_at": 1727600000
}

Récupérer une application

GET/v1/apps/{appID}

Récupère l'application à laquelle appartient votre clé secrète.

Renvoie l'objet app. Si aucune application n'a cet ID, ou si la clé appartient à une autre application, renvoie 404 avec le code not_found.

GET /v1/apps/{appID}
curl https://api.abuna.app/v1/apps/8ddhXCDW \
  -H "Authorization: Bearer sk_test_..."
Réponse
{
  "id": "8ddhXCDW",
  "team_id": "01J9ZQ3A1B2C3D4E5F6G7H8J9K",
  "name": "My store",
  "slug": "my-store-test",
  "environment": "test",
  "project_id": "Q7mKp2Rt",
  "live_app_id": "Q7mKp2Rt",
  "test_app_id": "8ddhXCDW",
  "base_currency": "XAF",
  "grace_period_days": 3,
  "renewal_lead_days": 3,
  "invoice_prefix": "MYST",
  "customer_cancel": "at_period_end",
  "publishable_key": "pk_test_...",
  "secret_key_prefix": "sk_test_3f9c1a2b",
  "webhook_url": "https://example.com/webhooks",
  "webhook_events": ["session.completed", "subscription.paid", "subscription.canceled", "invoice.paid"],
  "webhook_configured": true,
  "webhook_tested": true,
  "success_url": null,
  "cancel_url": null,
  "support_email": "support@example.com",
  "support_url": null,
  "terms_url": null,
  "timezone": "Africa/Douala",
  "branding": {
    "accent_color": "#1F6FEB"
  },
  "telegram_updates": true,
  "whatsapp_updates": false,
  "daily_reminders": false,
  "payments": {
    "ready": true,
    "email_verified": true,
    "provider_connected": true,
    "support_contact": true,
    "providers_available": true,
    "webhook_confirmed": true,
    "webhook_received": true,
    "provider_name": null,
    "account_id": null,
    "account_name": null,
    "abuna_payments": {
      "available": false,
      "enabled": false
    }
  },
  "read_only": false,
  "whatsapp_availability": {
    "available": true,
    "reason": null
  },
  "daily_reminders_available": true,
  "bills_plans": false,
  "created_at": 1727600000
}

Étapes suivantes