Peplink Portal Docs
Starlink Requests

Reject a Starlink Request

Reject a Starlink request.

Required Capabilities

Starlink Manager

Request

POST/starlink/requests/{refId}/reject

Path parameters

refIdstringrequired

Reference ID of the Starlink request to reject.

Body parameters

parentRemarkstringoptional

Remark from the parent partner account for this rejection.

Response

A json is returned in the response body with the following fields:

refIdstring

Reference ID of the Starlink request.

accountRefIdlong

Reference ID of the partner account that created the request.

parentAccountRefIdnullable long

Reference ID of the parent partner account. null if not applicable.

starlinkAccountRefIdstring

Reference ID of the Starlink account associated with this request.

typeenum

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.
currencynullable string

Currency used for the request. null if not applicable.

itemsobject array

Line items included in the request.

Show child attributes
items.parentItemIdnullable integer

Parent item ID. null if this item has no parent.

items.itemIdinteger

Item ID.

items.skustring

SKU of the product.

items.productNamestring

Name of the product.

items.quantityinteger

Quantity of the product.

items.originalUnitPricenumber

Original unit price before any adjustments.

items.unitPricenumber

Effective unit price.

createServiceLineDetailnullable object

Details for a SERVICE_LINE_CREATE request. null for other request types.

Show child attributes
createServiceLineDetail.namestring

Name of the service line to create.

createServiceLineDetail.starlinkAddressRefIdstring

Reference ID of the Starlink address to associate with the service line.

createServiceLineDetail.starlinkServiceLineRefIdnullable string

Reference ID of the created Starlink service line. Populated after the request is processed. null if not yet processed.

createServiceLineDetail.pendingActivationboolean

Whether the new service line is held in the Pending Activation state until a Starlink device is assigned. Only applies when starlinkDeviceRefIds is empty.

createServiceLineDetail.starlinkDeviceRefIdsstring array

Reference IDs of the Starlink devices to assign to the new service line. Empty if no devices were specified.

changeServiceLinePlanDetailnullable object

Details for a SERVICE_LINE_CHANGE_PLAN request. null for other request types.

Show child attributes
changeServiceLinePlanDetail.starlinkServiceLineRefIdstring

Reference ID of the Starlink service line whose plan is being changed.

changeServiceLinePlanDetail.isDelayUpdateboolean

Whether the plan change is scheduled to take effect at the next billing cycle.

optInServiceLineDetailnullable object

Details for a SERVICE_LINE_OPT_IN request. null for other request types.

Show child attributes
optInServiceLineDetail.starlinkServiceLineRefIdstring

Reference ID of the Starlink service line to opt in.

reactivateServiceLineDetailnullable object

Details for a SERVICE_LINE_REACTIVATE request. null for other request types.

Show child attributes
reactivateServiceLineDetail.starlinkServiceLineRefIdstring

Reference ID of the Starlink service line to reactivate.

topupServiceLineDetailnullable object

Details for a SERVICE_LINE_TOPUP request. null for other request types.

Show child attributes
topupServiceLineDetail.starlinkServiceLineRefIdstring

Reference ID of the Starlink service line to top up.

orderDeviceDetailnullable object

Details for a DEVICE_ORDER request. null for other request types.

Show child attributes
orderDeviceDetail.shippingAddressobject

Shipping address for the device order.

Show child attributes
orderDeviceDetail.shippingAddress.companystring

Company name.

orderDeviceDetail.shippingAddress.firstNamestring

First name of the recipient.

orderDeviceDetail.shippingAddress.lastNamestring

Last name of the recipient.

orderDeviceDetail.shippingAddress.emailstring

Email address of the recipient.

orderDeviceDetail.shippingAddress.phonestring

Phone number of the recipient.

orderDeviceDetail.shippingAddress.line1string

Address line 1.

orderDeviceDetail.shippingAddress.line2nullable string

Address line 2. null if not applicable.

orderDeviceDetail.shippingAddress.citystring

City.

orderDeviceDetail.shippingAddress.statenullable string

State or province. null if not applicable.

orderDeviceDetail.shippingAddress.zipCodestring

Postal code.

orderDeviceDetail.shippingAddress.countryCodestring

ISO 3166-1 alpha-2 country code.

orderDeviceDetail.billingAddressnullable object

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.

orderDeviceDetail.orderProcessingUrlnullable string

URL to process order. null if not yet available.

orderDeviceDetail.orderNumbernullable string

Order number assigned after processing. null if not yet assigned.

expireAtnullable datetime string

Timestamp when the request will expire. null if not applicable.

requesterRemarknullable string

Remark left by the requester. null if not provided.

parentRemarknullable string

Remark left by the parent partner. null if not provided.

approvedAtnullable datetime string

Timestamp when the request was approved. null if not approved.

approvedBynullable string

Name of the user who approved the request. null if not approved.

approvedByEmailnullable string

Email of the user who approved the request. null if not approved.

rejectedAtnullable datetime string

Timestamp when the request was rejected. null if not rejected.

rejectedBynullable string

Name of the user who rejected the request. null if not rejected.

rejectedByEmailnullable string

Email of the user who rejected the request. null if not rejected.

cancelledAtnullable datetime string

Timestamp when the request was cancelled. null if not cancelled.

cancelledBynullable string

Name of the user who cancelled the request. null if not cancelled.

cancelledByEmailnullable string

Email of the user who cancelled the request. null if not cancelled.

expiredAtnullable datetime string

Timestamp when the request expired. null if not expired.

processedAtnullable datetime string

Timestamp when the request was processed. null if not yet processed.

statusenum

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.
createdAtdatetime string

Date and time the request was created.

createdBystring

Username of the user who created the request.

createdByEmailnullable string

Email of the user who created the request. null if not applicable.

updatedAtdatetime string

Date and time the request was last updated.

updatedBystring

Username of the user who last updated the request.

updatedByEmailnullable string

Email of the user who last updated the request. null if not applicable.

Examples

Request

curl -X POST 'https://portal.peplink.com/api/e/v1/cp/starlink/requests/REQ-00001/reject' \  -H 'Authorization: Bearer {token}' \  -H 'Content-Type: application/json' \  --data-raw  '{"parentRemark": "Rejected."}'

Response

{
  "refId": "296",
  "accountRefId": 1627,
  "parentAccountRefId": 10,
  "starlinkAccountRefId": "86",
  "type": "SERVICE_LINE_OPT_IN",
  "currency": null,
  "items": [],
  "createServiceLineDetail": null,
  "changeServiceLinePlanDetail": null,
  "optInServiceLineDetail": {
    "starlinkServiceLineRefId": "71"
  },
  "reactivateServiceLineDetail": null,
  "topupServiceLineDetail": null,
  "orderDeviceDetail": null,
  "expireAt": "2026-04-01T23:59:59.000Z",
  "requesterRemark": null,
  "parentRemark": "Rejected.",
  "approvedAt": null,
  "approvedBy": null,
  "approvedByEmail": null,
  "rejectedAt": "2026-03-31T03:59:29.114Z",
  "rejectedBy": "Jane Doe",
  "rejectedByEmail": "[email protected]",
  "cancelledAt": null,
  "cancelledBy": null,
  "cancelledByEmail": null,
  "expiredAt": null,
  "processedAt": null,
  "status": "REJECTED",
  "createdAt": "2026-03-18T01:54:38.182Z",
  "createdBy": "Jane Doe",
  "createdByEmail": "[email protected]",
  "updatedAt": "2026-03-31T03:59:29.114Z",
  "updatedBy": "Jane Doe",
  "updatedByEmail": "[email protected]"
}

On this page