Cancel a Starlink Service Line
Cancel the specified Starlink service line.
Required Capabilities
Starlink Manager
Request
Path parameters
Reference ID of the Starlink service line to cancel.
Body parameters
Whether to cancel the service line immediately. If false, the service line will be cancelled at the end of the current billing cycle.
Response
200 The service line is cancelled successfully
A json is returned in the response body with the following fields:
Reference ID of the service line.
Reference ID of the Starlink account the service line belongs to.
Name of the service line.
Type of the service line.
LOCAL— Local priority data planGLOBAL— Global priority data plan
Reference ID of the Starlink address associated with the service line.
Terminal access charge of the service line.
Show child attributes
SKU of the terminal access charge product.
Product name of the terminal access charge.
Starlink product ID of the terminal access charge.
Data blocks included in the service line plan.
Show child attributes
SKU of the data block product.
Product name of the data block.
Starlink product ID of the data block.
Data volume of the data block.
Unit of the data volume (e.g. GB).
Quantity of the data block.
Auto top-up status of the service line.
OPT_IN— Opted in to auto top-up.OPT_OUT— Opted out of auto top-up.
Reference IDs of the Starlink devices assigned to the service line.
Date and time the service line was cancelled. null if not cancelled.
Indicates whether the service line is set to cancel immediately.
Starlink service line number. null if not yet assigned.
Date and time the service line starts. null if not applicable.
Date and time the service line ends. null if not applicable.
Top-ups applied to the service line.
Show child attributes
ID of the top-up.
Starlink request reference ID of the top-up.
SKU of the top-up product.
Product name of the top-up.
Starlink product ID of the top-up.
Data volume of the top-up.
Unit of the data volume.
Quantity of the top-up.
Date and time the top-up was synced to Starlink. null if not yet synced.
Date and time the top-up was created.
Username of the user who created the top-up.
Email of the user who created the top-up. null if not applicable.
Date and time the top-up was last updated.
Username of the user who last updated the top-up.
Email of the user who last updated the top-up. null if not applicable.
Plan changes scheduled or applied to the service line.
Show child attributes
ID of the change plan.
Starlink request reference ID of the change plan.
Indicates whether the plan change is scheduled for a future date.
Type of the change plan.
LOCAL— Local priority data planGLOBAL— Global priority data plan
Terminal access charge of the change plan.
Show child attributes
SKU of the terminal access charge product.
Product name of the terminal access charge.
Starlink product ID of the terminal access charge.
Data blocks included in the change plan.
Show child attributes
SKU of the data block product.
Product name of the data block.
Starlink product ID of the data block.
Data volume of the data block.
Unit of the data volume (e.g. GB).
Quantity of the data block.
Date and time the change plan takes effect. null if not applicable.
Date and time the change plan was cancelled. null if not cancelled.
Date and time the change plan was synced to Starlink. null if not yet synced.
Date and time the change plan was created.
Username of the user who created the change plan.
Email of the user who created the change plan. null if not applicable.
Date and time the change plan was last updated.
Username of the user who last updated the change plan.
Email of the user who last updated the change plan. null if not applicable.
Status of the service line. null if not applicable.
Current data usage information of the service line. null if not available.
Show child attributes
Total data usage limit in GB for the current billing cycle.
Total data consumed in GB for the current billing cycle.
Breakdown of data usage by block.
Show child attributes
Start date and time of the data block period.
Expiry date and time of the data block.
Total data amount in GB for this block.
Data consumed in GB for this block.
Type of the data block.
Number of blocks aggregated in this entry.
Start of the current billing cycle. null if not applicable.
End of the current billing cycle. null if not applicable.
Start of the recurring data period. null if not applicable.
End of the recurring data period. null if not applicable.
Date and time Starlink last updated the usage data. null if not applicable.
Date and time the usage data was last synced. null if not applicable.
Starlink sync information of the service line.
Show child attributes
The sync status of the service line. null if not applicable.
PENDING— The sync is pending.ABORTED— The sync has been aborted.SYNCING— The sync is in progress.SYNCED— The sync has completed.
The number of times the service line sync has been run.
The maximum number of times the service line sync can be run.
The last time the service line was synced. null if not applicable.
Date and time the service line was created.
Username of the user who created the service line.
Email of the user who created the service line. null if not applicable.
Date and time the service line was last updated.
Username of the user who last updated the service line.
Email of the user who last updated the service line. null if not applicable.
400 Request is invalid
No service line is cancelled 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/service-lines/{refId}/cancel' \ -H 'Authorization: Bearer {token}' \ -H 'Content-Type: application/json' \ --data-raw '{"isCancelNow": true}'Response
{
"refId": "11",
"starlinkAccountRefId": "3",
"type": "LOCAL",
"name": "Example Office 3/F",
"starlinkAddressRefId": "3",
"terminalAccessCharge": {
"sku": "SLK-LP-TAC-US",
"productName": "Starlink Local Priority Terminal Access Charge - US",
"starlinkProductId": "us-enterprise-local-priority-terminal-access-fee-usd"
},
"dataBlocks": [
{
"sku": "SLK-LP-500GB-DB-US",
"productName": "Starlink Local Priority 500 GB Data Block - US",
"starlinkProductId": "us-enterprise-local-priority-500gb-data-block-usd",
"dataVolume": 500,
"dataUnit": "GB",
"quantity": 1
}
],
"autoTopupStatus": "OPT_OUT",
"starlinkDeviceRefIds": [],
"cancelledAt": "2026-03-25T07:35:43.943Z",
"isCancelNow": true,
"starlinkServiceLineNumber": "SL-XX-0000000-00000-00",
"serviceStartAt": "2026-03-25T07:34:30.626Z",
"serviceEndAt": null,
"topups": [
{
"id": "00000000-0000-0000-0000-000000000001",
"starlinkRequestRefId": "9",
"sku": "SLK-LP-50GB-TO-US",
"productName": "Starlink Local Priority - 50 GB Top-Up - US",
"starlinkProductId": "us-enterprise-local-priority-50gb-data-topup-usd",
"dataVolume": 50,
"dataUnit": "GB",
"quantity": 1,
"starlinkSyncedAt": "2026-01-29T00:00:00.000Z",
"createdAt": "2026-01-29T04:18:55.683Z",
"createdBy": "John Smith",
"createdByEmail": "[email protected]",
"updatedAt": "2026-01-29T05:23:40.652Z",
"updatedBy": "John Smith",
"updatedByEmail": "[email protected]"
},
{
"id": "00000000-0000-0000-0000-000000000002",
"starlinkRequestRefId": "14",
"sku": "SLK-LP-50GB-TO-US",
"productName": "Starlink Local Priority - 50 GB Top-Up - US",
"starlinkProductId": "us-enterprise-local-priority-50gb-data-topup-usd",
"dataVolume": 50,
"dataUnit": "GB",
"quantity": 1,
"starlinkSyncedAt": "2026-01-29T00:00:00.000Z",
"createdAt": "2026-01-29T04:18:55.683Z",
"createdBy": "John Smith",
"createdByEmail": "[email protected]",
"updatedAt": "2026-02-04T10:55:15.046Z",
"updatedBy": "John Smith",
"updatedByEmail": "[email protected]"
},
{
"id": "00000000-0000-0000-0000-000000000003",
"starlinkRequestRefId": "58",
"sku": "SLK-LP-50GB-TO-US",
"productName": "Starlink Local Priority - 50 GB Top-Up - US",
"starlinkProductId": "us-enterprise-local-priority-50gb-data-topup-usd",
"dataVolume": 50,
"dataUnit": "GB",
"quantity": 1,
"starlinkSyncedAt": "2026-01-29T00:00:00.000Z",
"createdAt": "2026-01-29T04:18:55.683Z",
"createdBy": "John Smith",
"createdByEmail": "[email protected]",
"updatedAt": "2026-03-02T08:23:26.778Z",
"updatedBy": "Jane Doe",
"updatedByEmail": "[email protected]"
}
],
"changePlans": [],
"status": "CANCELLED",
"starlinkDataUsage": {
"usageLimitGb": 108.2,
"consumedAmountGb": 0,
"dataBlocks": [
{
"startAt": "2026-03-25T07:34:30.425Z",
"expireAt": "2026-04-01T00:00:00.000Z",
"totalAmountGb": 108.2,
"consumedAmountGb": 0,
"dataBlockType": "RecurringPerBillingCycle",
"blocksCount": 1
}
],
"billingCycleStartAt": "2026-03-01T00:00:00.000Z",
"billingCycleEndAt": "2026-04-01T00:00:00.000Z",
"recurringDataStartAt": "2026-03-25T07:34:30.425Z",
"recurringDataEndAt": "2026-04-01T00:00:00.000Z",
"starlinkUpdatedAt": "1970-01-01T00:00:00.000Z",
"syncedAt": "2026-03-25T07:34:45.265Z"
},
"starlinkSync": {
"syncStatus": "SYNCED",
"runCount": 0,
"runCountLimit": 10,
"lastSyncedAt": "2026-03-25T07:34:39.271Z"
},
"createdAt": "2026-01-29T04:18:55.683Z",
"createdBy": "John Smith",
"createdByEmail": "[email protected]",
"updatedAt": "2026-03-25T07:35:43.943Z",
"updatedBy": "Jane Doe",
"updatedByEmail": "[email protected]"
}