Skip to content

Reverse a store credit ledger row

POST
/api/subscriptions/credits/transactions/{id}/reverse
curl --request POST \
--url https://api.usegro.co/api/subscriptions/credits/transactions/example/reverse \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <X-API-Key>' \
--data '{ "note": "example" }'

Adds a reversal row that moves the same amount back. Nothing is deleted. A row can only be reversed once, and credit spent on an order or a reversal cannot be reversed.

id
required
string
Media typeapplication/json
object
note
required

Why it is being reversed

string
<= 500 characters

Example generated

{
"note": "example"
}
Media typeapplication/json
object
data
object
data
required
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

Example

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

Already reversed, or not reversible

Media typeapplication/json