Skip to main content
GET
/
api
/
v1
/
subscription
/
{id}
get entity by id
curl --request GET \
  --url https://api.example.com/api/v1/subscription/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 1,
  "createdAt": 123,
  "updatedAt": 123,
  "status": "ACTIVE",
  "tenantId": 123,
  "startDate": 123,
  "expirationDate": 123,
  "plan": {
    "id": 1,
    "createdAt": 123,
    "updatedAt": 123,
    "status": "ACTIVE",
    "name": "<string>",
    "maxUsers": 123,
    "maxContracts": 123,
    "maxProjects": 123,
    "maxTriggers": 123,
    "maxDetectors": 123,
    "maxWallets": 123,
    "maxActions": 123,
    "maxApiKeys": 123,
    "detectorRateLimit": 123,
    "detectorRateLimitDuration": 123
  },
  "notifyBeforeExpireDays": [
    123
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.extractor.live/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

Authentication

Path Parameters

id
integer<int64>
required

Response

200 - application/json

OK

id
integer<int64>

Unique identifier of the entity

Example:

1

createdAt
integer<int64>

Time when entity was created

updatedAt
integer<int64>

Time when entity was updated

status
enum<string>

Status of the entity. Default: 'ACTIVE'

Available options:
ACTIVE,
DISABLED,
DELETED
tenantId
integer<int64>

ID of the tenant

startDate
integer<int64>

The start date of the subscription. Default now()

expirationDate
integer<int64>

The expiration date of the subscription.

plan
object

The plan details associated with the subscription.

notifyBeforeExpireDays
integer<int32>[]

A set of values, each specifies how many days before the subscription expiration the user will receive an email notification.