Partner Plan Catalogue defines how partners display Onyx connectivity packages.
Use it to present coverage, data allowance, validity, package status, available pricing fields, activation requirements, and policy notes accurately in your customer experience.
The catalogue is the source of truth. Your app should not invent package names, change coverage, hide validity, or keep selling packages that have been removed.
Catalogue Fields
A package record defines:
- public package ID
- coverage name
- coverage type
- country or region
- data allowance
- validity period
- package status
- catalogue version
- available commercial fields
- policy notes when needed
Only show fields that Onyx has enabled for the partner experience.
Coverage
Coverage can be country, regional, or global.
Coverage labels should match the catalogue. Do not rename coverage in a way that changes the customer 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.
Show included data, validity period, coverage area, package status, activation requirements, and policy notes before purchase.
Do not describe a fixed-data package as unlimited.
Package Status
Package status tells your system whether a package can be sold.
Current public statuses are active and limited.
Active packages can be sold through partner experiences. Limited packages need extra care because availability, support requirements, or policy notes require closer review.
Hide packages that are not in the current catalogue.
Catalogue Versions
Catalogue versions help partners keep product display, checkout, support, and reconciliation aligned.
Store the version used for display, the version used at purchase, the package ID sold to the customer, the price shown at checkout, and the policy notes shown at checkout.
Use those records for support, billing, refunds, and audit review.
Merchandising Limits
Partners can design their own customer experience, but the package facts must stay intact.
Do not change coverage, validity, allowance, status, activation requirements, price fields, or policy notes in customer-facing copy.
Related Catalogue Docs
Use Connect SDK Catalogue for package feed behavior, package status, catalogue versions, and customer display rules.
Use Orders And Provisioning for order creation, activation materials, install state, and failed-order handling.