Skip to main content
POST
Use credit balance

Authorizations

Authorization
string
header
required

Access token

Headers

x-customer-group-id
string

Customer group used for loyalty eligibility when the signed-in user's session does not name a group. The session's group takes precedence.

Path Parameters

id
string
required

Cart ID

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json
credit_balance_used
number<double>
required

Cannot exceed the available customer credit balance or cart grand total. Accepts up to four decimal places.

Required range: 1 <= x <= 99999999999.9999
Example:

200

Response

OK

message
string
required
success
boolean
required
content
object
required