Connect SDK Catalogue defines the connectivity packages approved for your partner experience.
Use it to show destinations, regions, global packages, data allowances, validity periods, package status, and approved commercial fields. Treat the catalogue as the source of truth for what your customers can buy.
Do not build a separate package catalogue from memory, spreadsheets, screenshots, or old exports. Refresh from the approved catalogue feed and store the catalogue version used at purchase.
Package Records
Each package record defines:
- public package ID
- coverage name
- coverage type
- country or region
- data allowance
- validity period
- package status
- catalogue version
- approved commercial fields
- policy notes when needed
Only display fields approved for your partner account.
Coverage Types
Coverage type tells your experience how to present the package.
Current coverage types are:
- country
- region
- global
Country packages serve one destination. Regional packages serve a named region. Global packages serve multiple supported destinations.
Use the catalogue coverage name exactly. Do not rename a package in a way that changes the customer expectation.
Data And Validity
Data allowance defines how much mobile data the package includes.
Validity defines how long the package can remain active after the applicable activation point. Your customer experience should show both values before purchase and in the order record after 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
- limited
Active packages can be offered through approved experiences. Limited packages require extra care in copy, merchandising, or support because availability, coverage, or operational behavior needs closer review.
Do not sell a package that is missing from the current approved catalogue.
Catalogue Version
Catalogue version protects your customer experience from stale data.
Store the version used when you displayed a package and the version used when the customer purchased. Use that record for support, reconciliation, refunds, and audit review.
Refresh the catalogue on the cadence approved for your integration. When a package changes or disappears, update your customer-facing experience before accepting new orders for it.
Pricing Display
Show only approved commercial fields.
If your agreement gives you partner net price, retail price, minimum selling price, or suggested retail price fields, display and store them according to your partner agreement.
Do not expose margin calculations, non-public commercial rules, supply costs, or private pricing notes.
Customer Display Rules
A customer should understand what they are buying before checkout.
Show:
- destination or coverage area
- included data
- validity period
- price
- service type
- activation requirements
- important policy notes
Avoid vague package names, hidden validity, unsupported “unlimited” claims, and coverage promises that do not come from the catalogue.
Catalogue Gaps
If your experience needs a country, region, data amount, or validity period that is not in the approved catalogue, request review.
Do not create partner-defined packages or combine packages into a new offer unless Onyx has approved that offer in writing.