curl --request POST \
--url 'https://api.stateset.com/api/v1/store-credits/{id}/apply' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"amount": "49.00",
"balance_after": "string",
"created_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store_credit_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "string"
}
Apply a store credit
credits//apply — debit a store credit (e.g. against an order). Rejected for non-positive amounts, non-active or expired credits, and insufficient balance
POST
/
api
/
v1
/
store-credits
/
{id}
/
apply
curl --request POST \
--url 'https://api.stateset.com/api/v1/store-credits/{id}/apply' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"amount": "49.00",
"balance_after": "string",
"created_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store_credit_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "string"
}
Credits/{id}/apply` — debit a store credit (e.g.
against an order). Rejected for non-positive amounts, non-active or
expired credits, and insufficient balance.
Path parameters
string
required
Store credit ID (UUID)
Request body
ApplyStoreCreditRequest
string
required
Amount to debit from the credit. Must be positive.
string,null
Optional reference (e.g. order ID) recorded on the transaction.
Response
StoreCreditTransactionResponse
string
required
string
required
string
required
string
required
string,null
string
required
string
required
Status codes
| Code | Meaning |
|---|---|
200 | — |
404 | — |
422 | — |
curl --request POST \
--url 'https://api.stateset.com/api/v1/store-credits/{id}/apply' \
--header "Authorization: Bearer $STATESET_API_KEY" \
--header 'Content-Type: application/json' \
--data '{
"amount": "49.00",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
{
"amount": "49.00",
"balance_after": "string",
"created_at": "2026-08-31T14:22:05Z",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reference_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"store_credit_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"transaction_type": "string"
}
Last modified on August 31, 2026