minimusdocs
Help center

Packages

Get a package

GET/management/packages/{id}/

read Read: looks, changes nothing. Scopes

One package, with its bouquets.

Path parameters

  • idstring (uuid)required

    A UUID string identifying this Package.

Response

200 OK

  • idstring (uuid)requiredread-only
  • namestringrequired
  • descriptionstringcan be null
  • is_enabledboolean
  • is_trialboolean

    Trial package: lines created from it are marked as trials.

  • credit_coststring (decimal)

    What a reseller pays, in credits, for a line on this package (new or extended). 0 = free. A reseller's own price, when one is set, is used instead.

  • duration_valueinteger

    Duration value (number of hours or days)

  • duration_typestring
    • hours - Hours
    • days - Days
    • weeks - Weeks
    • months - Months

    One of: "hours" "days" "weeks" "months"

  • max_connectionsinteger

    Simultaneous connections granted to lines created from this package.

  • is_restreamerboolean

    Authorized-restream package: lines are marked as restreamers.

  • forced_countriesstring

    Comma-separated ISO country codes (e.g. FR,MA). Empty = no country restriction.

  • lock_to_ispboolean

    Lock the line to the ISP seen on its first connection.

  • forced_serverstring (uuid)can be null

    Force lines to stream from this server instead of auto routing.

  • forced_server_namestringrequiredread-only
  • output_formatsstring

    Comma-separated allowed delivery formats (hls, mpegts, rtmp). Empty = all.

  • allowed_groupsinteger[]

    Groups that can assign this package to line users

  • allowed_groups_dataobject[]requiredread-only
    • idintegerrequired
    • namestringrequired
  • bouquetsstring (uuid)[]

    Bouquets included in this package

  • bouquets_dataobject[]requiredread-only
    • idstring (uuid)requiredread-only
    • namestringrequired
    • descriptionstringcan be null
    • is_activeboolean
    • orderinteger

      Display order (lowest first). Ties fall back to name.

    • streams_countintegerrequiredread-only
    • movies_countintegerrequiredread-only
    • series_countintegerrequiredread-only
    • created_bystring (uuid)requiredread-onlycan be null
    • created_by_usernamestringrequiredread-only
    • created_atstring (date-time)requiredread-only
    • updated_atstring (date-time)requiredread-only
  • bouquet_idsstring[]requiredread-only
  • my_pricestringrequiredread-onlycan be null
  • my_price_sourcestringrequiredread-onlycan be null
  • parent_packagesstring (uuid)[]

    Parent packages this package derives bouquets from (for super resellers)

  • parent_packages_dataobject[]requiredread-only
    • idstring (uuid)required
    • namestringrequired
  • created_bystring (uuid)requiredread-onlycan be null

    User who created this package

  • created_by_usernamestringrequiredread-only
  • created_atstring (date-time)requiredread-only
  • updated_atstring (date-time)requiredread-only

Errors

  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means