GET
/
admin
/
store-credit-accounts
curl '{backend_url}/admin/store-credit-accounts' \
-H 'Authorization: Bearer {access_token}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "store_credit_accounts": [
    {
      "customer": {
        "id": "<string>",
        "has_account": true,
        "groups": [
          {
            "id": "<string>",
            "name": "<string>",
            "customers": [
              {}
            ],
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "email": "jsmith@example.com",
        "default_billing_address_id": "<string>",
        "default_shipping_address_id": "<string>",
        "company_name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "addresses": [
          {
            "id": "<string>",
            "address_name": "<string>",
            "is_default_shipping": true,
            "is_default_billing": true,
            "customer_id": "<string>",
            "company": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "address_1": "<string>",
            "address_2": "<string>",
            "city": "<string>",
            "country_code": "us",
            "province": "us-ca",
            "postal_code": "<string>",
            "phone": "<string>",
            "metadata": {},
            "created_at": "2023-11-07T05:31:56Z",
            "updated_at": "2023-11-07T05:31:56Z"
          }
        ],
        "phone": "<string>",
        "metadata": {},
        "created_by": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z"
      },
      "id": "<string>",
      "customer_id": "<string>",
      "currency_code": "usd",
      "credits": 123,
      "debits": 123,
      "balance": 123,
      "transaction_groups": [
        {
          "id": "<string>",
          "code": "<string>",
          "credits": 123,
          "debits": 123,
          "balance": 123,
          "account": {},
          "metadata": {}
        }
      ],
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "estimate_count": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
fields
string

Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields. The fields and relations to retrieve separated by commas.

Learn more in the API reference.

​
id

Filter by the store credit account's ID. Filter by a store credit account ID.

​
customer_id

Filter by customer ID(s) to retrieve their store credit accounts. Filter by a customer ID to retrieve their store credit accounts.

​
transaction_group_id

Filter by the associated transaction group's ID. Filter by the associated transaction group ID.

​
currency_code

Filter by currency code(s) to retrieve store credit accounts in specific currencies. Filter by a currency code to retrieve store credit accounts in that currency.

Example:

"usd"

​
created_at
object

Filter by a store credit account's creation date.

​
updated_at
object

Filter by a store credit account's update date.

​
$and
$and · object[]

An array of filters to apply on the entity, where each item in the array is joined with an "and" condition.

​
$or
$or · object[]

An array of filters to apply on the entity, where each item in the array is joined with an "or" condition.

​
limit
number

Limit the number of items returned in the list.

​
offset
number

The number of items to skip when retrieving a list.

​
order
string

The field to sort the data by. By default, the sort order is ascending. To change the order to descending, prefix the field name with -.

Response

200
application/json

OK

The paginated list of store credit accounts.