redeem-credit-balance

Method: POST
Path: /carts/{id}/credit-balance

Tags: Carts

Summary

Use credit balance

Description

Use credit balance

Storefront SDK Usage

SDK Method: sdk.cart.redeemCreditBalance()

Example:

const { data, error } = await sdk.cart.redeemCreditBalance(
  { id: "01H9CART12345ABCDE" },
  { credit_balance_used: 250.00 }
);

if (error) {
  console.error("Failed to redeem credit balance:", error.message);
} else {
  console.log("Credit applied, new total:", data.cart.grand_total);
  console.log("Credit used:", data.cart.credit_balance_used);
}

TypeScript Definition

"redeem-credit-balance": {
        parameters: {
            query?: never;
            header?: never;
            path: {
                /** @description Cart ID */
                id: string;
            };
            cookie?: never;
        };
        requestBody: {
            content: {
                "application/json": {
                    /**
                     * Format: double
                     * @example 200
                     */
                    credit_balance_used: number;
                };
            };
        };
        responses: {
            /** @description OK */
            200: {
                headers: {
                    [name: string]: unknown;
                };
                content: {
                    "application/json": {
                        message: string;
                        success: boolean;
                        content: {
                            cart: components["schemas"]["Cart"];
                        };
                    };
                };
            };
            400: components["responses"]["BadRequest"];
            401: components["responses"]["Unauthorized"];
        };
    };

Component References

Reference	Resolves To
components["schemas"]["Cart"]	Cart
components["responses"]["BadRequest"]	BadRequest
components["responses"]["Unauthorized"]	Unauthorized

Request Body

Content Types: application/json

Responses

200

OK

400

Bad request

401

Not authorized for given operation on the Resource

OpenAPI Definition

{
  "tags": [
    "Carts"
  ],
  "operationId": "redeem-credit-balance",
  "summary": "Use credit balance",
  "description": "Use credit balance",
  "externalDocs": {
    "url": "https://llm-docs.commercengine.io/storefront/operations/redeem-credit-balance",
    "description": "API reference for the redeem-credit-balance operation"
  },
  "requestBody": {
    "description": "",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "credit_balance_used"
          ],
          "properties": {
            "credit_balance_used": {
              "type": "number",
              "format": "double",
              "examples": [
                200
              ]
            }
          }
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "message",
              "success",
              "content"
            ],
            "properties": {
              "message": {
                "type": "string"
              },
              "success": {
                "type": "boolean"
              },
              "content": {
                "properties": {
                  "cart": {
                    "$ref": "#/components/schemas/Cart"
                  }
                },
                "required": [
                  "cart"
                ],
                "type": "object"
              }
            }
          }
        }
      }
    },
    "400": {
      "$ref": "#/components/responses/BadRequest"
    },
    "401": {
      "$ref": "#/components/responses/Unauthorized"
    }
  },
  "security": [
    {
      "Authorization": []
    }
  ],
  "x-speakeasy-group": "carts",
  "x-speakeasy-ignore": true,
  "x-speakeasy-name-override": "redeemCreditBalance"
}

---

Auto-generated from OpenAPI spec and TypeScript definitions