WooCommerce · JSON Structure

Woocommerce Rest Api Order Refund Structure

A refund associated with an order.

Type: object Properties: 7
eCommerceOpen SourceOrdersProductsWordPress

OrderRefund is a JSON Structure definition published by WooCommerce, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id date_created amount reason refunded_by line_items meta_data

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-order-refund-structure.json",
  "name": "OrderRefund",
  "description": "A refund associated with an order.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Refund unique identifier.",
      "example": 1
    },
    "date_created": {
      "type": "datetime",
      "description": "Date the refund was created.",
      "example": "2026-05-03T14:30:00Z"
    },
    "amount": {
      "type": "string",
      "description": "Refund amount as a decimal string.",
      "example": "string-value"
    },
    "reason": {
      "type": "string",
      "description": "Reason for the refund.",
      "example": "string-value"
    },
    "refunded_by": {
      "type": "int32",
      "description": "User ID of the person who issued the refund.",
      "example": 1
    },
    "line_items": {
      "type": "array",
      "description": "Line items included in the refund.",
      "items": {
        "type": "object",
        "description": "A product line item within an order.",
        "properties": {
          "id": {
            "type": "int32",
            "description": "Line item unique identifier.",
            "example": 1
          },
          "name": {
            "type": "string",
            "description": "Product name at time of purchase.",
            "example": "Example Name"
          },
          "product_id": {
            "type": "int32",
            "description": "Product ID.",
            "example": 1
          },
          "variation_id": {
            "type": "int32",
            "description": "Variation ID (0 if not a variation).",
            "example": 1
          },
          "quantity": {
            "type": "int32",
            "description": "Quantity ordered.",
            "example": 1
          },
          "tax_class": {
            "type": "string",
            "description": "Tax class used for this line item.",
            "example": "string-value"
          },
          "subtotal": {
            "type": "string",
            "description": "Line subtotal (before discounts) as a decimal string.",
            "example": "string-value"
          },
          "subtotal_tax": {
            "type": "string",
            "description": "Line subtotal tax as a decimal string.",
            "example": "string-value"
          },
          "total": {
            "type": "string",
            "description": "Line total (after discounts) as a decimal string.",
            "example": "string-value"
          },
          "total_tax": {
            "type": "string",
            "description": "Line total tax as a decimal string.",
            "example": "string-value"
          },
          "sku": {
            "type": "string",
            "description": "Product SKU.",
            "example": "string-value"
          },
          "price": {
            "type": "double",
            "description": "Product price at time of purchase.",
            "example": 10.5
          },
          "meta_data": {
            "type": "array",
            "description": "Metadata for the line item (e.g. variation attributes).",
            "items": {
              "$ref": "#/components/schemas/MetaData"
            },
            "example": [
              "string-value"
            ]
          }
        }
      },
      "example": [
        "string-value"
      ]
    },
    "meta_data": {
      "type": "array",
      "description": "Custom metadata.",
      "items": {
        "type": "object",
        "description": "Custom metadata key-value entry.",
        "properties": {
          "id": {
            "type": "int32",
            "description": "Metadata unique identifier.",
            "example": 1
          },
          "key": {
            "type": "string",
            "description": "Metadata key.",
            "example": "string-value"
          },
          "value": {
            "type": "string",
            "description": "Metadata value.",
            "example": "string-value"
          }
        }
      },
      "example": [
        "string-value"
      ]
    }
  }
}