Skip to content

Customer credit

Open .md

API reference Customers Customers

Customer credit: money held for a customer, added or taken out by hand and used to pay their sales orders.

Learn more: Take payments and refunds

3 operations

  • POSTAdd or take out customer credit/v1/api/store/{team_slug}/customer/{hash_id}/creditAdds credit to the customer's balance (action: deposit) or takes it out (action: withdraw), and returns the entry.
  • GETList a customer's credit history/v1/api/store/{team_slug}/customer/{hash_id}/creditLists the customer's credit entries, newest first: credit added or taken out by hand, credit used to pay sales orders, sales order payments refunded to credit, Customer Portal payments received into credit and later changes to them…
  • GETGet a customer credit entry/v1/api/store/{team_slug}/customer/{hash_id}/credit/{id}Returns one credit entry of the customer.