Skip to main content
POST
/
api
/
v1
/
customer
/
cancel
/
{orderId}
Cancel an order
curl --request POST \
  --url https://virtualsms.io/api/v1/customer/cancel/{orderId} \
  --header 'X-API-Key: <api-key>'
{
  "success": true,
  "order_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "cancelled",
  "refund_amount": 0.4
}

Documentation Index

Fetch the complete documentation index at: https://virtualsms.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key from virtualsms.io dashboard (Settings -> API tab). Prefix: vsms_

Path Parameters

​
orderId
string<uuid>
required

Order ID to cancel

Response

Order cancelled and refunded

​
success
boolean
Example:

true

​
order_id
string<uuid>
​
status
string
Example:

"cancelled"

​
refund_amount
number<float>
Example:

0.4