Plans

Retrieve a plan

Retrieves the details of an existing plan.

get/v3/plans/{id}

Path parameters

idstring required

Unique identifier for the plan.

Response

OK

idstring required
namestring required
displayNamestring required
versioninteger required
tierinteger required
intervalstring required
paddleIdstring required
paddlePriceIdstring required
allowedUsersinteger required
allowedOrganizationsinteger required
allowedTeamMembersinteger required
allowedProductsinteger required
allowedMeterAttributesinteger required
allowedCustomAttributesinteger required
allowedActivationRulesinteger required
allowedFeatureFlagsinteger required
allowedFeaturesinteger required
allowedActivationsinteger required
allowedMonthlyApiRequestsinteger required
allowedTrialActivationsinteger required
allowedReleasesinteger required
allowedEnvironmentsinteger required
allowedProductSpaceinteger required
allowSendingDomainboolean required
amountstring required
allowCustomerPortalAccessboolean required
allowOrganizationAdminsboolean required
allowOfflineActivationsboolean required
allowHostedFloatingLicensesboolean required
allowOnPremiseFloatingLicensesboolean required
allowCustomDomainboolean required
allowResellersboolean required
allowSsoboolean required
allowCustomRolesboolean required
allowLegacyCustomRolesboolean required
allowEventLogsboolean required
allowAuditLogsboolean required
allowCustomEmailTemplatesboolean required
allowMaintenancePoliciesboolean required
allowActivationLogsboolean required
activationLogsRetentionPeriodstring required
releaseDownloadEventsRetentionPeriodstring required
deprecatedboolean required
createdAtstring date-time required
updatedAtstring date-time required

Changes

Changed in 1 of the 2 revisions of this API.4

    • added the required property allowedActivationRules to the response with the 200 status

      response-required-property-added

    • added the required property allowedCustomAttributes to the response with the 200 status

      response-required-property-added

    • added the required property allowedEnvironments to the response with the 200 status

      response-required-property-added

    • added the required property allowedMonthlyApiRequests to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog