Subscription

This page provides an in-depth look at the subscription model, detailing its properties and various attributes. Understanding these properties will help you manage and utilize subscriptions effectively.

Properties

  • Name
    id
    Type
    string
    Description

    Unique identifier for the device

  • Name
    service_line_number
    Type
    string | null
    Description

    The service line number of the subscription

  • Name
    account_number
    Type
    string
    Description

    Account number issued by starlink

  • Name
    subscription_reference_id
    Type
    string
    Description

    Unique identifier issued by starlink.

  • Name
    product_id
    Type
    string
    Description

    Product ID used by this subscription

  • Name
    optin_product_id
    Type
    string
    Description

    Currently opted-in product id reference

  • Name
    delayed_product_id
    Type
    string
    Description

    No documentation available

  • Name
    is_active
    Type
    boolean
    Description

    If the current subscription is active

  • Name
    can_change_service
    Type
    boolean
    Description

    If the subscription is allowed to change servce

  • Name
    can_resume_service
    Type
    boolean
    Description

    If the subscription is allowed to resume service once its paused

  • Name
    pending_activation
    Type
    boolean
    Description

    If the subscription is currently on pending state

  • Name
    start_at
    Type
    timestamp | null
    Description

    Start date of the subscription in ISO-8601

  • Name
    end_at
    Type
    timestamp | null
    Description

    The service line deactivation date, this can be null

  • Name
    archived_at
    Type
    timestamp
    Description

    Service line archived date

Was this page helpful?