Passer au contenu principal

​
Endpoints

MéthodeEndpoint
GET/api/v1/billing/plans
GET/api/v1/billing/subscription
GET/api/v1/billing/usage
GET/api/v1/billing/payments
GET/api/v1/usage
Le billing public via API key est en lecture seule. Les actions sensibles comme checkout, annulation ou downgrade se font depuis le dashboard.
Les lectures billing (/me, /usage, /billing/subscription, /billing/usage, /billing/payments) exigent une clé API personnelle (msgf_live_…). Une clé d’équipe (msgf_team_…) est rejetée en 403 TEAM_KEY_NOT_ALLOWED. Pour des données billing d’équipe, utilisez l’API console avec Authorization: Bearer <jwt> et l’en-tête optionnel X-Team-Id — voir Team context.

​
Paramètres

Ces routes sont toutes en GET.
EndpointQuery paramsBody
/api/v1/billing/plansaucunaucun
/api/v1/billing/subscriptionaucunaucun
/api/v1/billing/usageaucunaucun
/api/v1/usageaucunaucun
/api/v1/billing/paymentspage, limitaucun

​
Lister les plans

curl https://srv.msgflash.com/api/v1/billing/plans \
  -H "x-api-key: msgf_live_your_api_key_here"

​
Réponse succès

{
  "data": [
    {
      "code": "pro",
      "name": "Pro",
      "priceEur": 19,
      "limits": {
        "maxInstances": 5,
        "maxApiKeys": 5,
        "maxWebhookEndpoints": 15,
        "monthlyOutboundQuota": 50000,
        "monthlyApiRequestQuota": 150000
      },
      "features": {
        "campaigns": true,
        "statuses": false,
        "voiceNotes": true,
        "webhooks": true,
        "numberLookups": true
      }
    }
  ]
}
Voir Plans et quotas pour le comparatif Free / Pro / MAX (EUR uniquement).

​
Souscription courante

curl https://srv.msgflash.com/api/v1/billing/subscription \
  -H "x-api-key: msgf_live_your_api_key_here"
Exemple : 
{
  "data": {
    "subscription": {
      "plan": {
        "code": "pro",
        "name": "Pro",
        "limits": {
          "maxInstances": 5,
          "maxApiKeys": 5,
          "maxWebhookEndpoints": 15
        },
        "features": {
          "campaigns": true,
          "statuses": false,
          "webhooks": true
        }
      },
      "scheduledPlan": null,
      "scheduledPlanAt": null,
      "scheduledAction": null
    },
    "usage": {
      "messagesCount": 0,
      "statusesCount": 0,
      "effectiveOutboundUsage": 0,
      "apiRequestsCount": 0,
      "activeInstancesCount": 1,
      "activeApiKeysCount": 1
    },
    "period": {
      "start": "2026-04-01T00:00:00.000Z",
      "end": "2026-04-30T23:59:59.999Z"
    }
  }
}
Les limites se lisent dans subscription.plan.limits.*, pas dans subscription.plan.maxInstances.
Le plan Free autorise 1 clé API de test. Cette ouverture ne change pas le quota outbound Free: 20 messages + statuts par mois.

​
Usage enrichi

curl https://srv.msgflash.com/api/v1/billing/usage \
  -H "x-api-key: msgf_live_your_api_key_here"
Cet endpoint renvoie :
  • le plan courant
  • les limites
  • les features
  • l’usage du mois
  • la période de facturation

​
Historique des paiements

curl "https://srv.msgflash.com/api/v1/billing/payments?page=1&limit=20" \
  -H "x-api-key: msgf_live_your_api_key_here"
Réponse : 
{
  "data": {
    "payments": [
      {
        "id": "pay_uuid",
        "provider": "dodo",
        "planCode": "pro",
        "planName": "Pro",
        "amount": 1900,
        "currency": "EUR",
        "status": "succeeded",
        "periodStart": "2026-04-01T09:43:13.737Z",
        "periodEnd": "2026-05-01T09:43:13.737Z",
        "createdAt": "2026-04-01T09:43:13.745Z"
      }
    ],
    "total": 1,
    "page": 1,
    "totalPages": 1
  }
}

​
Paramètres query

ParamètreTypeRequisDescription
pageintegernonDéfaut 1
limitintegernonDéfaut 20, max 100

​
Erreurs courantes

CodeHTTPQuand
UNAUTHORIZED401Clé invalide ou absente
TEAM_KEY_NOT_ALLOWED403Clé d’équipe utilisée sur une route billing réservée au personnel
API_RATE_LIMIT_EXCEEDED429Trop de requêtes par seconde