SubscriptionPlans

SubscriptionPlans

GetSubscriptionPlan

Returns a subscription plan. Not all subscriptions can be issued for customer.

Request

GET /api/manage/v1/SubscriptionPlans/{id}

Parameters

Name	Type	Value	Notes
*id	string		Identifier of subsctiption plan

Responses

Status Code	Description	Samples
200	Succesfully returned
400	The request is wrong
404	Subscription plan with this id is not found

GetSubscriptionPlans

Returns a list of active subscription plans that can be issued to the user.

If no active subscription plans, then the endpoint will return empty list

Request

GET /api/manage/v1/SubscriptionPlans[?skip&take]

Parameters

Name	Type	Value	Notes
skip	integer	0	Variable for pagination, default value is 0
take	integer	10	Variable for pagination, default value is 10

Responses

Status Code	Description	Samples
200	Succesfully returned
400	The request is wrong

Definitions

SubscriptionPlanVM

Name	Type	Notes
id	string
isActive	boolean
displayName	string
timePeriodType	TimePeriodType
timePeriod	integer (int32)
readonlyTimeLimitType	TimePeriodType
readonlyTimeLimit	integer (int32)
templatesSpaceLimit	integer (int64)
reportsSpaceLimit	integer (int64)
exportsSpaceLimit	integer (int64)
fontsSpaceLimit	integer (int64)
fileUploadSizeLimit	integer (int64)
dataSourceLimit	integer (int32)
maxUsersCount	integer (int32)
groupLimit	integer (int32)
onlineDesigner	boolean
isDemo	boolean
urlToBuy	string
unlimitedPage	boolean
pageLimit	integer (int32)
tasks	TaskSettingsVM[]
$t	string

TimePeriodType

Enum Values

Second
Minute
Hour
Day
Week
Month
Year

TaskSettingsVM

Name	Type	Notes
isSchedulerEnabled	boolean
prepare	boolean
exportTemplate	boolean
exportReport	boolean
sendViaEmail	boolean
uploadToFTP	boolean
uploadToS3	boolean
uploadToTelegram	boolean
sendViaWebhook	boolean
fetchData	boolean
thumbnailReport	boolean
thumbnailTemplate	boolean
$t	string

ProblemDetails

Name	Type	Notes
type	string
title	string
status	integer (int32)
detail	string
instance	string

SubscriptionPlansVM

Name	Type	Notes
subscriptionPlans	SubscriptionPlanVM[]
count	integer (int64)
skip	integer (int32)
take	integer (int32)
$t	string