List all plans

Returns a list of plans. The plans are returned sorted by creation date in ascending order.

GET/v3/plans

Query parameters

pageinteger

The page number.

Range: [1, 2147483647]Format: int32

limitinteger

The number of records per page. Must be a number between 1 and 100.

Range: [1, 100]Format: int32

sortstring

The sort string to sort the returned records e.g. "-createdAt"

Pattern: ([+-]\w*\.*\w*){1}(\|[+-]\w*){0,5}

searchstring

Search string.

Length: [0,256]

idobject

ID of the resource.

createdAtobject

Date of creation

updatedAtobject

Date of last update

Response

200 OK

idstringrequired
namestringrequired
displayNamestringrequired
versionintegerrequired

Format: int32

tierintegerrequired

Format: int32

intervalstringrequired
paddleIdstringrequired
paddlePriceIdstringrequired
allowedUsersintegerrequired

Format: int32

allowedOrganizationsintegerrequired

Format: int32

allowedTeamMembersintegerrequired

Format: int32

allowedProductsintegerrequired

Format: int32

allowedMeterAttributesintegerrequired

Format: int32

allowedCustomAttributesintegerrequired

Format: int32

allowedActivationRulesintegerrequired

Format: int32

allowedFeatureFlagsintegerrequired

Format: int32

allowedFeaturesintegerrequired

Format: int32

allowedActivationsintegerrequired

Format: int32

allowedMonthlyApiRequestsintegerrequired

Format: int32

allowedTrialActivationsintegerrequired

Format: int32

allowedReleasesintegerrequired

Format: int32

allowedEnvironmentsintegerrequired

Format: int32

allowedProductSpaceintegerrequired

Format: int64

allowSendingDomainbooleanrequired
amountstringrequired
allowCustomerPortalAccessbooleanrequired
allowOrganizationAdminsbooleanrequired
allowOfflineActivationsbooleanrequired
allowHostedFloatingLicensesbooleanrequired
allowOnPremiseFloatingLicensesbooleanrequired
allowCustomDomainbooleanrequired
allowResellersbooleanrequired
allowSsobooleanrequired
allowCustomRolesbooleanrequired
allowLegacyCustomRolesbooleanrequired
allowEventLogsbooleanrequired
allowAuditLogsbooleanrequired
allowCustomEmailTemplatesbooleanrequired
allowMaintenancePoliciesbooleanrequired
allowActivationLogsbooleanrequired
activationLogsRetentionPeriodstringrequired
releaseDownloadEventsRetentionPeriodstringrequired
activationEventsRetentionPeriodstringrequired
deprecatedbooleanrequired
createdAtstringrequired

Format: date-time

updatedAtstringrequired

Format: date-time