Skip to content

CreditLine ​

Type: schema

Description ​

A customer's NACH credit line: whether they may order on credit, and their current balance.

TypeScript Definition ​

typescript
CreditLine: {{
            /** @description Whether the customer may order on credit, as an admin set it. */
            is_eligible: boolean;
            /** @description The customer's current credit-line balance. */
            credit_line_balance: {
                total_credit_limit: number;
                /** @description Credit held by NACH orders: added when a debit is scheduled, released when it succeeds, is recovered or is cancelled. */
                utilized_amount: number;
                /** @description Credit still available: `0` until a mandate activates, then `total_credit_limit` minus `utilized_amount`. */
                balance_amount: number;
                /** @description The most one debit may take; it sets the `max_amount` of mandates created afterwards. */
                mandate_per_order_limit?: number;
                /** Format: date-time */
                created_at?: string;
                /** Format: date-time */
                modified_at?: string;
            } | null;
        };
        /** CreditLineConfig */
}

OpenAPI Schema ​

json
{
  "title": "CreditLine",
  "description": "A customer's NACH credit line: whether they may order on credit, and their current balance.",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CreditLine",
    "description": "API reference for the CreditLine schema"
  },
  "required": [
    "credit_line_balance",
    "is_eligible"
  ],
  "properties": {
    "is_eligible": {
      "description": "Whether the customer may order on credit, as an admin set it.",
      "type": "boolean"
    },
    "credit_line_balance": {
      "description": "The customer's current credit-line balance.",
      "type": [
        "object",
        "null"
      ],
      "properties": {
        "total_credit_limit": {
          "type": "number"
        },
        "utilized_amount": {
          "description": "Credit held by NACH orders: added when a debit is scheduled, released when it succeeds, is recovered or is cancelled.",
          "type": "number"
        },
        "balance_amount": {
          "description": "Credit still available: `0` until a mandate activates, then `total_credit_limit` minus `utilized_amount`.",
          "type": "number"
        },
        "mandate_per_order_limit": {
          "description": "The most one debit may take; it sets the `max_amount` of mandates created afterwards.",
          "type": "number"
        },
        "created_at": {
          "type": "string",
          "format": "date-time"
        },
        "modified_at": {
          "type": "string",
          "format": "date-time"
        }
      },
      "required": [
        "balance_amount",
        "total_credit_limit",
        "utilized_amount"
      ]
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: