Zum Inhalt springen
AcrivaDocs

SetPlatformTrial

PUT
/api/v1/platform/tenants/{tenantId}/subscription/trial
curl --request PUT \
  --url https://example.com/api/v1/platform/tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/subscription/trial \
  --header 'Content-Type: application/json' \
  --data '{ "endsOn": "2026-04-15", "version": 1 }'

Parameters

Abschnitt betitelt „ Parameters “

Path Parameters

Abschnitt betitelt „Path Parameters“
tenantId
required
string format: uuid

Request Bodyrequired

Abschnitt betitelt „Request Bodyrequired“
Media typeapplication/json
object
endsOn
required
string format: date
version
required
integer format: uint32
Examplegenerated
{
  "endsOn": "2026-04-15",
  "version": 1
}

Responses

Abschnitt betitelt „ Responses “

200

Abschnitt betitelt „200“

OK

Media typeapplication/json
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
Example
{
  "plan": {
    "key": "Starter",
    "signaturesAesPerMonth": 0,
    "signaturesAesPackSize": 0,
    "signatureQesMarkupPercent": 0
  },
  "state": "Trial",
  "addOns": [
    {
      "kind": "PublicApi"
    }
  ]
}

400

Abschnitt betitelt „400“

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Abschnitt betitelt „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

Abschnitt betitelt „404“

Not Found

409

Abschnitt betitelt „409“

Conflict

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

Abschnitt betitelt „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"
}