curl --silent --show-error --fail-with-body --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 --silent --show-error --fail-with-body --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"
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
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 | — |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --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 September 21, 2026