List plans handlers

Required scope: read

GET /api/v1/billing/plans

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/billing/plans' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "plans": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "base_fee": 49,
      "included_outcomes": 1.5,
      "price_per_outcome": 1.5,
      "features": []
    }
  ]
}

Required scope: read

Response

object

plans · object[] · required

Show plans

id · string · required

name · string · required

base_fee · number · required

included_outcomes · number · required

price_per_outcome · number · required

features · string[] · required

Status codes

Code	Meaning
200	The plan catalog — a static list served by the API itself
401	Unauthorized — missing or invalid credentials
403	Forbidden — the key/token lacks the required scope
429	Rate limited — see Retry-After / X-RateLimit-Reset

cURL

curl --request GET \
  --url 'https://api.nsr.stateset.com/api/v1/billing/plans' \
  --header "X-API-Key: $STATESET_NSR_API_KEY"

200

{
  "plans": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Two-Person Tent",
      "base_fee": 49,
      "included_outcomes": 1.5,
      "price_per_outcome": 1.5,
      "features": []
    }
  ]
}