Skip to content
AcrivaDocs

GetSubscriptionUsage

GET
/api/v1/t/{tenant}/subscriptions/usage
curl --request GET \
  --url https://example.com/api/v1/t/example/subscriptions/usage

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
month
required
string
documents
required
object
used
required
integer format: int64
allowance
required
integer format: int64
thresholdReached
required
null | integer format: int32
credits
required
object
used
required
integer format: int64
allowance
required
integer format: int64
thresholdReached
required
null | integer format: int32
storage
required
object
used
required
integer format: int64
allowance
required
integer format: int64
thresholdReached
required
null | integer format: int32
documentsOverage
required
integer format: int32
documentsImported
required
integer format: int32
dataTables
required
object
used
required
integer format: int64
allowance
required
integer format: int64
thresholdReached
required
null | integer format: int32
dataTableRows
required
object
used
required
integer format: int64
allowance
required
integer format: int64
thresholdReached
required
null | integer format: int32
signaturesSes
One of:
null
signaturesAes
One of:
null
signatureQes
One of:
null
Examplegenerated
{
  "month": "example",
  "documents": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "credits": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "storage": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "documentsOverage": 1,
  "documentsImported": 1,
  "dataTables": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "dataTableRows": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "signaturesSes": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "signaturesAes": {
    "used": 1,
    "allowance": 1,
    "thresholdReached": 1
  },
  "signatureQes": {
    "attempts": 1,
    "pricePerAttemptCents": 1,
    "waived": true
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}