HonkIO Auth

Forfait et utilisation

Lisez et changez le forfait d’une application, annulez une rétrogradation prévue, et consultez ses coûts de connexion par méthode et son nombre d’utilisateurs.

Obtenir le forfait

GET/v1/auth-apps/:id/plan

Permission: auth_apps: r

Le forfait de l’application, l’état de facturation, la période en cours et tout changement prévu.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/plan \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "plan": "pro",
  "mode": "live",
  "currency": "CAD",
  "price_cents": 4900,
  "included_users": 2500,
  "overage_cents_per_user": 2.5,
  "features": {
    "email_sign_in": true,
    "passkeys": true,
    "custom_domain": true,
    "webhooks": true,
    "texts": true,
    "two_step": true,
    "organizations": false,
    "two_step_per_org_role": false,
    "voip_blocking": true
  },
  "billing": {
    "state": "ok",
    "grace_started_at": null,
    "grace_ends_at": null,
    "absorb_until": null,
    "unpaid_cents": 0,
    "sign_ups_allowed": true,
    "texts_allowed": true
  },
  "period": {
    "start": "2026-11-01T05:00:00.000Z",
    "end": "2026-12-01T05:00:00.000Z",
    "fee_cents": 4900,
    "fee_status": "charged",
    "active_users": 812
  },
  "scheduled_change": null,
  "warnings": []
}

Changer le forfait

PUT/v1/auth-apps/:id/plan

Permission: auth_apps: m

Passe l’application à un autre forfait. Une rétrogradation est prévue pour la fin du cycle, et la réponse indique ce qui sera désactivé.

Corps

Nom	Type	Description
planobligatoire	"free" \| "pro" \| "business"	Le forfait visé.
dry_run	boolean	Prévisualiser le changement et son coût sans l’appliquer.

Requête

curl -X PUT https://api.honkio.ca/v1/auth-apps/APP_ID/plan \
  -H "Authorization: Bearer mk_test_YOUR_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "plan": "free"
  }'

Réponse · 200

{
  "plan": "pro",
  "change": {
    "kind": "downgrade",
    "from": "pro",
    "to": "free",
    "effective_at": "2026-12-01T05:00:00.000Z",
    "scheduled": true,
    "charged_cents": 0,
    "dry_run": false,
    "cancelled_scheduled_change": false
  },
  "turns_off": [
    "texts",
    "two_step",
    "voip_blocking"
  ],
  "impact": {
    "turns_off": [
      "texts",
      "two_step",
      "voip_blocking"
    ],
    "users_total": 1240,
    "effects": [
      {
        "code": "texts_off",
        "users_with_phone": 310,
        "users_without_email": 12
      },
      {
        "code": "two_step_off",
        "app_requires_two_step": false
      }
    ]
  }
}

Annuler une rétrogradation prévue

DELETE/v1/auth-apps/:id/plan/scheduled

Permission: auth_apps: d

Garde le forfait actuel.

Requête

curl -X DELETE https://api.honkio.ca/v1/auth-apps/APP_ID/plan/scheduled \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

204 · Aucun contenu.

Obtenir les coûts de connexion

GET/v1/auth-apps/:id/costs

Permission: auth_apps: r

Les coûts des messages de connexion d’un mois, par méthode : courriel, texto et clé d’accès (toujours 0).

Paramètres de requête

Nom	Type	Description
month	YYYY-MM	Le mois, comme `2026-11`. Le mois en cours par défaut.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/costs?month=2026-11 \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "month": "2026-11",
  "currency": "CAD",
  "methods": [
    {
      "method": "email",
      "messages": 4120,
      "cost_cents": 4.12,
      "absorbed_messages": 0,
      "comped_messages": 0
    },
    {
      "method": "text",
      "messages": 310,
      "segments": 312,
      "cost_cents": 1023,
      "absorbed_messages": 0,
      "comped_messages": 0
    },
    {
      "method": "passkey",
      "messages": 0,
      "cost_cents": 0,
      "absorbed_messages": 0,
      "comped_messages": 0
    }
  ],
  "plan_fee_cents": 4900,
  "overage_cents": 0,
  "total_cents": 5927.12
}

Obtenir l’utilisation

GET/v1/auth-apps/:id/usage

Permission: auth_apps: r

Les utilisateurs comptés ce mois-ci par rapport à ceux inclus dans le forfait.

Requête

curl https://api.honkio.ca/v1/auth-apps/APP_ID/usage \
  -H "Authorization: Bearer mk_test_YOUR_KEY"

Réponse · 200

{
  "plan": "pro",
  "period_start": "2026-11-01T05:00:00.000Z",
  "period_end": "2026-12-01T05:00:00.000Z",
  "active_users": 812,
  "included_users": 2500,
  "percent_used": 32,
  "overage_users": 0,
  "estimated_overage_cents": 0,
  "sign_ups_paused": false,
  "billing_state": "ok",
  "total_users": 1240,
  "likely_bots": 3,
  "activity_since": "2026-11-01T05:00:00.000Z",
  "sign_ins": 2140,
  "signed_in_users": 905,
  "has_signed_in": true,
  "warnings": []
}