Skip to content

CustomerListItem ​

Type: schema

TypeScript Definition ​

typescript
CustomerListItem: {components["schemas"]["Customer"] & {
            user_id?: $Read<string>
}

Component References ​

ReferenceResolves To
components["schemas"]["Customer"]Customer

OpenAPI Schema ​

json
{
  "allOf": [
    {
      "$ref": "#/components/schemas/Customer"
    },
    {
      "type": "object",
      "properties": {
        "user_id": {
          "type": "string",
          "readOnly": true
        },
        "metadata": {
          "description": "Arbitrary key-value data stored against the customer.",
          "type": [
            "object",
            "null"
          ],
          "additionalProperties": true
        },
        "address": {
          "description": "A single address for the customer, `null` when none is saved.",
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/components/schemas/AdminCustomerAddress"
            }
          ]
        }
      }
    }
  ],
  "title": "CustomerListItem",
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: