Account

Change credit limit of an account

Changed on Dec 21, 2023

Increases or decreases the credit limit of a customer credit account.

Permissions

Any user or API key must have at least one of the appropriate License Manager resources 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	Checking Accounts	Edit credits

There are no applicable predefined roles for this resource list. You must create a custom 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.

❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.

put/api/creditcontrol/accounts/{creditAccountId}/creditlimit

Request

Base URL
https://apiexamples.vtexcommercestable.com.br
URL
https://apiexamples.vtexcommercestable.com.br/api/creditcontrol/accounts/{creditAccountId}/creditlimit
Auth
- API key in header X-VTEX-API-AppKey and API key in header X-VTEX-API-AppToken
- or API key in header VtexIdclientAutCookie

Path parameters

creditAccountIdstring required

Example:01bce461-9g03-12ds-8217-b3d39271e15b

Credit account identification.

Headers

Content-Typestring required

Example:application/json

Type of the content being sent.

Acceptstring required

Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Request body

valuenumber required

Credit limit value.

Example request

{
  "value": 5500
}

Response

idstring required

Credit customer account identification.

balancenumber required

Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.

statusstring required

Credit customer account status.

creditLimitnumber required

Maximum credit amount on the account.

updatedAtstring required

Date of the last update made to the account.

createdAtstring required

Account creation date.

descriptionstring

This field is deprecated.

availableCreditnumber required

Credit amount available on the account.

preAuthorizedCreditnumber required

Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.

emailstring required

Account owner email.

tolerancenumber required

Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of 0.30 indicates that the account owner can use up to 30% above the account's original maximum credit amount.

availableBalancenumber required

Balance available for use on the account.

Changes

Dec 21, 20230cfe5b381175 Revision changes
- warning
  the optional response header connection removed for the status 200
- warning
  the optional response header content-length removed for the status 200
- warning
  the optional response header date removed for the status 200
- warning
  the optional response header server removed for the status 200
- warning
  the optional response header via removed for the status 200
- warning
  the optional response header x-cache removed for the status 200
- warning
  the optional response header x-cache-lookup removed for the status 200
- warning
  the optional response header x-powered-by removed for the status 200
- warning
  the optional response header x-vtex-janus-router-backend-app removed for the status 200
Nov 24, 2023c8735f67eb83 Revision changes
- breaking
  removed the media type text/plain for the response with the status
- info
  the request property default value 500.0 was removed
- info
  the request property type was generalized from integer to number, and format from number to no format
- info
  added the media type application/json for the response with the status

Operation history