ReDoc documentation

customers/{customerId}/balance/{websiteId}

customers/{customerId}/balance/{websiteId}

Get customer store credit balance for a given website

Request
path Parameters
customerId
required
integer
websiteId
required
integer

If null, will use current store's website ID

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

get/V1/customers/{customerId}/balance/{websiteId}
Response samples
{
  • "balance_id": 0,
  • "customer_id": 0,
  • "website_id": 0,
  • "amount": 0,
  • "base_currency_code": "string"
}