Credits API

Manage store credit balances for your customers.

Overview

Credits are tracked per customer as a ledger of grants and spends.

Endpoints

MethodEndpointDescription
GET/v1/credits/{customer}/balanceGet balance
POST/v1/credits/{customer}/grantsGrant credits
POST/v1/credits/{customer}/spendsSpend credits

Idempotency

Send an Idempotency-Key header on writes to avoid duplicate grants.