Skip to content
KynectLocal Docs

Get license usage and limits

GET
/v1/brands/{brandId}/license
 
curl --request GET \
  --url https://kynectlocal-production.up.railway.app/v1/v1/brands/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/license \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
brandId
required
string format: uuid

Brand identifier

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

Media type application/json
object
data
required
object
tier
required

License tier: core | pro | enterprise

string
limits
required

Meter limits per tier

object
key
additional properties
usage
required

Current usage per meter

object
key
additional properties
overages
required

Active overage entries

Array
Example generated
{
  "data": {
    "tier": "example",
    "limits": {
      "additionalProperty": "example"
    },
    "usage": {
      "additionalProperty": "example"
    },
    "overages": [
      "example"
    ]
  }
}

400

Section titled “400 ”

Validation error

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

401

Section titled “401 ”

Unauthenticated

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

403

Section titled “403 ”

Forbidden

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

404

Section titled “404 ”

Not found

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}

422

Section titled “422 ”

Unprocessable

Media type application/json
object
error
required

Error envelope

object
code
required

Machine-readable error code

string
message
required

Human-readable error description

string
details

Additional context, e.g. validation field errors

Example generated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": "example"
  }
}