Get additional user-license state

gethttps://api.expiryedge.com/v1/additionalLicenses
any role60/min
Request
curl 'https://api.expiryedge.com/v1/additionalLicenses' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"
Response
{
  "planName": "Starter Lite",
  "isTrial": false,
  "baseBillingPeriod": "month",
  "allowedPeriods": [
    "month",
    "year"
  ],
  "prices": {
    "month": {
      "unit_amount": 1000,
      "currency": "USD",
      "display": "10.00"
    },
    "year": {
      "unit_amount": 10000,
      "currency": "USD",
      "display": "100.00"
    }
  },
  "current": {
    "count": 2,
    "period": "month",
    "status": "active",
    "stripe_subscription_id": "sub_1QgA9bNorthwind",
    "last_invoice_at": "2026-09-15T00:00:00.000Z",
    "next_invoice_at": "2026-10-15T00:00:00.000Z",
    "cancel_at_period_end": false
  },
  "seats": {
    "active_users": 6,
    "base_user_limit": 5,
    "effective_limit": 7,
    "min_allowed_extra": 1
  }
}

Base plan, purchasable periods, per-seat prices, the current additional-licenses subscription and seat math.

Returns

200
Current state.
  • planNamestring
  • isTrialboolean
  • baseBillingPeriodstring
    Allowedmonthyear
  • allowedPeriodsarray of string
    Empty on Trial; yearly plans can only buy yearly seats.
    Allowedmonthyear
  • pricesobject
  • currentobject
  • seatsobject

Errors

400
The request is missing required fields or contains invalid values.
401
Missing, expired or invalid bearer token.
429
Too many requests for this endpoint from your IP. Wait Retry-After seconds.
500
Unexpected server error. Retry later; quote requestId to support.