Skip to content

List customers with store credit

GET
/api/subscriptions/credits/customers
curl --request GET \
--url 'https://api.usegro.co/api/subscriptions/credits/customers?sort_by=balance&sort_order=asc' \
--header 'Authorization: Bearer <token>' \
--header 'X-API-Key: <X-API-Key>'

One row per customer per currency they hold credit in, in the currency’s main unit, not cents. Each row has the balance now, all the credit ever added (earned or added by hand, before any removals) and all the credit spent on orders.

  • sort_by: balance (default), added, spent or updated_at (last change).
  • sort_order: desc (default, highest or newest first) or asc.
  • page / limit: pagination (limit capped at 100, default 25).
page
number
limit
number
sort_by
string
Allowed values: balance added spent updated_at
sort_order
string
Allowed values: asc desc
Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
updated_at
string
nullable
currency_code
required
string
balance
required
number
total_added
required
number
total_spent
required
number
profile_id
required
string
profile
object
id
string
email
string
full_name
string
meta
required
object
total

Total number of items

number
per_page

Items per page

number
current_page

Current page number

number
last_page

Last page number

number
first_page

First page number

number
first_page_url

URL for first page

string
last_page_url

URL for last page

string
next_page_url

URL for next page

string
nullable
previous_page_url

URL for previous page

string
nullable

Example generated

{
"data": [
{
"id": "example",
"updated_at": "example",
"currency_code": "example",
"balance": 1,
"total_added": 1,
"total_spent": 1,
"profile_id": "example",
"profile": {
"id": "example",
"email": "example",
"full_name": "example"
}
}
],
"meta": {
"total": 1,
"per_page": 1,
"current_page": 1,
"last_page": 1,
"first_page": 1,
"first_page_url": "example",
"last_page_url": "example",
"next_page_url": "example",
"previous_page_url": "example"
}
}