G-Starlink Hub Partner API

Exchange client credentials for a Bearer access token. Supports both JSON and form-urlencoded request bodies.

Browse available eSIM products with filtering and pagination.

List your orders with optional status filter and cursor pagination.

Create a new order. Requires Idempotency-Key header to prevent duplicates. If the same key is reused, the original order is returned with Idempotent-Replayed: true header.

Payment: production orders are charged atomically to the partner's pre-funded wallet and are created as paid. If the balance is insufficient the order is NOT created and 402 Insufficient Balance is returned with the shortfall. Sandbox orders simulate payment — the wallet is never charged. Check the balance with GET /api/v1/balance.

Returns order details including line items and fulfillment information (shipping tracking, eSIM codes, etc.)

Returns the status of all scheduled activations associated with an order.

Create up to 100 orders in a single request. Each order is processed independently; individual failures do not affect other orders in the batch.

List your physical SIM activation requests with optional filters.

Submit a physical SIM card activation request with KYC data. The system auto-detects the carrier from the ICCID prefix:

• 896103* = Lycamobile
• 58* = Optus

Currently supported carriers: Lycamobile and Optus. ICCIDs for other carriers return 422 Carrier Not Supported with a supported_carriers list.

KYC requirements differ by carrier (all listed fields required):

• Lycamobile: first_name, last_name, passport_no, passport_country, passport_expiry, date_of_birth, address, sim_last4, puk
• Optus: first_name, last_name, passport_no, passport_country, passport_expiry, date_of_birth, address, title

Get detailed status of a specific activation request, including assigned mobile number and any error information.

Edit the requested activation date and/or note on an in-flight activation request. At least one of the two fields is required.

Only editable while status = "activation_requested". Once ops has submitted the request to the carrier (or it has moved past that state for any other reason), this returns 409 naming the current status — coordinate with support instead. No KYC or customer fields can be changed here; those go through the KYC pool endpoints.

Not found, or the activation belongs to another partner — 404 (existence is never leaked).

Cancel an in-flight activation request.

Only cancellable while status = "activation_requested". Once ops has submitted the request to the carrier, this returns 409 naming the current status — contact support instead. Cancelling atomically releases any KYC-pool passport draw (the passport's per-brand use count and assigned_request_id are cleared, so it never falsely counts toward its 4-use cap) and rolls the SIM's activation status back to Inactive, so it becomes resubmittable.

Not found, or the activation belongs to another partner — 404 (existence is never leaked).

Same atomic core as POST /api/v1/activations/{id}/cancel — for callers (e.g. ICC's automation) that hold the ICCID rather than our internal activation id, so no extra GET /api/v1/activations lookup is needed first.

Only cancellable while status = "activation_requested". Once ops has submitted the request to the carrier, this returns 409 naming the current status — contact support instead. Cancelling atomically releases any KYC-pool passport draw and rolls the SIM's activation status back to Inactive, so it becomes resubmittable.

No open (in-flight) activation for this ICCID under your account — whether it doesn't exist, belongs to another partner, or was never submitted — 404 (existence is never leaked).

Same guarded-update core as PATCH /api/v1/activations/{id} — for callers (e.g. ICC's automation) that hold the ICCID rather than our internal activation id. At least one of requested_activation_date / note is required.

Only editable while status = "activation_requested". Once ops has submitted the request to the carrier (or it has moved past that state for any other reason), this returns 409 naming the current status. No KYC or customer fields can be changed here.

No open (in-flight) activation for this ICCID under your account — whether it doesn't exist, belongs to another partner, or was never submitted — 404 (existence is never leaked).

Cancel up to 200 activation requests in one call. Each item is cancelled through the same atomic core as the single-cancel endpoint (POST /api/v1/activations/{id}/cancel) — one item's failure never touches the others.

Identify items with activation_ids (our internal UUIDs), iccids (for callers like ICC's automation that hold ICCIDs instead), or a mix of both — combined, up to 200. ICCIDs are resolved to their in-flight activation internally; outcomes are keyed by whichever identifier you supplied for that item (activation_id or iccid).

Partial success is normal and returns 200. Ids/ICCIDs that don't exist, don't belong to your account, or (for an ICCID) have no open activation, come back as an outcome with reason: "not_found" rather than failing the whole batch. Items that are no longer activation_requested come back as reason: "not_cancellable:<status>".

Edit the requested activation date and/or note on up to 200 activation requests in one call. Each item identifies its activation with EXACTLY ONE of activation_id (our internal UUID) or iccid (for callers like ICC's automation that hold ICCIDs instead), needs at least one of requested_activation_date / note, and is applied through its own guarded update — one item's failure never touches the others. Each outcome is keyed by whichever identifier the item supplied.

Partial success is normal and returns 200. Ids/ICCIDs that don't exist, don't belong to your account, or (for an ICCID) have no open activation, come back as an outcome with reason: "not_found". Items that are no longer activation_requested come back as reason: "not_editable:<status>" — the same "requested-only" gate used everywhere else in the activation lifecycle.

List the passports in your own KYC pool. Returns only the fields you submitted plus a neutral outward status of received — our internal verification and usage state is never exposed. Withdrawn (soft-deleted) records are excluded.

Bulk-add passports into your own KYC pool (up to 200 per request). The pool is what the activation flow draws from when a bulk activation line carries no inline passport.

Imported passports are UNVERIFIED. Each record is stored with verification_status = "pending". Our operations team must verify a passport before the auto-draw will assign it to an activation — the draw only selects verified (onshore) records. Importing here is not a substitute for KYC verification.

Records are pinned to your own partner account; you can only write into your own pool. Duplicate passport numbers — whether already in your pool or repeated within the same request — are skipped (see skipped_duplicates).

Edit one of your pool passports. Only allowed while the passport has never been used for an activation — once used it is locked and must be changed by our operations team (409 Passport In Use). Editing identity fields (passport number, name, expiry) resets our verification, so the record must be re-verified before it can be drawn again.

Withdraw one of your pool passports. This is a soft delete — the record leaves your pool but is retained for compliance; it is never physically deleted. Only allowed while the passport has never been used for an activation — once used it is locked (409 Passport In Use) and must be handled by our operations team.

Returns eSIM delivery details (ICCID, activation code, QR code URL) for a fulfilled order.

Check the activation status, data usage, and location of an eSIM by ICCID.

Check real-time stock and availability status for products.

Register a webhook endpoint to receive event notifications. The signing secret is returned only once in the response — store it securely.

Export product catalog formatted for Shopify, WooCommerce, or generic use. Includes suggested retail pricing with configurable markup.

Current pre-funded wallet balance per currency. Orders are charged in the product's currency, so the matching wallet must be funded.