Skip to content

Get a customer's store credit balances

GET
/api/subscriptions/credits/balances
curl --request GET \
--url 'https://api.usegro.co/api/subscriptions/credits/balances?profile_id=example' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <X-API-Key>'

One balance per currency the customer has ever held credit in, in the currency’s main unit (not cents). Credit comes off their subscription renewals automatically.

profile_id
required
string
Media typeapplication/json
object
data
Array<object>
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
}
}
]
}