Skip to content

Set a customer's store credit limit per order

PUT
/api/subscriptions/credits/balances/max-per-order
curl --request PUT \
--url https://api.usegro.co/api/subscriptions/credits/balances/max-per-order \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "profile_id": "example", "currency_code": "example", "max_per_order": 1 }'

The most store credit one of this customer’s orders can use, in the currency’s main unit, not cents. It replaces the store’s credits_max_per_order setting for this customer. Send max_per_order: null to remove it and use the store default again. currency_code defaults to the currency the customer holds credit in.

Media typeapplication/json
object
profile_id
required
string
currency_code
string
max_per_order
required
number
nullable <= 100000

Example generated

{
"profile_id": "example",
"currency_code": "example",
"max_per_order": 1
}
Media typeapplication/json
object
data
object
data
required
object
updated_at
string
nullable
currency_code
required
string
balance
required
number
max_per_order
number
nullable

Example generated

{
"data": {
"data": {
"updated_at": "example",
"currency_code": "example",
"balance": 1,
"max_per_order": 1
}
}
}