WooCommerce · Schema

Customer

A WooCommerce customer account.

eCommerceOpen SourceOrdersProductsWordPress

Properties

Name	Type	Description
id	integer	Customer unique identifier.
date_created	string	Date the customer was created.
date_modified	string	Date the customer was last modified.
email	string	Customer email address.
first_name	string	Customer first name.
last_name	string	Customer last name.
role	string	Customer WordPress user role.
username	string	Customer login username.
billing	object	Billing or shipping address associated with a customer or order.
shipping	object	Billing or shipping address associated with a customer or order.
is_paying_customer	boolean	Whether the customer has placed at least one order.
orders_count	integer	Total number of orders placed by the customer.
total_spent	string	Total amount spent by the customer as a decimal string.
avatar_url	string	URL of the customer's Gravatar image.
meta_data	array	Custom metadata attached to the customer.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-schema/woocommerce-rest-api-customer-schema.json",
  "title": "Customer",
  "description": "A WooCommerce customer account.",
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Customer unique identifier.",
      "example": 1
    },
    "date_created": {
      "type": "string",
      "format": "date-time",
      "description": "Date the customer was created.",
      "example": "2026-05-03T14:30:00Z"
    },
    "date_modified": {
      "type": "string",
      "format": "date-time",
      "description": "Date the customer was last modified.",
      "example": "2026-05-03T14:30:00Z"
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Customer email address.",
      "example": "[email protected]"
    },
    "first_name": {
      "type": "string",
      "description": "Customer first name.",
      "example": "Example Name"
    },
    "last_name": {
      "type": "string",
      "description": "Customer last name.",
      "example": "Example Name"
    },
    "role": {
      "type": "string",
      "description": "Customer WordPress user role.",
      "example": "string-value"
    },
    "username": {
      "type": "string",
      "description": "Customer login username.",
      "example": "Example Name"
    },
    "billing": {
      "type": "object",
      "description": "Billing or shipping address associated with a customer or order.",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name.",
          "example": "Example Name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name.",
          "example": "Example Name"
        },
        "company": {
          "type": "string",
          "description": "Company name.",
          "example": "string-value"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1.",
          "example": "string-value"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2.",
          "example": "string-value"
        },
        "city": {
          "type": "string",
          "description": "City name.",
          "example": "string-value"
        },
        "state": {
          "type": "string",
          "description": "ISO code or name of the state, province, or district.",
          "example": "string-value"
        },
        "postcode": {
          "type": "string",
          "description": "Postal code.",
          "example": "string-value"
        },
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code.",
          "example": "string-value"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address (billing only).",
          "example": "[email protected]"
        },
        "phone": {
          "type": "string",
          "description": "Phone number (billing only).",
          "example": "string-value"
        }
      }
    },
    "shipping": {
      "type": "object",
      "description": "Billing or shipping address associated with a customer or order.",
      "properties": {
        "first_name": {
          "type": "string",
          "description": "First name.",
          "example": "Example Name"
        },
        "last_name": {
          "type": "string",
          "description": "Last name.",
          "example": "Example Name"
        },
        "company": {
          "type": "string",
          "description": "Company name.",
          "example": "string-value"
        },
        "address_1": {
          "type": "string",
          "description": "Address line 1.",
          "example": "string-value"
        },
        "address_2": {
          "type": "string",
          "description": "Address line 2.",
          "example": "string-value"
        },
        "city": {
          "type": "string",
          "description": "City name.",
          "example": "string-value"
        },
        "state": {
          "type": "string",
          "description": "ISO code or name of the state, province, or district.",
          "example": "string-value"
        },
        "postcode": {
          "type": "string",
          "description": "Postal code.",
          "example": "string-value"
        },
        "country": {
          "type": "string",
          "description": "ISO 3166-1 alpha-2 country code.",
          "example": "string-value"
        },
        "email": {
          "type": "string",
          "format": "email",
          "description": "Email address (billing only).",
          "example": "[email protected]"
        },
        "phone": {
          "type": "string",
          "description": "Phone number (billing only).",
          "example": "string-value"
        }
      }
    },
    "is_paying_customer": {
      "type": "boolean",
      "description": "Whether the customer has placed at least one order.",
      "example": true
    },
    "orders_count": {
      "type": "integer",
      "description": "Total number of orders placed by the customer.",
      "example": 1
    },
    "total_spent": {
      "type": "string",
      "description": "Total amount spent by the customer as a decimal string.",
      "example": "string-value"
    },
    "avatar_url": {
      "type": "string",
      "format": "uri",
      "description": "URL of the customer's Gravatar image.",
      "example": "https://example.com/path"
    },
    "meta_data": {
      "type": "array",
      "description": "Custom metadata attached to the customer.",
      "items": {
        "type": "object",
        "description": "Custom metadata key-value entry.",
        "properties": {
          "id": {
            "type": "integer",
            "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"
      ]
    }
  }
}