Skip to content

LoyaltyTier ​

Type: schema

TypeScript Definition ​

typescript
LoyaltyTier: {{
            id?: $Read<string>;
            /** @description name of loyalty tier */
            name: string;
            /** @description It should be null if tier upgrade criteria is total orders only. */
            total_spent_threshold: number | null;
            /** @description It should be null if tier upgrade criteria is total spent only. */
            total_orders_threshold: number | null;
            /** @description The rate at which points are earned. For point earning type = dynamic */
            points_earning_rate: number | null;
            /** @description Fixed loyalty points for all orders. For point earning type = fixed */
            fixed_points: number | null;
            /** @description only one tier will have value as True */
            is_initial?: $Read<boolean>;
            /** @description id of next loyalty tier */
            next_tier_id?: $Read<string | null>;
        };
        /** MandateDebitSchedule */
}

OpenAPI Schema ​

json
{
  "title": "LoyaltyTier",
  "type": "object",
  "required": [
    "name",
    "total_spent_threshold",
    "total_orders_threshold",
    "points_earning_rate",
    "fixed_points"
  ],
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true
    },
    "name": {
      "description": "name of loyalty tier",
      "type": "string"
    },
    "total_spent_threshold": {
      "description": "It should be null if tier upgrade criteria is total orders only.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "total_orders_threshold": {
      "description": "It should be null if tier upgrade criteria is total spent only.",
      "type": [
        "integer",
        "null"
      ],
      "minimum": 0
    },
    "points_earning_rate": {
      "description": "The rate at which points are earned. For point earning type = dynamic",
      "type": [
        "number",
        "null"
      ]
    },
    "fixed_points": {
      "description": "Fixed loyalty points for all orders. For point earning type = fixed",
      "type": [
        "integer",
        "null"
      ]
    },
    "is_initial": {
      "description": "only one tier will have value as True",
      "type": "boolean",
      "readOnly": true
    },
    "next_tier_id": {
      "description": "id of next loyalty tier",
      "type": [
        "string",
        "null"
      ],
      "readOnly": true
    }
  },
  "x-tags": [
    "Customers"
  ]
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: