---
title: "Describe a package plan"
method: GET
path: "/orgs/{orgId}/packagePlans/{packagePlanId}"
tags: ["orgs/packagePlans"]
---

# Describe a package plan

`GET /orgs/{orgId}/packagePlans/{packagePlanId}`

__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-dash:w,o{params.orgId}-dash:r,o{params.orgId}-user:w,o{params.orgId}-user:r,o{params.orgId}-site:w,o{params.orgId}-site:r,o{params.orgId}-rpt:w,o{params.orgId}-rpt:r,o{params.orgId}-hw:w,o{params.orgId}-hw:r,o{params.orgId}-admin:w,o{params.orgId}-admin:r,o:w,o:r,o-basic:w,o-basic:r,s-o:w,s-o:r<br/><br/>__Endpoint name__: describeOrgPackagePlan

## Path parameters

- `orgId` integer, required
- `packagePlanId` integer, required

## Response `200`

Successful

- object
  - `data` object
    - `id` number, required
    - `package` object
      - `id` number, required
      - `name` string
      - `startDate` string, date, nullable
      - `endDate` string, date, nullable
      - `canOptInSelf` boolean
      - `canOptInRoot` boolean
      - `canOptInParentOrg` boolean
      - `isAutoManaged` boolean
      - `isAutoManagedForLicenses` boolean
      - `parentPackages` object[]
        - `id` number, required
        - `name` string
      - `subPackages` object[]
        - `id` number, required
        - `name` string
      - `conflictingPackages` object[]
        - `id` number, required
        - `name` string
      - `packageFeatures` object[]
        - `id` number, required
        - `config` object, nullable
        - `feature` object
          - `id` number, required
          - `name` string
          - `code` string
          - `singular` string, nullable
          - `plural` string, nullable
          - `isBinary` boolean
        - `isBillable` boolean
    - `isSelected` boolean
    - `netsuitePlan` object
      - `currency` string, required
      - `interval` string, required
      - `interval_count` integer, required
      - `PricePlanId` integer
      - `tiers` object[]
        - `fromqty` integer
        - `value` number
        - `fixedAmount` boolean
    - `stripePlan` object, nullable
      - `id` string
      - `product` string
      - `amount` number, nullable
      - `currency` string, required
      - `interval` string, required
      - `interval_count` number, required
    - `softwareLicense` object, nullable
      - `id` number, required
      - `sku` string
      - `billableQuantity` integer
      - `softwareLicenseOffers` object[], nullable
        - `id` number, required
        - `type` 'trial' | 'promo', required
        - `subscriptionTermOverride` number, nullable
        - `defaultIntervalTerm` 'month' | 'day' | 'year', required
        - `defaultIntervalDuration` number, required
        - `maxDaysAllowed` number, required
        - `maxQuantityAllowed` number, nullable
      - `packagePlans` object[], nullable
        - `id` number, required
        - `ordinal` integer
        - `intervalUnit` string, nullable
        - `intervalCount` integer, nullable
        - `currencyCode` string, nullable
        - `package` object
          - `id` number, required
          - `name` string
          - `startDate` string, date, nullable
          - `endDate` string, date, nullable
          - `canOptInSelf` boolean
          - `canOptInRoot` boolean
          - `canOptInParentOrg` boolean
          - `isAutoManaged` boolean
          - `isAutoManagedForLicenses` boolean
          - `parentPackages` object[]
            - `id` number, required
            - `name` string
          - `subPackages` object[]
            - `id` number, required
            - `name` string
          - `conflictingPackages` object[]
            - `id` number, required
            - `name` string
          - `packageFeatures` object[]
            - `id` number, required
            - `config` object, nullable
            - `feature` object
              - …
            - `isBillable` boolean
        - `softwareLicense` object, nullable
          - `id` number, required
          - `sku` string
          - `billableQuantity` integer
  - `meta` object
    - `accessToken` object, nullable
      - `scopeUpdatedAt` string, date
    - `siteSpecificAccess` object, nullable
      - `isSiteSpecific` boolean
      - `siteIds` integer[], nullable
      - `siteIdsByScope` object, nullable
        - `string` integer[], nullable

---

[API](https://skmtc.net/openpath/apis/openpath-api-documentation.md) · [All operations](https://skmtc.net/openpath/apis/openpath-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/openpath/openpath-api-documentation/revisions/d8a888c114fa/schema)