Skip to main content
GET
/
billing
/
subscription
/
usage
Get subscription usage
curl --request GET \
  --url https://nimbussuite.com/api/v1/billing/subscription/usage \
  --header 'Authorization: Bearer <token>'
{
  "userPlanLimit": 123,
  "orgPlanLimit": 123,
  "userPlanName": "<string>",
  "orgPlanName": "<string>",
  "combinedUsage": 123,
  "monthlyScans": [
    {
      "id": "<string>",
      "domain": "<string>",
      "status": "<string>",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Subscription usage details

userPlanLimit
number
orgPlanLimit
number
userPlanName
string
orgPlanName
string
combinedUsage
number
monthlyScans
object[]