v1

latestOpenAPI 3.0.32026-07-14265579.8 KB

Package

Retrieve a package resource by package type

Retrieve package resource is used to retrieve all active packages for an account.

get/package/{packageType}

Path parameters

packageTypestring required

Package type.

Response

Success Response

idstring

packageCodestring

packageNamestring

packageTypestring

titlestring

packagePricenumber

scoringOnboolean

createdstring date-time

createdBystring

Example response

{
  "id": "5e837e24498e441cd59c3fbb",
  "packageName": "Basic Package HQ",
  "packageType": "BASIC_PACKAGE_HQ",
  "packagePrice": 10,
  "products": [
    {
      "productType": "9PK",
      "productTypeDesc": "CUSTOMIZED PACKAGE",
      "country": "US",
      "region": "NA"
    }
  ]
}