Skip to main content
POST
Cancel an order

Rules

  • Full refund. Cancelling returns the entire amount you were charged. There is no proration and no cancellation fee.
  • 120-second cooldown. Cancellation is refused for the first 120 seconds after purchase, with HTTP 425 Too Early.
  • Only before the first SMS. Once an SMS arrives the order leaves waiting status and can no longer be cancelled.
Error bodies carry an error string only — there is no seconds_remaining field.

Cancel or swap?

If the number simply is not receiving the SMS, swap instead. A swap is free and keeps your money on the order; cancelling and buying again charges you twice for one verification. Cancel when you no longer want the verification at all, or when no replacement number is available to swap to.

If you do nothing

An unused order auto-expires 20 minutes after purchase and is refunded automatically — no call needed. A background sweep runs every few seconds, so the refund lands promptly after the deadline. That makes doing nothing safe. It is not the fastest path to your money back, but you will never be charged for a verification that never arrived.

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