---
title: "Retrieve store configuration"
method: GET
path: "/api/creditcontrol/storeconfig"
tags: ["Store Configuration"]
---

# Retrieve store configuration

`GET /api/creditcontrol/storeconfig`

Gets store configuration data related to [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).

## Permissions

Any user or [API key](https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:

| **Product** | **Category** | **Resource** |
| --------------- | ----------------- | ----------------- |
| Credit Control | Main | **Main Access** |
| Credit Control | Store Configuration | **Read Configuration** |

There are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).

>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing API keys](https://help.vtex.com/en/tutorial/best-practices-api-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations.

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Response `200`

OK

- object
  - `dailyInterestRate` number, required — Daily interest rate (percent 0.1 = 10%).
  - `invoicePostponementLimit` number, required — Maximum number of postponements allowed.
  - `taxRate` number, required — Tax rate value (percent 0.1 = 10%).
  - `maxPostponementDays` number, required — Maximum number of days of postponement.
  - `defaultCreditValue` number, required — Default credit amount.
  - `postponementEnabled` boolean, required — Postponement option activated.
  - `automaticCheckingAccountCreationEnabled` boolean, required — Allows users who have not previously received credit to complete an order.
  - `toleranceEnabled` boolean, required — Allows orders to be placed even if they exceed X % of the account's credit limit.
  - `myCreditsEnabled` boolean, required — Show the [My Credits](https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0#my-credits) page on storefront.
  - `maxPreAuthorizationGrowthRate` number, required — Pre-authorization growth-rate value (percent 0.1 = 10%).
  - `notificationsSettings` object — Notification settings information.
    - `daysPrior` object[] — Notification information sent before invoice payment date.
      - `days` integer, required — How many days before the invoice payment date is the notification sent.
      - `timeOfDay` string, required — Notification sending time.
    - `daysAfter` object[] — Notification information sent after invoice payment date.
      - `days` integer, required — How many days after the invoice payment date is the notification sent.
      - `timeOfDay` string, required — Notification sending time.

## Changes

- **2023-12-21** `0cfe5b381175` — 10 warning
  - the optional response header `Connection` removed for the status `200`
  - the optional response header `Content-Length` removed for the status `200`
  - the optional response header `Date` removed for the status `200`
  - the optional response header `Server` removed for the status `200`
  - …6 more
- **2023-11-27** `c812a194b17d` — 1 breaking
  - the `maxPreAuthorizationGrowthRate` response's property type/format changed from `string`/`` to `number`/`` for status `200`
- **2023-11-24** `c8735f67eb83` — 2 breaking, 8 info
  - the `invoicePostponementLimit` response's property type/format changed from `integer`/`int32` to `number`/`` for status `200`
  - removed the required property `tolerancePercent` from the response with the `200` status
  - added the optional property `notificationsSettings` to the response with the `200` status
  - added the required property `automaticCheckingAccountCreationEnabled` to the response with the `200` status
  - …6 more
- **2023-11-17** `1a0ba22582f0` — 1 info
  - media type `application/json; charset=utf-8` was changed to `application/json` for the response status `200`

[Change history](https://skmtc.dev/vtex/apis/customer-credit-api/changes/api/creditcontrol/storeconfig/get.md)

---

[API](https://skmtc.dev/vtex/apis/customer-credit-api.md) · [All operations](https://skmtc.dev/vtex/apis/customer-credit-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/customer-credit-api/revisions/831ad1f05e7d/schema)