Octane REST API
latest
  • latest
  • v1
latest
  • latest
  • v1
latest
  • latest
  • v1
  1. Mobile Flows
  • Release Notes
    • Release History
    • Release Versions
      • V2.1 Release
      • V2 Release
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
      • Test Card Numbers for Payments
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
      • Mobile Companion Plan Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Predictive Address Search (NBN)
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • Create Order (NBN Activation)
      • Create Order (NBN Modification)
      • Create Order (NBN Disconnection)
      • Cancel (NBN Activation) Order
      • Get Order Detail (NBN)
      • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
    • Trouble Ticket
      • Create Trouble Ticket
  • API Documentation (SOAP APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  • Schemas
    • Appointment
    • Direct Debit
    • Telflow Order
    • Rollup Code
    • Data Pool Configuration
    • Diagnostic Test
    • Agent
    • Service Health Check
    • Order Note
    • Commission
    • Data Pool Usage
    • Service Provider Group
    • IPND
    • OTP Transaction
    • Service Restoration Ticket
    • Customer
    • SP Group
    • Credit Card
    • Authorised Person
    • Address
    • Payment Method
    • Bank Account
    • Payment
    • Transaction
    • Plan
    • Plan Tariff
    • Data Plan
    • Mobile Plan
    • Order
    • Service
    • Service Instance
    • Service Agreement
    • Data Service
    • NBN Service
    • Service Contact
    • Voip Service
    • Inbound Service
    • Enquiry
  1. Mobile Flows

Mobile Companion Plan Flow

Overview#

Companion plan activation is initiated by the end user, not the SP. The end user must complete activation through their watch app (Apple or Samsung) before any management actions are available.
Once activated, use the APIs below to manage companion plans on behalf of your customers.
The following actions are not available via API for companion plans and must be completed through the end user watch app:
Activation
Replace SIM or Device Swap
You cannot fully bar a companion service via the Bar Mobile Service API, however data barring is available via the API listed below.

Key#

IconDescription
telcoinabox.pngTelcoinabox
SP_verysmall.pngService Provider / Website

API Sequence#

StepActionPublisherConsumerAPI GuideM/OComments/Other InfoType
1List Servicestelcoinabox.pngSP_verysmall.pngList Services for a CustomerOptionalTo retrieve all mobile services for a customer, call the Get Mobile Services endpoint. Each service returned includes a serviceType parameter on the mobileService object. Any service where serviceType returns COMPANION is a companion service. The parentLineSeqNo field identifies the primary service the companion is linked to.REST
2Get Service Detailtelcoinabox.pngSP_verysmall.pngGet Service Detail by LineSeqNoOptionalTo view more detail about a specific service, call the Get Mobile Service endpoint. This also returns serviceType and parentLineSeqNo.REST
3Query Balancetelcoinabox.pngSP_verysmall.pngQuery Balance V3OptionalTo display the balance of the companion service, use the existing queryBalanceV3Legacy SOAP API
4Bar Datatelcoinabox.pngSP_verysmall.pngModify Mobile FeaturesOptionalTo bar data on a companion service use classCode = E0041 and productCode = snGS1 and accessLevel = 1Legacy SOAP
5Unbar Datatelcoinabox.pngSP_verysmall.pngModify Mobile FeaturesOptionalTo bar data on a companion service use classCode = E0041 and productCode = snGS1 and accessLevel = 0Legacy SOAP API
6Disconnect Servicetelcoinabox.pngSP_verysmall.pngDisconnect a Mobile ServiceOptionalUse this API to disconnect a companion plan serviceLegacy SOAP
Modified at 2026-05-29 07:26:45
Previous
Mobile Data Pool Flow
Next
ConnectYou Business SIP Trunk Activate Flow
Built with