Create a Starlink Request
Create a Starlink request.
Required Capabilities
Starlink Manager
Request
Body parameters
Reference ID of the Starlink account to create the request for.
Type of Starlink request to create.
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.
When is this required?
Required if type is SERVICE_LINE_CREATE, SERVICE_LINE_CHANGE_PLAN, SERVICE_LINE_TOPUP, SERVICE_LINE_REACTIVATE, or DEVICE_ORDER.
Line items for the request. For DEVICE_ORDER, SKUs listed in the kit product's starlinkFreeRouterOptionSkus are allowed, with a total quantity from 0 to the kit quantity.
Show child attributes
SKU of the product.
Quantity of the product. Must be at least 1, except 0 is allowed for free router SKUs.
When is this required?
Required if type is SERVICE_LINE_CREATE.
Details for a SERVICE_LINE_CREATE request.
Show child attributes
Name of the service line to create.
Reference ID of the Starlink address to associate with the new service line. The address must belong to the same Starlink account.
Only applies when starlinkDeviceRefIds is empty. Set to true to keep the new service line in the Pending Activation state until a Starlink device is assigned to it using the update Starlink service line API. Defaults to false.
Reference IDs of the Starlink devices to assign to the new service line. The service line activates with these devices once the request is processed. Omit or pass an empty array to assign devices later. Each device must belong to the same Starlink account, must not already be associated with a service line, and must not be included in another SERVICE_LINE_CREATE request that is pending approval or processing. Duplicate values are not allowed.
Note:
- For
LOCALservice lines, a maximum of 1 device can be assigned. - For
GLOBALservice lines, a maximum of 2 devices can be assigned.
The service line type is determined by the starlinkServiceLineType of the SKUs in items.
When is this required?
Required if type is SERVICE_LINE_CHANGE_PLAN.
Details for a SERVICE_LINE_CHANGE_PLAN request.
Show child attributes
Reference ID of the Starlink service line whose plan is being changed.
true to schedule the plan change to take effect at the next billing cycle. false to apply the change immediately.
When is this required?
Required if type is SERVICE_LINE_OPT_IN.
Details for a SERVICE_LINE_OPT_IN request.
Show child attributes
Reference ID of the Starlink service line to opt in.
When is this required?
Required if type is SERVICE_LINE_REACTIVATE.
Details for a SERVICE_LINE_REACTIVATE request.
Show child attributes
Reference ID of the Starlink service line to reactivate.
When is this required?
Required if type is SERVICE_LINE_TOPUP.
Details for a SERVICE_LINE_TOPUP request.
Show child attributes
Reference ID of the Starlink service line to top up.
When is this required?
Required if type is DEVICE_ORDER.
Details for a DEVICE_ORDER request.
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 in E.164 format (e.g. +12025550123).
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. Must match the country of the Starlink account.
Optional remark from the requester.
Response
200 The Starlink request is created successfully
A json is returned in the response body with the following fields:
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.
400 Request is invalid
No Starlink request is created as the request is invalid.
Check the response body for the error details.
Examples
Request
curl -X POST 'https://portal.peplink.com/api/e/v1/cp/starlink/requests' \ -H 'Authorization: Bearer {token}' \ -H 'Content-Type: application/json' \ --data-raw '{"starlinkAccountRefId": "104","type": "SERVICE_LINE_CREATE","items": [ { "sku": "SLK-LP-500GB-DB-US", "quantity": 1 }, { "sku": "SLK-LP-TAC-US", "quantity": 1 }],"createServiceLineDetail": { "name": "zxczxcz", "starlinkAddressRefId": "43", "starlinkDeviceRefIds": ["XXXX00000001"]}}'Response
{
"refId": "547",
"accountRefId": 10,
"parentAccountRefId": null,
"starlinkAccountRefId": "104",
"type": "SERVICE_LINE_CREATE",
"currency": "USD",
"items": [
{
"parentItemId": null,
"itemId": 1,
"sku": "SLK-LP-500GB-DB-US",
"productName": "Starlink Local Priority 500 GB Data Block - US",
"quantity": 1,
"originalUnitPrice": 125,
"unitPrice": 125
},
{
"parentItemId": null,
"itemId": 2,
"sku": "SLK-LP-TAC-US",
"productName": "Starlink Local Priority Terminal Access Charge - US",
"quantity": 1,
"originalUnitPrice": 40,
"unitPrice": 40
}
],
"createServiceLineDetail": {
"name": "zxczxcz",
"starlinkAddressRefId": "43",
"starlinkServiceLineRefId": null,
"pendingActivation": false,
"starlinkDeviceRefIds": ["XXXX00000001"]
},
"changeServiceLinePlanDetail": null,
"optInServiceLineDetail": null,
"reactivateServiceLineDetail": null,
"topupServiceLineDetail": null,
"orderDeviceDetail": null,
"expireAt": "2026-04-15T23:59:59.000Z",
"requesterRemark": null,
"parentRemark": null,
"approvedAt": "2026-04-01T02:51:13.202Z",
"approvedBy": "System",
"approvedByEmail": null,
"rejectedAt": null,
"rejectedBy": null,
"rejectedByEmail": null,
"cancelledAt": null,
"cancelledBy": null,
"cancelledByEmail": null,
"expiredAt": null,
"processedAt": null,
"status": "PROCESSING",
"createdAt": "2026-04-01T02:51:13.202Z",
"createdBy": "Jane Doe",
"createdByEmail": "[email protected]",
"updatedAt": "2026-04-01T02:51:13.202Z",
"updatedBy": "Jane Doe",
"updatedByEmail": "[email protected]"
}