Skip to content

CustomerCreditBalance ​

Type: schema

TypeScript Definition ​

typescript
CustomerCreditBalance: {{
            /** @description Total bank-transfer payments received from the customer. */
            received_amount: number;
            /** @description Part of `received_amount` not available to spend: settled against orders, claimed by unpaid orders awaiting settlement, refunded or being refunded, or held for an admin's review. */
            settled_amount: number;
            /** @description Spendable bank-transfer credit: `received_amount` minus `settled_amount`. Can be below `0`, when unpaid orders have claimed more than is left; nothing can be spent then. Redeem at checkout via `POST /carts/{id}/credit-balance`. */
            balance_amount: number;
        };
        /** CustomerCreditLineBalance */
}

OpenAPI Schema ​

json
{
  "title": "CustomerCreditBalance",
  "type": "object",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/schemas/CustomerCreditBalance",
    "description": "API reference for the CustomerCreditBalance schema"
  },
  "required": [
    "received_amount",
    "settled_amount",
    "balance_amount"
  ],
  "properties": {
    "received_amount": {
      "description": "Total bank-transfer payments received from the customer.",
      "type": "number"
    },
    "settled_amount": {
      "description": "Part of `received_amount` not available to spend: settled against orders, claimed by unpaid orders awaiting settlement, refunded or being refunded, or held for an admin's review.",
      "type": "number"
    },
    "balance_amount": {
      "description": "Spendable bank-transfer credit: `received_amount` minus `settled_amount`. Can be below `0`, when unpaid orders have claimed more than is left; nothing can be spent then. Redeem at checkout via `POST /carts/{id}/credit-balance`.",
      "type": "number"
    }
  }
}

Auto-generated from OpenAPI spec and TypeScript definitions

Last updated: