Search Starlink Requests
Search Starlink requests under your partner account by different criteria.
Required Capabilities
Starlink Viewer
Request
Query parameters
Controls the scope of results to return.
SELF— Returns requests created by your own partner accountCHILDREN_ONLY— Returns requests created by your resellers
Page number of the search result. Minimum value allowed is 1.
A limit on the number of items returned. Allowed value can range between 1 and 100.
Sort field and direction.
Search query string.
Filter results by partner account reference ID.
Filter results by Starlink account reference ID.
Filter results by status.
PENDING_APPROVAL— The request is pending approval.PROCESSING— The request is being processed.COMPLETED— The request has been completed.CANCELLED— The request has been cancelled.REJECTED— The request has been rejected.EXPIRED— The request has expired.ABORTED— The request has been aborted.
Filter results by request type.
SERVICE_LINE_CREATE— Request to create a new service line.SERVICE_LINE_CHANGE_PLAN— Request to change the plan of an existing service line.SERVICE_LINE_OPT_IN— Request to opt in to a service line.SERVICE_LINE_TOPUP— Request to top up a service line.SERVICE_LINE_REACTIVATE— Request to reactivate a service line.DEVICE_ORDER— Request to order a new device.
Filter results by the Starlink service line reference ID of the change plan detail.
Filter results by the Starlink service line reference ID of the opt-in detail.
Filter results by the Starlink service line reference ID of the reactivate detail.
Response
A json is returned in the response body with the following fields:
Total number of records found with the search request. If this value is larger than the returned count of items, you can find more results by retrying the same request with different pageNum.
Returns records found for the current page of search result.
Show child attributes
Reference ID of the Starlink request.
Reference ID of the partner account that created the request.
Reference ID of the parent partner account. null if not applicable.
Reference ID of the Starlink account associated with this request.
Type of the Starlink request.
SERVICE_LINE_CREATE— Request to create a new service line.SERVICE_LINE_CHANGE_PLAN— Request to change the plan of an existing service line.SERVICE_LINE_OPT_IN— Request to opt in to a service line.SERVICE_LINE_TOPUP— Request to top up a service line.SERVICE_LINE_REACTIVATE— Request to reactivate a service line.DEVICE_ORDER— Request to order a new device.
Currency used for the request. null if not applicable.
Line items included in the request.
Show child attributes
Parent item ID. null if this item has no parent.
Item ID.
SKU of the product.
Name of the product.
Quantity of the product.
Original unit price before any adjustments.
Effective unit price.
Details for a SERVICE_LINE_CREATE request. null for other request types.
Show child attributes
Name of the service line to create.
Reference ID of the Starlink address to associate with the service line.
Reference ID of the created Starlink service line. Populated after the request is processed. null if not yet processed.
Whether the new service line is held in the Pending Activation state until a Starlink device is assigned. Only applies when starlinkDeviceRefIds is empty.
Reference IDs of the Starlink devices to assign to the new service line. Empty if no devices were specified.
Details for a SERVICE_LINE_CHANGE_PLAN request. null for other request types.
Show child attributes
Reference ID of the Starlink service line whose plan is being changed.
Whether the plan change is scheduled to take effect at the next billing cycle.
Details for a SERVICE_LINE_OPT_IN request. null for other request types.
Show child attributes
Reference ID of the Starlink service line to opt in.
Details for a SERVICE_LINE_REACTIVATE request. null for other request types.
Show child attributes
Reference ID of the Starlink service line to reactivate.
Details for a SERVICE_LINE_TOPUP request. null for other request types.
Show child attributes
Reference ID of the Starlink service line to top up.
Details for a DEVICE_ORDER request. null for other request types.
Show child attributes
Shipping address for the device order.
Show child attributes
Company name.
First name of the recipient.
Last name of the recipient.
Email address of the recipient.
Phone number of the recipient.
Address line 1.
Address line 2. null if not applicable.
City.
State or province. null if not applicable.
Postal code.
ISO 3166-1 alpha-2 country code.
Billing address for the device order, automatically deduced by the system for reference — this is not a field you submit in the request. Has the same fields as shippingAddress. null if not yet deduced.
URL to process order. null if not yet available.
Order number assigned after processing. null if not yet assigned.
Timestamp when the request will expire. null if not applicable.
Remark left by the requester. null if not provided.
Remark left by the parent partner. null if not provided.
Timestamp when the request was approved. null if not approved.
Name of the user who approved the request. null if not approved.
Email of the user who approved the request. null if not approved.
Timestamp when the request was rejected. null if not rejected.
Name of the user who rejected the request. null if not rejected.
Email of the user who rejected the request. null if not rejected.
Timestamp when the request was cancelled. null if not cancelled.
Name of the user who cancelled the request. null if not cancelled.
Email of the user who cancelled the request. null if not cancelled.
Timestamp when the request expired. null if not expired.
Timestamp when the request was processed. null if not yet processed.
Current status of the Starlink request.
PENDING_APPROVAL— The request is pending approval.PROCESSING— The request is being processed.COMPLETED— The request has been completed.CANCELLED— The request has been cancelled.REJECTED— The request has been rejected.EXPIRED— The request has expired.ABORTED— The request has been aborted.
Date and time the request was created.
Username of the user who created the request.
Email of the user who created the request. null if not applicable.
Date and time the request was last updated.
Username of the user who last updated the request.
Email of the user who last updated the request. null if not applicable.
Examples
Request
curl -X GET 'https://portal.peplink.com/api/e/v1/cp/starlink/requests/search?viewSegment=SELF&pageNum=1&pageSize=5' \ -H 'Authorization: Bearer {token}'Response
{
"totalCount": 1,
"items": [
{
"refId": "REQ-00001",
"accountRefId": 42,
"parentAccountRefId": null,
"starlinkAccountRefId": "108",
"type": "SERVICE_LINE_CREATE",
"currency": "USD",
"items": [
{
"parentItemId": null,
"itemId": 1,
"sku": "SL-RES-02",
"productName": "Starlink Residential Plan",
"quantity": 1,
"originalUnitPrice": 140.0,
"unitPrice": 140.0
}
],
"createServiceLineDetail": {
"name": "My Service Line",
"starlinkAddressRefId": "ADDR-00001",
"starlinkServiceLineRefId": "SL-00001",
"pendingActivation": false,
"starlinkDeviceRefIds": ["XXXX00000001"]
},
"changeServiceLinePlanDetail": null,
"optInServiceLineDetail": null,
"reactivateServiceLineDetail": null,
"topupServiceLineDetail": null,
"orderDeviceDetail": null,
"expireAt": null,
"requesterRemark": null,
"parentRemark": null,
"approvedAt": "2026-03-25T08:00:00.000Z",
"approvedBy": "System",
"approvedByEmail": null,
"rejectedAt": null,
"rejectedBy": null,
"rejectedByEmail": null,
"cancelledAt": null,
"cancelledBy": null,
"cancelledByEmail": null,
"expiredAt": null,
"processedAt": "2026-03-25T08:00:05.000Z",
"status": "COMPLETED",
"createdAt": "2026-03-25T07:55:00.000Z",
"createdBy": "Alice C",
"createdByEmail": "[email protected]",
"updatedAt": "2026-03-25T08:00:05.000Z",
"updatedBy": "System",
"updatedByEmail": null
}
]
}