latestOpenAPI 3.0.02026-08-1056429755.6 KB

a6efafc1669c

Refund

Order Refund Schema

Gets JSON schema for order refund

get/orders/{orderId}/refunds/schema

Path parameters

orderIdstring required

The order's ID.

Response

Successful response.

OR

Example response

{
  "id": "ref_5823594809",
  "orderId": "ord_6645940010",
  "invoiceId": "5823594809",
  "currency": "USD",
  "type": "shipping",
  "amount": 9.99,
  "refundedAmount": 9.99,
  "items": [
    {
      "type": "tax",
      "skuId": "sku_5823594809",
      "quantity": 1,
      "amount": 5.95,
      "percent": 10
    }
  ],
  "reason": "requested_by_customer",
  "failureReason": "expired_or_canceled_card",
  "state": "created",
  "tokenInformation": {
    "token": "bb3f0f17-567a-4c87-8cbd-76d93a750709"
  },
  "charges": [
    {
      "id": "c5b02ace-115d-4433-8841-8165d4c927a8",
      "refunds": [
        {
          "amount": 42.95,
          "state": "complete"
        }
      ],
      "sourceId": "376e6777-d92b-4d35-a460-44f29327a18e"
    }
  ],
  "source": "string",
  "metadata": {
    "coupon": "iOS"
  }
}