useBalance

abstract suspend fun useBalance(request: UseBalanceRequest, idempotencyKey: IdempotencyKey? = null): ApiResult<BalanceUpdate>

Spend funds from a Customer balance for a purchase.

Return

The resulting updated BalanceUpdate or an ApiResult.Error

Parameters

request

The specifics for the balance decrease

idempotencyKey

Optional idempotency key. For more details see Idempotency