Skip to main content
Version: Next

UserPlan

The subscription plan a user is on, with the quotas it grants.

Hierarchy

  • Omit<Schemas[UserPlan], keyof UserPlanRePointed>
  • UserPlanRePointed
    • UserPlan

Index

Properties

Properties

optionalinheritedapiRateLimitBoosts

apiRateLimitBoosts?: number
0

optionalinheritedavailableAddOns

availableAddOns?: string[]
[]

inheritedavailableProxyGroups

availableProxyGroups: Record<string, number>

optionalinheriteddataRetentionDays

dataRetentionDays?: number
14

optionalinheriteddescription

description?: string
Cost-effective plan for freelancers, developers and students.

optionalinheritedenabledPlatformFeatures

enabledPlatformFeatures?: string[]
[
      "ACTORS",
      "STORAGE",
      "PROXY_SERPS",
      "SCHEDULER",
      "WEBHOOKS"
    ]

optionalinheritedforceBillingInterval

forceBillingInterval?: string
ANNUAL

If set, the plan can be subscribed only in this billing interval.

optionalinheritedid

id?: string
Personal

optionalinheritedisEnabled

isEnabled?: boolean
true

optionalinheritedisPayingCustomer

isPayingCustomer?: boolean
false

Marks the user as a paying customer even without a subscription.

optionalinheritedlegacyPlanId

legacyPlanId?: string
STARTER

ID of the legacy plan this plan was migrated from.

optionalinheritedmaxActorCount

maxActorCount?: number
100

optionalinheritedmaxActorMemoryGbytes

maxActorMemoryGbytes?: number
32

optionalinheritedmaxActorTaskCount

maxActorTaskCount?: number
1000

optionalinheritedmaxConcurrentActorRuns

maxConcurrentActorRuns?: number
25

optionalinheritedmaxMonthlyActorComputeUnits

maxMonthlyActorComputeUnits?: number
1000

optionalinheritedmaxMonthlyExternalDataTransferGbytes

maxMonthlyExternalDataTransferGbytes?: number
1000

optionalinheritedmaxMonthlyProxySerps

maxMonthlyProxySerps?: number
30000

optionalinheritedmaxMonthlyResidentialProxyGbytes

maxMonthlyResidentialProxyGbytes?: number
10

optionalinheritedmaxMonthlyUnblockerUnits

maxMonthlyUnblockerUnits?: number
1000000

optionalinheritedmaxMonthlyUsageUsd

maxMonthlyUsageUsd?: number
9999

optionalinheritedmaxPublicActorTaskCount

maxPublicActorTaskCount?: number
100

optionalinheritedmaxPublicActorTaskCountPerActor

maxPublicActorTaskCountPerActor?: number
10

optionalinheritedmaxScheduleCount

maxScheduleCount?: number
100

optionalinheritedmonitoringLevel

monitoringLevel?: null | STANDARD
STANDARD
@enum {string|null}

Level of monitoring services included in the plan. null or missing means the plan includes no monitoring service.

optionalinheritedmonthlyBasePriceUsd

monthlyBasePriceUsd?: number
49

optionalinheritedmonthlyUsageCreditsUsd

monthlyUsageCreditsUsd?: number
49

optionalinheritedoverageThresholdUsd

overageThresholdUsd?: number
500

Mid-cycle overage threshold above which the user is billed for the current-cycle overage.

optionalinheritedpersonalizedSupport

personalizedSupport?: null | string
4h/M

Hours of personalized support with Apify engineers included in the plan, as Nh/P: N hours per period P, where P is M (monthly), Q (quarterly), B (every 6 months) or A (annually), for example 1h/M. null or missing means the plan includes no personalized support.

optionalinheritedplanPricing

planPricing?: {}

Type declaration

    Pricing details for this plan.

    optionalinheritedplanTags

    planTags?: string[]
    []

    optionalinheritedplanVersion

    planVersion?: number
    2

    Version of the plan definition.

    optionalinheritedsupportLevel

    supportLevel?: string
    COMMUNITY

    optionalinheritedteamAccountSeatCount

    teamAccountSeatCount?: number
    1

    optionalinheritedtier

    tier?: string
    FREE

    optionalinheritedusageDiscountPercent

    usageDiscountPercent?: number
    0
    Page Options