ONYX
Docs

Partner Plan Catalogue

Use catalogue fields, coverage, validity, status, and versioning correctly.

The partner plan catalogue defines which connectivity packages an approved partner can show.

Partners should treat the catalogue as the source of truth for package availability, coverage, data allowance, validity, and status.

Catalogue Fields

A package can include:

  • package ID
  • coverage name
  • coverage type
  • country or region
  • data allowance
  • validity period
  • package status
  • catalogue version
  • partner price fields where approved
  • policy notes where needed

Only show fields that Onyx has approved for the partner experience.

Coverage

Coverage can be country, regional, or global.

Coverage labels should match the catalogue. Partners should not rename coverage in a way that changes the user expectation.

Supported coverage does not guarantee identical signal, speed, or registration timing everywhere.

Data And Validity

Each package defines its data allowance and validity period.

Partners should show:

  • included data
  • validity period
  • coverage area
  • package status
  • activation requirements
  • any known limits

Do not describe a fixed-allowance package as unlimited.

Package Status

Package status can indicate whether the package is available, unavailable, restricted, or under review.

Partners should hide or clearly disable packages that are not currently available for purchase.

Catalogue Versions

Catalogue versions help partners keep their product display aligned with Onyx availability.

Partners should:

  • store the version used for display
  • refresh the catalogue on the agreed cadence
  • avoid selling removed packages
  • update policy notes when the version changes
  • reconcile orders against the version used at purchase

Merchandising Limits

Partners can design their own product experience, but the catalogue facts must stay intact.

Do not change coverage, validity, allowance, status, or activation requirements in customer-facing copy.