Skip to content
AcrivaDocs

GetPlatformSubscription

GET
/api/v1/platform/tenants/{tenantId}/subscription
curl --request GET \
  --url https://example.com/api/v1/platform/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscription

Parameters

Section titled “ Parameters ”

Path Parameters

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

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
tenantId
required
string format: uuid
tenant
required
object
name
required
string
slug
required
string
status
required
Allowed values: Active Suspended
suspensionCase
required
null | string format: uuid
suspensionReason
required
null | string
createdAt
required
string format: date-time
members
required
null | integer format: int32
subscription
required
object
plan
required
object
key
required
Allowed values: Starter Business Enterprise Trial
version
required
integer format: int32
name
required
string
pricePerFullSeatCents
required
integer format: int32
tenantMinimumCents
required
integer format: int32
includedFullSeats
required
integer format: int32
documentsPerFullUser
required
integer format: int32
minDocumentsPerMonth
required
integer format: int32
creditsPerFullUser
required
integer format: int32
fullSeatCap
required
integer format: int32
storageBytes
required
integer format: int64
flags
required
Array<string>
pipelineShare
required
integer format: int32
trialDays
required
null | integer format: int32
dataTables
required
integer format: int32
dataTableRows
required
integer format: int64
signaturesAesPerMonth
integer format: int32
0
signaturesAesPackSize
integer format: int32
0
signatureQesMarkupPercent
integer format: int32
0
state
required
Allowed values: Trial Active ReadOnly
trialEndsOn
required
null | string format: date
seats
required
object
full
required
integer format: int32
openFullInvitations
required
integer format: int32
fullCap
required
integer format: int32
aboveCap
required
boolean
approver
required
integer format: int32
advisor
required
integer format: int32
addOns
required
Array<object>
object
kind
required
Allowed values: PublicApi WorkflowDesigner IntelligenceChat IntelligenceSummaries IntelligenceAssistant ESignature DocumentPack CreditPack StoragePack SignaturePack
booked
required
boolean
startsOn
required
null | string format: date
endsOn
required
null | string format: date
priceEstimate
required
object
fullSeatsBilled
required
integer format: int32
perFullSeatCents
required
integer format: int32
monthlyCents
required
integer format: int32
minimumApplied
required
boolean
version
required
integer format: uint32
usage
required
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
quotaOverrides
required
Array<object>
object
id
required
string format: uuid
quota
required
Allowed values: Documents Credits Storage FullSeats DataTables DataTableRows SignaturesSes SignaturesAes
amount
required
integer format: int64
startsOn
required
string format: date
endsOn
required
string format: date
note
required
string
createdBy
required
string format: uuid
createdAt
required
string format: date-time
flags
required
Array<object>
object
flag
required
string
mode
required
Allowed values: Inherit On Off
effective
required
boolean
signatures
One of:
null
Example
{
  "tenant": {
    "status": "Active"
  },
  "subscription": {
    "plan": {
      "key": "Starter",
      "signaturesAesPerMonth": 0,
      "signaturesAesPackSize": 0,
      "signatureQesMarkupPercent": 0
    },
    "state": "Trial",
    "addOns": [
      {
        "kind": "PublicApi"
      }
    ]
  },
  "quotaOverrides": [
    {
      "quota": "Documents"
    }
  ],
  "flags": [
    {
      "mode": "Inherit"
    }
  ]
}

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"
}

404

Section titled “404”

Not Found

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"
}