Skip to content

List store credit ledger rows

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

Every movement of store credit, newest first, with the balance after it, why and who made it. Amounts are in the currency’s main unit, not cents. Filter by profile_id or subscription_id, or leave both out for the whole store.

  • type: comma separated earned, adjusted, redeemed (spent on a renewal), reversed.
  • source: comma separated referral, loyalty_reward, playbook, manual, gro_agent, mcp, api, billing.
  • page / limit: pagination (limit capped at 100, default 25).
page
number
limit
number
profile_id
string
subscription_id
string
type
string
source
string
Media typeapplication/json
object
data
required
Array<object>
object
id
required
string
created_at
string
nullable
type
required
string
Allowed values: earned adjusted redeemed reversed
currency_code
required
string
profile_id
required
string
profile
object
id
string
email
string
full_name
string
is_reversed
required
boolean
amount
required
number
balance_after
required
number
source
required
string
Allowed values: referral earning_rule manual gro_agent mcp api billing loyalty_reward playbook
reason
One of:
string
nullable
note
string
nullable
subscription_id
string
nullable
referral_id
string
nullable
earning_rule_id
string
nullable
shopify_order_id
string
nullable
reverses_transaction_id
string
nullable
actor_type
required
string
Allowed values: user system customer api
actor_name
string
nullable
subscription
object
number
string
id
string
order
object
number
number
nullable
id
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

{
"data": [
{
"type": "earned",
"source": "referral",
"reason": "goodwill",
"actor_type": "user"
}
]
}