data-src=../../../includes/saas-only.md

Store credit

Adobe Commerce as a Cloud Service has a separate role resource for using a customer's store credit. Admin users and integrations need the Can Spend Store Credit (Magento_CustomerBalance::spend_balance) resource to apply store credit to a cart and to place an order for a cart that already has store credit applied.

This resource is available in the user role and integration resources under Sales > Operations > Orders > Actions > Create > Can Spend Store Credit.

The Manage Store Credit Balances (Magento_CustomerBalance::manage_balance) resource allows users to view and update the store credit balances in the Admin. The following endpoints do not use it.

Authentication

The following endpoints require an admin or integration bearer token.

Customers apply their own store credit with the applyStoreCreditToCart GraphQL mutation and place the order with the placeOrder mutation, which do not require access to these resources.

REST API reference

Apply store credit to a cart

POST /V1/carts/:cartId/balance/apply applies the customer cart's store credit balance, up to the cart total. The request has no body.

Response (200):

true

Place an order for a cart with store credit

Store credit can be applied to a cart by the customer on the storefront or by another admin user or integration. Commerce deducts it from the customer's balance when the order is placed, so PUT /V1/carts/:cartId/order requires Magento_CustomerBalance::spend_balance whenever the cart has store credit applied. Without the resource, the request returns 401.

Error handling

When the token's role does not include every required resource, the endpoint returns 401. A rejected apply request does not apply store credit, and a rejected order request does not create an order or change the customer's balance.

{
  "message": "The consumer isn't authorized to access %resources.",
  "parameters": {
    "resources": "Magento_CustomerBalance::spend_balance"
  }
}

When the role includes Magento_Cart::manage but not Magento_CustomerBalance::spend_balance, the resources parameter depends on the request: