--- schema_version: "1" id: 44aa17b3daa0588da310b2b310cd2a48ec9e7fd93165d8d3c643addd02ef7c9e title: SubscriberPackageVersion collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_tooling/tooling_api_objects_subscriberpackageversion.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_subscriberpackageversion.htm source_site: developer.salesforce.com content_type: documentation content_hash: a72f079a53bfcca6b084b988c6d218c5c4d9aa6a95d6bc2d795695a4ca6d49e3 description: Represents a package version (first- or second-generation) across all Salesforce instances. Available in API version 41.0 and later. --- # SubscriberPackageVersion Represents a package version (first- or second-generation) across all Salesforce instances. Available in API version 41.0 and later. ## Supported SOAP Calls describeSObjects(), query(), retrieve() ## Supported REST HTTP Methods GET, Query ## Fields | Field | Details | | --- | --- | | AppExchangeDescription | Type string Properties Nillable, Sort Description The AppExchange description for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is null. | | AppExchangeLogoUrl | Type string Properties Nillable, Sort Description The URL that AppExchange uses to display the logo for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is null. | | AppExchangePackageName | Type string Properties Group, Nillable, Sort Description The AppExchange name for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is null. | | AppExchangePublisherName | Type string Properties Group, Nillable, Sort Description The AppExchange publisher name for this package. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is null. | | BuildNumber | Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is major.minor.patch.build—for example, in 1.2.0.5 the build number is 5. | | CspTrustedSites | Type [SubscriberPackageCspTrustedSites](#SubscriberPackageCspTrustedSites) Properties Nillable Description List of new Trusted URLs ([CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later.")) that the user must authorize before installing the package version. Package upgrades don't include previously installed Trusted URLs. | | Dependencies | Type [SubscriberPackageDependencies](#SubscriberPackageDependencies) Properties Nillable Description Other subscriber package versions that this subscriber package version depends on. Available in API version 44.0 and later. | | Description | Type string Properties Nillable, Sort Description Description of the package. | | InstallationKey | Type RAW Properties Not applicable Description Installation key for a key-protected package. This field is hidden. It’s not queryable, but you can include it in the WHERE clause of SOQL queries. In some queries, it’s required. To query unlocked packages that have installation keys, you must include the correct InstallationKey value in your WHERE clause. However, if the unlocked package version is already installed in your org you can query it without specifying an InstallationKey value. For managed packages, an InstallationKey value in the WHERE clause is optional. | | InstallValidationStatus | Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Status of the validation tests that are run during the package version install. Valid values are: - NoErrorsDetected - BetaInstallIntoProductionOrg - CannotInstallEarlierVersion - CannotUpgradeBeta - CannotUpgradeUnmanaged - DeprecatedInstallPackage - ExtensionsOnLocalPackages - PackageNotInstalled - PackageHasInDevExtensions - InstallIntoDevOrg - NoAccess - PackagingDisabled - PackagingNoAccess - PackageUnavailable - UninstallInProgress - UnknownError - NamespaceCollision | | IsBeta | Type boolean Properties Defaulted on create, Group, Sort Description Indicates whether the package version is released (false). | | IsDeprecated | Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether this package version has been marked as deprecated (true) or not (false). | | IsManaged | Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether this package is managed (true) or not (false). | | IsPasswordProtected | Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether installation of this package version requires the user to provide an installation key (true) or not (false). | | IsSecurityReviewed | Type boolean Properties Defaulted on create, Group, Sort Description Specifies whether the package has passed the security review required for publishing in AppExchange. | | MajorVersion | Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is major.minor.patch.build—for example, in 1.2.0.5 the major version is 1. | | MinorVersion | Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is major.minor.patch.build—for example, in 1.2.0.5 the minor version is 2. | | Name | Type string Properties Group, idLookup, Sort Description Name of the package. | | Package2ContainerOptions | Type picklist Properties Group, Nillable, Restricted picklist, Sort Description Container options for the second-generation package. These options determine the upgrade and editability rules. Valid values are: - Managed - Unlocked | | PatchVersion | Type int Properties Group, Nillable, Sort Description Part of the version number of a package version. The complete version number format is major.minor.patch.build—for example, in 1.2.0.5 the patch version is 0. | | PostInstallUrl | Type string Properties Nillable, Sort Description The fully qualified URL of the post-installation instructions. Instructions are shown as a link after installation and are available from the package detail view. | | Profiles | Type [SubscriberPackageProfiles](#SubscriberPackageProfiles) Properties Nillable Description List of profiles for which the package was installed. | | PublisherName | Type string Properties Group, Nillable, Sort Description The name of the publisher of this package. | | ReleaseNotesUrl | Type string Properties Nillable, Sort Description The fully qualified URL of the package release notes. Release notes are shown as a link during the installation process and are available from the package detail view after installation. | | ReleaseState | Type picklist Properties Group, Nillable, Restricted picklist, Sort Description If the package version is a beta version, the value is Beta. Otherwise, the value is Released. | | RemoteSiteSettings | Type [SubscriberPackageRemoteSiteSettings](#SubscriberPackageRemoteSiteSettings) Properties Nillable Description List of new Remote Site Settings that the user must authorize before installing the package. Package upgrades don’t include previously installed Remote Site Settings. | | SubscriberPackageId | Type ID Properties Group, Nillable, Sort Description ID of the parent SubscriberPackage. The ID starts with the string 033. This value is case-sensitive and must be unique. | | IsOrgDependent | Type boolean Properties Defaulted on create, Group, Sort Description Indicates whether the package depends on unpackaged metadata in the installation org (true) or not (false). This field applies to unlocked packages only. The default value is false. Available in API version 49.0 and later. | ## SubscriberPackageCspTrustedSites Represents the list of new Trusted URLs that the user must authorize before installing the package version. Available in API version 41.0 and later. In API version 58. | Field | Details | | --- | --- | | settings | Type [SubscriberPackageCspTrustedSite](#SubscriberPackageCspTrustedSite) Description List of Trusted URLs ([CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later.")) that have been added to the package. These sites must be authorized before installation. If the AppExchange listing for the package doesn’t contain a value for this field, the field’s value is null. | ## SubscriberPackageCspTrustedSite Represents a new Trusted URLs ([CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later.")) that the user must authorize before installing the package version. Available in API version 41.0 and later. | Field | Details | | --- | --- | | endpointUrl | Type string Description The URL associated with the [CspTrustedSite](https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling/tooling_api_objects_csptrustedsite.htm "Represents a trusted URL. For each CspTrustedSite, you can specify Content Security Policy (CSP) directives and permissions policy directives. Each CSP directive allows Lightning components, third-party APIs, and WebSocket connections to access a resource type from the trusted URL. If the Permissions-Policy HTTP header is enabled, each permissions policy directive grants the trusted URL access to a browser feature. In API version 58.0 and earlier, CspTrustedSite included only CSP directives and was referred to as CSP Trusted Sites in Salesforce Setup. Available in API version 39.0 and later."). | ## SubscriberPackageDependencies Represents a list of subscriber package version IDs that a subscriber package version depends on. Available in API version 44.0 and later. | Field | Details | | --- | --- | | ids | Type SubscriberPackageDependency Description List of SubscriberPackageDependency IDs: 04t IDs for the package versions that a subscriber package version depends on. | ## SubscriberPackageProfiles Represents a mapping between the profiles contained in the package and the profiles that are applied in the target subscriber org. Available in API version 41.0 and later. | Field | Details | | --- | --- | | destinationProfiles | Type [SubscriberPackageDestinationProfile](#SubscriberDestinationProfile) Description The profiles that the administrator installing the package in a target subscriber org actually applies. | | sourceProfiles | Type [SubscriberPackageSourceProfile](#SubscriberPackageSourceProfile) Description The profiles that are contained in the package that is being installed. | ## SubscriberPackageDestinationProfile Represents the profile that an administrator applies when installing the package in a target subscriber org. Available in API version 41.0 and later. | Field | Details | | --- | --- | | description | Type string Description The description of the profile. | | displayName | Type string Description The display name of this profile. | | name | Type string Description The name of the profile. | | noAccess | Type boolean Description Returns true if the profile is internal. | | profileId | Type string Description The ID of the profile. | | type | Type string Description The API name of the profile. | ## SubscriberPackageSourceProfile Represents a profile contained in the package to be installed. Available in API version 41.0 and later. | Field | Details | | --- | --- | | label | Type string Description The profile label. | | value | Type string Description The name of the profile. | ## SubscriberPackageRemoteSiteSettings Represents a list of Remote Site Settings (RSS) that have been added to the package since the last version. Available in API version 41.0 and later. | Field | Details | | --- | --- | | settings | Type [SubscriberPackageRemoteSiteSetting](#SubscriberPackageRemoteSiteSetting)[SubscriberPackageRemoteSiteSetting](#SubscriberPackageRemoteSiteSetting) Description List of RSS added to the package since the last version. | ## SubscriberPackageRemoteSiteSetting Defines a URL to an external service. The administrator of the subscriber org must authorize access to these services. Available in API version 41.0 and later. | Field | Details | | --- | --- | | secure | Type boolean Description Returns true if the URL uses the https protocol. Applies only if protocol security is enabled. | | url | Type string Description The URL of the remote service. | ## Usage Represents a version of an installable package. To query this object, include an ID (begins with 04t) in your SOQL WHERE clause. For subscriber package versions with no installation keys, queries must include an ID value, but an InstallationKey value is not required. SELECT Dependencies FROM SubscriberPackageVersion WHERE ID = '04txxxxxxxxxxxx' For unlocked package versions that have installation keys, queries must include both an ID value and an InstallationKey value. SELECT Dependencies FROM SubscriberPackageVersion WHERE ID = '04txxxxxxxxxxxx' AND InstallationKey='password123' For managed first- and second-generation package versions that have installation keys and for unlocked package versions that are installed in your org, queries must include an ID value, but an InstallationKey value is optional. SELECT Dependencies FROM SubscriberPackageVersion WHERE ID = '04txxxxxxxxxxxx' SELECT Dependencies FROM SubscriberPackageVersion WHERE ID = '04txxxxxxxxxxxx' AND InstallationKey='password123'