GET
/
store
/
store-credit-accounts
cURL
curl '{backend_url}/store/store-credit-accounts' \
-H 'x-publishable-api-key: {your_publishable_api_key}'
{
  "limit": 123,
  "offset": 123,
  "count": 123,
  "store_credit_accounts": [
    {
      "customer": {
        "id": "<string>",
        "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": "usd",
            "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_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

​
connect.sid
string
cookie
required

Headers

​
x-publishable-api-key
string
required

Publishable API Key created in the Medusa Admin.

Query Parameters

​
currency_code
string

Filter by the store credit account's currency code.

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.

​
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 -.

​
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.

​
$and
$and · object[]

Join query parameters with an AND condition. Each object's content is the same type as the expected query parameters.

​
$or
$or · object[]

Join query parameters with an OR condition. Each object's content is the same type as the expected query parameters.

Response

OK

The paginated list of store credit accounts.

​
limit
number
required

The maximum number of store credit accounts to return.

​
offset
number
required

The number of store credit accounts to skip before retrieving the results.

​
count
number
required

The total number of store credit accounts available.

​
store_credit_accounts
object[]
required

The list of store credit accounts.

​
estimate_count
number

The store credit account's estimate count.