---
title: "Cancel Order"
method: PUT
path: "/orders/{orderId}/cancel"
tags: ["Orders"]
---

# Cancel Order

`PUT /orders/{orderId}/cancel`

## Request

- Base URL: `https://api.thanks.io/api/v2`
- URL: `https://api.thanks.io/api/v2/orders/{orderId}/cancel`
- Auth: HTTP bearer

If Order is in _Reviewing_ Status, then this will cancel the order and refund the credits for the order back to your account.  If the order can be successfully canceled, the status will be updated to _cancelled_.

## Path parameters

- `orderId` string, required

## Response `200`

OK

- object
  - `order` Order
    - `id` integer
    - `message` string
    - `size` string: Only valid for postcards
    - `sub_account_id` integer, nullable
    - `type` 'postcard' | 'postcard6x9' | 'postcard6x11' | 'letter' | 'notecard' | 'giftcard' | 'windowlessletter'
    - `display_type` string
    - `style` integer: Handwriting Style ID used for this order
    - `front_image` string
    - `high_quality_preview` string: PDF of the high quality preview of the order
    - `authorization_total` integer
    - `grand_total` integer
    - `order_total` integer
    - `total_estimated_recipients` integer
    - `total_recipients` integer
    - `recipient_count` integer
    - `status` string
    - `method` string
    - `cancellable` boolean
    - `total_scans` integer
    - `metadata` object, nullable: The metadata object submitted with the order, returned exactly as it was sent. Null when the order was created without metadata.
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Changes

- **2026-10-01** `02de08ab2a47`: 1 warning
  - added the new `postcard6x9` enum value to the `order/type` response property for the response status `200`
- **2026-08-20** `4f2a64d375d2`: 1 info
  - added the optional property `order/metadata` to the response with the `200` status
- **2025-09-10** `94e89686cb6b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/thanks-io/apis/thanks-io-api/changes/orders/:orderId/cancel/put.md)

---

[API](https://skmtc.dev/thanks-io/apis/thanks-io-api.md) · [All operations](https://skmtc.dev/thanks-io/apis/thanks-io-api/llms.txt) · [OpenAPI document](https://skmtc.dev/thanks-io/apis/thanks-io-api/revisions/c403fbf3dc0f?raw)