List Store Credit Accounts

GET/store/:storeCode/store-credit-accounts

publishable keyJWT

List store credit accounts for the authenticated customer.

Path Parameters

storeCoderequiredstring

Store slug in the URL (first argument to every SDK store method).

Query Parameters

limitnumber

Maximum number of items to return.

offsetnumber

Number of items to skip before collecting the result set.

orderstring

Field to sort by. Prefix with `-` for descending order (e.g. `-created_at`).

fieldsstring

Comma-separated fields to include. Prefix with `*` to expand a relation (e.g. `id,*variants`).

currency_codestring

Filter by currency code.

created_atOperatorMap<string>

Filter by created date.

updated_atOperatorMap<string>

Filter by updated date.

Response

Status

200OK

Schema

Copy

HttpTypes.StoreStoreCreditAccountsResponse

Properties

store_credit_accountsrequiredStoreStoreCreditAccount[]

List of store credit accounts.

countrequirednumber

Total count.

offsetrequirednumber

Offset applied.

limitrequirednumber

Limit applied.