Service Lines

The service lines section details the attributes and relationships relevant to a service line within the system. This includes identifiers, account numbers, addresses, and other associated entities.

The service line model

The service line model captures all the essential details of a service line, including unique identifiers, account numbers, and associated addresses. It provides a comprehensive view of each service line, making it easy to understand its attributes and relationships within the system.

Properties

Name
id
Type
string
Description
Unique identifier for the service line.
Name
account_id
Type
string
Description
The current account number of the service line.
Name
subscription_reference_id
Type
string
Description
Unique identifier issued by starlink.
Name
service_line_number
Type
string
Description
The service line number issued by starlink
Name
address_reference_id
Type
string
Description
Address Reference ID of the address associated with the service line.
Name
alias
Type
string
Description
User defined alias for this service line.
Name
nickname
Type
string
Description
Starlink's user-defined nickname for this service line
Name
terminals
Type
Terminal[]
Description
List of terminals associated with the service line
Name
subscription
Type
Subscription
Description
Subcription details associated with the service line.
Name
address
Type
Address
Description
Address associated with the service line.
Name
start_at
Type
timestamp
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

GET/v1/accounts

List all accounts

This endpoint allows you to retrieve a paginated list of all your accounts. By default, a maximum of 20 accounts are shown per page.

Optional attributes

Name
per_page
Type
integer
Description
Limit the number of service lines returned.
Name
page
Type
integer
Description
The current page number of service lines
Name
filter[account_id]
Type
string
Description
Filter the accounts by account_id
Name
filter[search]
Type
string
Description
Filter the accounts line by search query.

Request

GET

/v1/accounts

curl -G https://api.polaris.revlv.com/v1/accounts \
-H "Authorization: Bearer {token}" \
-H "Polaris-Account: {account_id}" \
-d per_page=50

Response

{
  "data": [
    {
        "id": "9c3bba01-70c3-49ce-8562-e890b7ead0e1",
		"name": "Acme Inc",
		"email": "acme@mail.com",
		"contact_person": "John Doe",
		"contact_number": null,
		"account_id": "acct_TbaK4vpY18",
		"type": null,
		"region": null,
		"is_primary": true,
		"region_code": "PH",
		"iso_currency_code": null,
		"can_generate_token": true,
		"can_add_users": false,
		"created_at": "2024-06-07T15:36:16.000000Z",
		"updated_at": "2024-06-07T15:36:16.000000Z"
    },
    {
      "id": "97c50f61-3754-3a9c-a16d-c580677d5fed"
      // ...
    }
  ]
}

GET/v1/accounts/:service_line_number

Retrieve a single service line

This endpoint allows you to retrieve a service line by providing the service_line_number. Refer to the list at the top of this page to see which properties are included with Service line object.

Request

GET

/v1/accounts/AST-12398123-12312

curl https://api.polaris.revlv.com/v1/accounts/AST-12398123-12312 \
    -H "Authorization: Bearer {token}" \
    -H "Polaris-Account: {account_id}" \

Response

{
    "data": {
        "id": "63a42653-8ca2-3c73-bda7-5428f6527d0e",
        "account_id": "acct_TbaK4vpY18",
        "subscription_reference_id": "85112629",
        "service_line_number": "57537559",
        "address_reference_id": "52887093",
        "alias": null,
        "nickname": "24823 Strosin Pass\nJeffton, UT 44815",
        "address_type": null,
        "start_at": "2024-06-07T23:36:17+08:00",
        "end_at": null,
        "terminals": [
            {
                "id": "00d5f0e6-d819-30d8-8a58-e71dc60a3999",
                "serial_number": "98784325",
                "service_line_number": "57537559",
                "device_id": "76584268",
                "location": {
                    "type": "Point",
                    "coordinates": [
                        66.574455,
                        109.440921
                    ]
                },
                "device_type": "Terminal",
                "device_attributes": {
                    "dish_serial_number": "1293637554407"
                },
                "uptime": null,
                "last_connected_at": "2024-06-07T12:45:33.000000Z",
                "last_disconnected_at": "2023-02-11 05:40:02+08",
                "disabled_at": null,
                "alerts": null,
                "h3_cell_id": "0",
                "is_online": false,
                "created_at": "2024-06-07T23:36:17+08:00",
                "updated_at": "2024-06-07T23:36:17+08:00"
            }
        ],
        "subscription": {
            "id": 0,
            "service_line_number": "98284160",
            "account_id": null,
            "subscription_reference_id": "85112629",
            "product_id": "ph-enterprise-subscription-commercial-mobile-php",
            "option_product_id": null,
            "delayed_product_id": null,
            "is_active": true,
            "can_change_service": true,
            "can_resume_service": false,
            "pending_activation": false,
            "has_public": null,
            "start_at": "2024-06-07T23:36:17+08:00",
            "end_at": null,
            "archived_at": "2024-06-08T07:36:17+08:00",
            "created_at": "2024-06-07T23:36:17+08:00",
            "updated_at": "2024-06-07T23:36:17+08:00"
        },
        "address": {
            "id": 0,
            "account_id": "54848917",
            "address_reference_id": "52887093",
            "address_lines": null,
            "location": {
                "type": "Point",
                "coordinates": [
                    -86.825388,
                    8.947101
                ]
            },
            "administrative_area": "Kentucky",
            "administrative_area_code": null,
            "region": "Korea",
            "region_code": "BO",
            "locality": "New Hiram",
            "formatted_address": "89261 Elvie Turnpike\nLake Kristy, OH 92212-3487",
            "postal_code": null,
            "created_at": "2024-06-07T23:36:17+08:00",
            "updated_at": "2024-06-07T23:36:17+08:00"
        }
    }
}