CustomerCreditLineBalance

Type: schema

TypeScript Definition

CustomerCreditLineBalance: {{
            /** @description Upper cap on the mandate amount. Sourced into `CustomerMandate.mandate_per_order_limit` when the mandate is created. */
            mandate_per_order_limit: number;
            /** @description Total spending limit approved for the customer. Cannot exceed `mandate_per_order_limit`. */
            total_credit_limit: number;
            /** @description Approved limit currently committed to in-flight or completed orders. */
            utilized_amount: number;
            /** @description Remaining spendable balance (`total_credit_limit` minus `utilized_amount`). */
            balance_amount: number;
            store_id: string;
            /** Format: date-time */
            created_at: string;
            /** Format: date-time */
            modified_at: string;
        };
        /** CustomerGroup */
}

OpenAPI Schema

{
  "title": "CustomerCreditLineBalance",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerCreditLineBalance",
    "description": "API reference for the CustomerCreditLineBalance schema"
  },
  "required": [
    "mandate_per_order_limit",
    "total_credit_limit",
    "utilized_amount",
    "balance_amount",
    "store_id",
    "created_at",
    "modified_at"
  ],
  "properties": {
    "mandate_per_order_limit": {
      "description": "Upper cap on the mandate amount. Sourced into `CustomerMandate.mandate_per_order_limit` when the mandate is created.",
      "type": "number"
    },
    "total_credit_limit": {
      "description": "Total spending limit approved for the customer. Cannot exceed `mandate_per_order_limit`.",
      "type": "number"
    },
    "utilized_amount": {
      "description": "Approved limit currently committed to in-flight or completed orders.",
      "type": "number"
    },
    "balance_amount": {
      "description": "Remaining spendable balance (`total_credit_limit` minus `utilized_amount`).",
      "type": "number"
    },
    "store_id": {
      "type": "string"
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    },
    "modified_at": {
      "type": "string",
      "format": "date-time"
    }
  }
}

---

Auto-generated from OpenAPI spec and TypeScript definitions