openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Account
paths:
  /api/creditcontrol/accounts:
    get:
      tags:
      - Account
      summary: VTex Search all accounts
      description: "Retrieves a list of all [customer credit accounts](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) in the store.\r\n\r\n>ℹ️ You can use the queries below (individually or combined) to obtain a more accurate search result. If your store has more than 20 customer credit accounts and you do not use any queries in the call, only the first 20 account records will appear in the response body.\r\n\r\n>ℹ️ Query params can be used individually or combined.\r\n\r\n### Queries to filter results\r\n\r\n- **By the location of the accounts in the list (quantity of accounts)**: `?from={int}&to={int}`\r\n- **By status**: `?status={Open, Closed or Cancelled}`\r\n- **By email**: `?email={string}`\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Read Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Searchallaccounts
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - name: from
        in: query
        description: Indicates the starting position of the credit customer account to be searched in the account list. Example, value `1` indicates that the first account in the list will be returned.
        required: false
        style: form
        schema:
          type: string
          example: '1'
      - name: to
        in: query
        description: Indicates the final position of the credit customer account to be searched in the account list. Example, if the value of `from` is equal to `1` and `to` is `40`, information from 40 accounts will be displayed in the response body of the request.
        required: false
        style: form
        schema:
          type: string
          example: '40'
      - name: status
        in: query
        description: Indicates the status of the accounts to be searched for.
        required: false
        style: form
        schema:
          type: string
          enum:
          - Open
          - Paid
          - Cancelled
          example: Paid
      - name: email
        in: query
        description: Indicates the email registered to the account to be searched.
        required: false
        style: form
        schema:
          type: string
          example: test@test.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - data
                - summary
                type: object
                properties:
                  data:
                    type: array
                    description: Data information.
                    items:
                      type: object
                      description: Object with information about each account.
                      required:
                      - id
                      - balance
                      - document
                      - status
                      - documentType
                      - creditLimit
                      - updatedAt
                      - createdAt
                      - availableCredit
                      - preAuthorizedCredit
                      - email
                      - tolerance
                      - availableBalance
                      properties:
                        id:
                          type: string
                          description: Credit customer account identification.
                        balance:
                          type: number
                          description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                        document:
                          type: string
                          description: Account owner document.
                        status:
                          type: string
                          description: Credit customer account status. This value will always come as `Open`. If an account is closed (`Closed`), it will not be displayed in the response body of this endpoint.
                          enum:
                          - Open
                          - Closed
                        documentType:
                          type: string
                          description: Document type.
                          enum:
                          - CPF
                          - CNPJ
                          - Other
                        creditLimit:
                          type: number
                          description: Maximum credit amount on the account.
                        updatedAt:
                          type: string
                          description: Date of the last update made to the account.
                        createdAt:
                          type: string
                          description: Account creation date.
                        description:
                          type: string
                          description: This field is deprecated.
                        availableCredit:
                          type: number
                          description: Credit amount available on the account.
                        preAuthorizedCredit:
                          type: number
                          description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                        email:
                          type: string
                          description: Account owner email.
                        tolerance:
                          type: number
                          description: 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.
                        availableBalance:
                          type: number
                          description: Balance available for use on the account.
                  summary:
                    required:
                    - count
                    type: object
                    description: Summary information.
                    properties:
                      count:
                        type: integer
                        description: Number of customer credit accounts in the store.
              example:
                data:
                - id: 39f5f920-149f-11ha-b5b0-2vb896d3212f
                  balance: 0
                  document: '4354353453454'
                  status: Open
                  documentType: CPF
                  creditLimit: 2000
                  updatedAt: '2020-01-02T15:26:40.3425717Z'
                  createdAt: '2019-12-04T14:06:02.7905117Z'
                  description: ''
                  availableCredit: 2000
                  preAuthorizedCredit: 0
                  email: wtest@gmail.com
                  tolerance: 20
                  availableBalance: 2000
                - id: 71d3f4e5-9164-11ea-918f-93b2a93cb9ba
                  balance: 0
                  document: '10120312'
                  status: Open
                  documentType: CPF
                  creditLimit: 1
                  updatedAt: '2020-05-08T19:16:40.7202156Z'
                  createdAt: '2020-05-08T19:16:40.5951631Z'
                  description: ''
                  availableCredit: 1
                  preAuthorizedCredit: 0
                  email: etest@yahoo.com
                  tolerance: 0
                  availableBalance: 1
                - id: 111111111_CPF
                  balance: 0
                  document: '111111111'
                  status: Open
                  documentType: CPF
                  creditLimit: 500
                  updatedAt: '2020-06-30T18:35:25.5793275Z'
                  createdAt: '2020-06-30T18:35:25.5011788Z'
                  description: ''
                  availableCredit: 500
                  preAuthorizedCredit: 0
                  email: atest@test.com
                  tolerance: 1
                  availableBalance: 500
                - id: 2222222222_CPF
                  balance: 0
                  document: '2222222222'
                  status: Open
                  documentType: CPF
                  creditLimit: 100
                  updatedAt: '2020-07-07T21:08:07.1796362Z'
                  createdAt: '2020-06-30T19:57:50.4832597Z'
                  description: ''
                  availableCredit: 100
                  preAuthorizedCredit: 0
                  email: dtest@hotmail.com
                  tolerance: 0
                  availableBalance: 100
                - id: 91d1f2e5-8169-11ea-728f-53b2a03cb8bc
                  balance: 0
                  document: '0000000000'
                  status: Open
                  documentType: CPF
                  creditLimit: 5000
                  updatedAt: '2020-07-28T18:50:46.7315579Z'
                  createdAt: '2020-06-30T18:49:35.424369Z'
                  description: ''
                  availableCredit: 5000
                  preAuthorizedCredit: 0
                  email: test@test.com
                  tolerance: 0
                  availableBalance: 5000
                summary:
                  count: 5
      deprecated: false
    post:
      tags:
      - Account
      summary: VTex Open an account
      description: "Opens a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) on your store.\r\n\r\n>⚠️ This request should only be used if you do not have an account yet registered. If you already have an account (open or closed) and want to create or modify an account, go to [Open or Change Account](https://developers.vtex.com/docs/api-reference/customer-credit-api#put-/api/creditcontrol/accounts/-accountId-) endpoint.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: OpenanAccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - document
              - documentType
              - email
              - creditLimit
              - description
              - tolerance
              type: object
              properties:
                document:
                  type: string
                  description: Account owner document.
                  example: '11111111111'
                documentType:
                  type: string
                  description: Document type.
                  enum:
                  - CPF
                  - CNPJ
                  - Other
                  example: CPF
                email:
                  type: string
                  description: Account owner email.
                  example: test@test.com
                creditLimit:
                  type: string
                  description: Maximum credit amount on the account.
                  example: '1100'
                description:
                  type: string
                  description: This field is deprecated.
                  example: Not applicable.
                  deprecated: true
                tolerance:
                  type: string
                  description: 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.
                  example: '0.2'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - document
                - status
                - documentType
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  document:
                    type: string
                    description: Account owner document.
                  status:
                    type: string
                    description: Credit customer account status.
                  documentType:
                    type: string
                    description: 'Document type. Possible values: `CPF`, `CNPJ` or `Other`.'
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: 11111111111_CPF
                balance: 0
                document: '11111111111'
                status: Open
                documentType: CPF
                creditLimit: 1100
                updatedAt: '2023-11-09T13:29:01.2505088Z'
                createdAt: '2023-11-09T13:29:01.1567887Z'
                description: ''
                availableCredit: 1100
                preAuthorizedCredit: 0
                email: ricardo@teste.com.br
                tolerance: 0.2
                availableBalance: 1100
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}:
    get:
      tags:
      - Account
      summary: VTex Retrieve an account by ID
      description: "Retrieves a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) by the credit account identification.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Read Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: RetrieveaAccountbyId
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - document
                - status
                - documentType
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  document:
                    type: string
                    description: Account owner document.
                  status:
                    type: string
                    description: Credit customer account status.
                  documentType:
                    type: string
                    description: 'Document type. Possible values: `CPF`, `CNPJ` or `Other`.'
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: 11111111111_CPF
                balance: 0
                document: '11111111111'
                status: Open
                documentType: CPF
                creditLimit: 1100
                updatedAt: '2023-11-09T13:29:01.2505088Z'
                createdAt: '2023-11-09T13:29:01.1567887Z'
                description: ''
                availableCredit: 1100
                preAuthorizedCredit: 0
                email: ricardo@teste.com.br
                tolerance: 0.2
                availableBalance: 1100
      deprecated: false
    delete:
      tags:
      - Account
      summary: VTex Close an account
      description: "Closes a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CloseanAccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                document:
                  type: string
                  description: Account owner document.
                  example: '32222222222'
                documentType:
                  type: string
                  description: Document type.
                  enum:
                  - CPF
                  - CNPJ
                  - Other
                  example: CPF
                email:
                  type: string
                  description: Account owner email.
                  example: email@domain.com
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - document
                - status
                - documentType
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  document:
                    type: string
                    description: Account owner document.
                  status:
                    type: string
                    description: Credit customer account status.
                  documentType:
                    type: string
                    description: Document type.
                    enum:
                    - CPF
                    - CNPJ
                    - Other
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                    deprecated: true
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: 32222222222_CPF
                balance: 0
                document: '32222222222'
                status: Closed
                documentType: CPF
                creditLimit: 500
                updatedAt: '2023-11-09T14:36:09.0201326Z'
                createdAt: '2023-11-09T14:31:27.0775349Z'
                description: ''
                availableCredit: 500
                preAuthorizedCredit: 0
                email: test3@teste.com
                tolerance: 1
                availableBalance: 500
      deprecated: false
    put:
      tags:
      - Account
      summary: VTex Update account information
      description: "Updates information on a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Updateemailanddescriptionofaaccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - email
              - document
              - documentType
              type: object
              properties:
                email:
                  type: string
                  description: Account owner email.
                  example: test1@test.com
                document:
                  type: string
                  description: Account owner document.
                  example: '111111111111'
                documentType:
                  type: string
                  description: Document type.
                  enum:
                  - CPF
                  - CNPJ
                  - Other
                  example: CPF
                creditLimit:
                  type: number
                  description: Maximum credit amount on the account.
                  example: 3400
                tolerance:
                  type: number
                  description: 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.
                  example: 0.25
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - status
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  document:
                    type: string
                    description: Account owner document.
                  status:
                    type: string
                    description: Credit customer account status.
                  documentType:
                    type: string
                    description: Document type.
                    enum:
                    - CPF
                    - CNPJ
                    - Other
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: 30c59e60-895f-11ee-917a-1117db360d00
                balance: 0
                document: '111111111111'
                status: Open
                documentType: CPF
                creditLimit: 3400
                updatedAt: '2023-11-22T19:06:07.4014762Z'
                createdAt: '2023-11-22T17:47:22.9450309Z'
                description: ''
                availableCredit: 3400
                preAuthorizedCredit: 0
                email: test1@test.com
                tolerance: 0.25
                availableBalance: 3400
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/statements:
    get:
      tags:
      - Account
      summary: VTex Get account statements
      description: "Retrieves the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU) statements.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Read Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Accountstatements
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - statements
                - currentBalance
                - intervalBalance
                - previousBalance
                type: object
                properties:
                  statements:
                    type: array
                    description: Statements information.
                    items:
                      required:
                      - value
                      - date
                      - origin
                      type: object
                      description: Object with information about each statement.
                      properties:
                        value:
                          type: number
                          description: Operation value.
                        date:
                          type: string
                          description: Operation date.
                        doneby:
                          type: string
                          description: Email of the person responsible for the operation.
                        origin:
                          type: string
                          description: Operation origin.
                          enum:
                          - Credit
                          - Invoice
                          - Payment
                          - Statement
                        metadata:
                          type: object
                          description: Metadata information.
                          properties:
                            transactionId:
                              type: string
                              description: Transaction identification.
                            numberOfInstallments:
                              type: number
                              description: Number of installments.
                  currentBalance:
                    type: number
                    description: Current balance value.
                  intervalBalance:
                    type: number
                    description: Interval balance. Indicates the balance between debits and credits made since the account was opened. Negative values ​​indicate that there were more debits than new credits in the account.
                  previousBalance:
                    type: number
                    description: Current balance value.
              example:
                statements:
                - value: -5.01
                  date: '2023-11-09T18:26:43.3361896Z'
                  origin: Invoice
                  metadata:
                    transactionId: A424887D0F2D45028FE5C96E9B0E1A2D
                    numberOfInstallments: 1
                - value: -15
                  date: '2023-11-09T18:48:32.1436064Z'
                  doneBy: ricardo.silva@vtex.com.br
                  origin: Statement
                - value: -500
                  date: '2023-11-09T19:38:04.3798157Z'
                  origin: Credit
                - value: -200
                  date: '2023-11-09T19:40:08.9716204Z'
                  origin: Credit
                - value: 200
                  date: '2023-11-09T19:40:14.5497445Z'
                  origin: Credit
                - value: 5.01
                  date: '2023-11-17T19:33:32.6653898Z'
                  origin: Payment
                  metadata:
                    transactionId: A424887D0F2D45028FE5C96E9B0E1A2D
                    installment: 1
                currentBalance: -15
                intervalBalance: -1110.9
                previousBalance: 0
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/creditlimit:
    put:
      tags:
      - Account
      summary: VTex Change credit limit of an account
      description: "Increases or decreases the credit limit of a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Edit credits** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: ChangecreditlimitofanAccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              type: object
              properties:
                value:
                  type: number
                  description: Credit limit value.
                  example: 5500
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - status
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  status:
                    type: string
                    description: Credit customer account status.
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: fcba59e0-7f26-11ee-ba3c-511336e1518b
                balance: -15
                status: Open
                creditLimit: 5500
                updatedAt: '2023-11-22T19:35:40.0047136Z'
                createdAt: '2023-11-09T17:39:52.151897Z'
                description: ''
                availableCredit: 5500
                preAuthorizedCredit: 0
                email: test@test.com
                tolerance: 0.3
                availableBalance: 5500
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/statements/{statementId}:
    put:
      tags:
      - Account
      summary: VTex Decrease balance of an account
      description: "Creates a debit value updating the account balance.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Edit credits** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Decreasebalanceofanaccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - name: statementId
        in: path
        description: Statement identification. This is the same `transactionId` value obtained from the [Account statements](https://developers.vtex.com/docs/api-reference/customer-credit-api#get-/api/creditcontrol/accounts/-creditAccountId-) endpoint response body.
        required: true
        style: simple
        schema:
          type: string
          example: 451924c579a6759cf6e112a
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              type: object
              properties:
                value:
                  type: string
                  description: Value to be debited from the account balance.
                  example: '-15'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - value
                type: object
                properties:
                  value:
                    type: string
                    description: Value debited from the account balance.
              example:
                value: '-15.0'
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/settlement:
    put:
      tags:
      - Account
      summary: VTex Create or update settlement
      description: "Creates an invoice or update its value for an order placed in the store that used customer credit as a payment method.\r\n\r\n>ℹ️ If payment for the order is made in installments, you can create an invoice for each installment. The first invoice will be due in 30 days, and subsequent invoices will be due 30 days after the previous invoice.\r\n\r\n.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Create Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CreateorUpdateSettlement
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - $ref: '#/components/parameters/transactionId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              type: object
              properties:
                value:
                  type: number
                  description: Value to be settled in the invoice.
                  example: 49.95
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - value
                - id
                type: object
                properties:
                  value:
                    type: number
                    description: Invoice value.
                  id:
                    type: string
                    description: Identification of the pre-authorization generated when creating the order. This number plus the information `-01` indicates the number of the invoice created.
              example:
                value: 49.95
                id: B2E754DCD7304D22866CB6F221CF0FEB
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/transactions:
    post:
      tags:
      - Account
      summary: VTex Create a pre-authorization
      description: "Creates a Pre-Authorization. Also known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold *falls off*.\r\n\r\nThis operation does not appear in statements, but the available balance will be updated.\r\n\r\nThe result of this operation is generating a `transactionId` (pre-authorization identification) to use in a settlement.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Create Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CreateaPreAuthorization
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              - settle
              - installments
              type: object
              properties:
                value:
                  type: number
                  description: Pre-Authorization value.
                  example: 49.7
                settle:
                  type: boolean
                  description: Indicates whether pre-authorization should be available to be settled. This means that the `transactionId` created in this request can be used to be associated with an order within a maximum period of 30 days.
                  example: true
                installments:
                  type: number
                  description: Number of installments.
                  example: 1
                expirationDate:
                  type: string
                  description: Pre-Authorization expiration date. This field should only be sent if the `settle` field is sent as `false`.
                  example: '2023-11-25'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - value
                - installments
                type: object
                properties:
                  id:
                    type: string
                    description: Pre-Authorization identification.
                  value:
                    type: number
                    description: Pre-Authorization value.
                  expirationDate:
                    type: string
                    description: Pre-Authorization expiration date.
                  installments:
                    type: number
                    description: Number of installments.
              example:
                id: 5d96bcdf0fbc46e1866a05f721f31623
                value: 49.7
                expirationDate: '2023-11-25T00:00:00'
                installments: 1
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}:
    put:
      tags:
      - Account
      summary: VTex Update a pre-authorization
      description: "Updates information for a specific pre-authorization request.\r\n\r\n>⚠️ This call can only be used for pre-authorizations that have not yet been captured or canceled.\r\n\r\nAlso known as authorization hold, card authorization or pre-auth, pre-authorization is the practice of holding this balance as unavailable until either the merchant clears the transaction, also called settlement, or the hold *falls off*.\r\n\r\nThis operation does not appear in statements but the available balance will be updated.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Create Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CreateaPreAuthorization(usingid)
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - $ref: '#/components/parameters/transactionId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              - settle
              - installments
              type: object
              properties:
                value:
                  type: number
                  description: Pre-Authorization value.
                  example: 55
                settle:
                  type: boolean
                  description: Indicates whether pre-authorization should be available to be settled. This means that the `transactionId` can be used to be associated with an order within a maximum period of 30 days.
                  example: true
                installments:
                  type: number
                  description: Number of installments.
                  example: 1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - value
                - installments
                type: object
                properties:
                  id:
                    type: string
                    description: Pre-Authorization identification.
                  value:
                    type: number
                    description: Pre-Authorization value.
                  installments:
                    type: number
                    description: Number of installments.
              example:
                id: d86454d23a624417b90af3876a31b981
                value: 55
                installments: 1
      deprecated: false
    delete:
      tags:
      - Account
      summary: VTex Cancel a pre-authorization
      description: "Cancels a pre-authorization created by the [Create a Pre-Authorization](https://developers.vtex.com/docs/api-reference/customer-credit-api#post-/api/creditcontrol/accounts/-creditAccountId-/transaction) endpoint. \r\n\r\n>⚠️ The pre-authorization can only be deleted by this endpoint if it was created with the `settled` field set to `false` previously.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Create Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CancelaPreAuthorization
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - $ref: '#/components/parameters/transactionId'
      responses:
        '200':
          description: OK. This endpoint does not return any data in the response body.
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/holders:
    post:
      tags:
      - Account
      summary: VTex Add an account holder
      description: "Adds a new account holder to the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU). This new user can share the account's credit limit with users already registered on the account.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: AddanaccountHolder
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - claims
              type: object
              properties:
                claims:
                  required:
                  - email
                  type: object
                  description: Holder information.
                  properties:
                    email:
                      type: string
                      description: Holder email.
                      example: email@domain.com
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - level
                - claims
                - id
                - createdAt
                type: object
                properties:
                  level:
                    type: number
                    description: Holder hierarchy. The value `2` indicates that the holder is a dependent of the account's main holder.
                  claims:
                    required:
                    - email
                    type: object
                    description: New holder information.
                    properties:
                      email:
                        type: string
                        description: Holder email.
                  id:
                    type: string
                    description: Holder identification.
                  createdAt:
                    type: string
                    description: Date of appointment of the holder.
              example:
                level: 2
                claims:
                  email: holdertest@holder.com.br
                id: 054a67b342164018a0f291636c1669f1
                createdAt: '2023-11-10T18:33:58.402627Z'
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/holders/{holderId}:
    delete:
      tags:
      - Account
      summary: VTex Delete an account holder
      description: "Deletes an account holder from the [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Deleteanaccountholder
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - name: holderId
        in: path
        description: Holder identification.
        required: true
        style: simple
        schema:
          type: string
          example: 524bc947d2b37a1a759ba3d174b58f9b
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                type: object
                properties:
                  id:
                    type: string
                    description: Identification of the holder deleted from the account.
              example:
                id: 054a67b342164018a0f291636c1669f1
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/tolerance:
    put:
      tags:
      - Account
      summary: VTex Change tolerance of an account
      description: "Modifies the credit tolerance amount to increase the credit limit on a [customer credit account](https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/7FHLd0cmxqqGeEUuc8uioU).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Checking Accounts | **Create Checking Accounts** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: Changetoleranceofanaccount
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              type: object
              properties:
                value:
                  type: number
                  description: 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.
                  example: 0.3
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - id
                - balance
                - status
                - creditLimit
                - updatedAt
                - createdAt
                - availableCredit
                - preAuthorizedCredit
                - email
                - tolerance
                - availableBalance
                type: object
                properties:
                  id:
                    type: string
                    description: Credit customer account identification.
                  balance:
                    type: number
                    description: Account balance value. If this number is negative, it means that the account has a debit instead of a credit to be used.
                  status:
                    type: string
                    description: Credit customer account status.
                  creditLimit:
                    type: number
                    description: Maximum credit amount on the account.
                  updatedAt:
                    type: string
                    description: Date of the last update made to the account.
                  createdAt:
                    type: string
                    description: Account creation date.
                  description:
                    type: string
                    description: This field is deprecated.
                    deprecated: true
                  availableCredit:
                    type: number
                    description: Credit amount available on the account.
                  preAuthorizedCredit:
                    type: number
                    description: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.
                  email:
                    type: string
                    description: Account owner email.
                  tolerance:
                    type: number
                    description: 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.
                  availableBalance:
                    type: number
                    description: Balance available for use on the account.
              example:
                id: fcba59e0-7f26-11ee-ba3c-511336e1518b
                balance: -15
                status: Open
                creditLimit: 12500
                updatedAt: '2023-11-10T18:49:50.8074778Z'
                createdAt: '2023-11-09T17:39:52.151897Z'
                description: ''
                availableCredit: 12444.99
                preAuthorizedCredit: 55.92
                email: test@test.com.br
                tolerance: 0.3
                availableBalance: 12444.99
      deprecated: false
  /api/creditcontrol/accounts/{creditAccountId}/transactions/{transactionId}/refunds:
    post:
      tags:
      - Account
      summary: VTex Partially or totally refund a settlement
      description: "Refunds a value from an already settled transaction.\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Credit Control | Main | **Main Access** |\r\n| Credit Control | Statements | **Create Statements** |\r\n\r\nThere 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).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: PartialorTotalRefundaSettlement
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/creditAccountId'
      - $ref: '#/components/parameters/transactionId'
      requestBody:
        content:
          application/json:
            schema:
              required:
              - value
              type: object
              properties:
                value:
                  type: number
                  description: Refund amount. This number must always be less than or equal to the value of the captured transaction.
                  example: 30
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                - value
                type: object
                properties:
                  value:
                    type: number
                    description: Refunded amount.
              example:
                value: 30
      deprecated: false
  /api/vlm/account:
    get:
      tags:
      - Account
      summary: VTex Get information about account
      description: "Retrieves information from an account, such as company and sponsor user details, stores, and appTokens.\n\r\n\rThis endpoint only accepts requests from the host list designated for that store. If you want to try this request from this portal, be sure to add it to the list. Learn how to add hosts to the list in [How to manage accounts](https://help.vtex.com/en/tutorial/how-to-manage-accounts--tutorials_6285#). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-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:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| License Manager | Services access control | **Save account** |\r\n\r\nYou can [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) with that resource or use one of the following [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\r\n\r\n| **Role** | **Resource** | \r\n| --------------- | ----------------- | \r\n| Finance - Full access | Save account |\r\n\r\n>❗ Assigning a [predefined role](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) to users or application keys usually grants permission to multiple [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3). If some of these permissions are not necessary, consider creating a custom role instead. For more information regarding security, see [Best practices for using application keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm).\r\n\r\n To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication)."
      operationId: GetAccount
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountResponse'
              example:
                isActive: true
                id: 71fe5fdabc4940ad81c226d43b754ba8
                name: UNISUPER, SOCIEDAD ANONIMA
                accountName: apiexamples
                lv: null
                isOperating: false
                defaultUrl: null
                district: null
                country: null
                complement: null
                companyName: UNISUPER, SOCIEDAD ANONIMA
                cnpj: null
                haveParentAccount: false
                parentAccountId: null
                parentAccountName: null
                city: null
                address: null
                logo: null
                hasLogo: false
                number: null
                postalCode: null
                state: null
                telephone: '+219999999'
                tradingName: UNISUPER, SOCIEDAD ANONIMA
                licenses:
                - expiration: null
                  id: 24
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Carrier
                - expiration: null
                  id: 10
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 30
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Key Store
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 51
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex My Account
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 68
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Zendesk
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: CRM
                - expiration: null
                  id: 8
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 4
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Request Capture
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 13
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Channels
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 27
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Portal
                  - id: 38
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CMS
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 50
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Suggestion
                  - id: 51
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex My Account
                  - id: 53
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Network
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 57
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Insights
                  - id: 58
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Credit Control
                  - id: 61
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: WebService
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 69
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conditions Evaluator
                  - id: 70
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: GiftCard
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 76
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Search
                  - id: 81
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Application Logs Stream
                  - id: 83
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Subscriptions
                  - id: 84
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CDN Service
                  - id: 85
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dandelion
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: E-Commerce Professional
                - expiration: null
                  id: 6
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 4
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Request Capture
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 7
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Buscapé Connect
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 13
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Channels
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 27
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Portal
                  - id: 38
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CMS
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 50
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Suggestion
                  - id: 51
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex My Account
                  - id: 53
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Network
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 57
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Insights
                  - id: 58
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Credit Control
                  - id: 61
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: WebService
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 68
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Zendesk
                  - id: 69
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conditions Evaluator
                  - id: 70
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: GiftCard
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 76
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Search
                  - id: 81
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Application Logs Stream
                  - id: 83
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Subscriptions
                  - id: 84
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CDN Service
                  - id: 85
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dandelion
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: E-Commerce Starter
                - expiration: null
                  id: 7
                  isPurchased: true
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 4
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Request Capture
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 7
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Buscapé Connect
                  - id: 8
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Events
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 10
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Shipping Notification
                  - id: 13
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Channels
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 15
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Fulfilment
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 22
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VtexID
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 27
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Portal
                  - id: 28
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dumbo
                  - id: 30
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Key Store
                  - id: 31
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dashboard
                  - id: 37
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex PAI
                  - id: 38
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CMS
                  - id: 39
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Availability
                  - id: 41
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Big Data
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 45
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Healthcheck
                  - id: 46
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Home
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 50
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Suggestion
                  - id: 51
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex My Account
                  - id: 53
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Network
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 57
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Insights
                  - id: 58
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Credit Control
                  - id: 60
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Extension Store
                  - id: 61
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: WebService
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 68
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Zendesk
                  - id: 69
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conditions Evaluator
                  - id: 70
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: GiftCard
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 76
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Search
                  - id: 81
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Application Logs Stream
                  - id: 83
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Subscriptions
                  - id: 84
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CDN Service
                  - id: 85
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dandelion
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: E-Commerce Unlimited
                - expiration: null
                  id: 28
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 4
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Request Capture
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 7
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Buscapé Connect
                  - id: 8
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Events
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 10
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Shipping Notification
                  - id: 13
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Channels
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 15
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Fulfilment
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 22
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VtexID
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 27
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Portal
                  - id: 28
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dumbo
                  - id: 30
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Key Store
                  - id: 31
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dashboard
                  - id: 37
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex PAI
                  - id: 38
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CMS
                  - id: 39
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Availability
                  - id: 41
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Big Data
                  - id: 45
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Healthcheck
                  - id: 46
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Home
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 50
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Suggestion
                  - id: 51
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex My Account
                  - id: 53
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Network
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 57
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Insights
                  - id: 58
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Credit Control
                  - id: 60
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Extension Store
                  - id: 61
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: WebService
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 68
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Zendesk
                  - id: 69
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conditions Evaluator
                  - id: 70
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: GiftCard
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 76
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Search
                  - id: 81
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Application Logs Stream
                  - id: 83
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Subscriptions
                  - id: 84
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CDN Service
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: E-Commerce Unlimited No Billing
                - expiration: null
                  id: 11
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 8
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Events
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 22
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VtexID
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Gateway
                - expiration: null
                  id: 15
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 8
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Events
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 17
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX DWT
                  - id: 18
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Unikey
                  - id: 22
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VtexID
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 48
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Bridge
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Gateway Seller Nao VTEX
                - expiration: null
                  id: 29
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Indeva
                - expiration: null
                  id: 30
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 13
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Channels
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 46
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Home
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 86
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CatalogV2
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Marketplace Seller
                - expiration: null
                  id: 23
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 84
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CDN Service
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  - id: 90
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Payments' Provider Manager
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: VTEX Backoffice
                - expiration: null
                  id: 26
                  isPurchased: false
                  products:
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 82
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Banking Service
                  name: VTEX Bank
                - expiration: null
                  id: 22
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  name: VTEX Billing
                - expiration: null
                  id: 27
                  isPurchased: false
                  products:
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 88
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Tenant Switcher
                  name: VTEX Partner
                - expiration: null
                  id: 25
                  isPurchased: false
                  products:
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 72
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Payment
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  name: VTEX Payment
                - expiration: null
                  id: 19
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 3
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Master Data
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 25
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Dynamic Storage
                  - id: 27
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Portal
                  - id: 39
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Availability
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 57
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Insights
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 67
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTable
                  - id: 68
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Zendesk
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  - id: 76
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Search
                  - id: 81
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Application Logs Stream
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: WhiteLabel
                - expiration: null
                  id: 21
                  isPurchased: false
                  products:
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 14
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Log
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 73
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Seller Register
                  - id: 75
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Time Series
                  name: Whitelabel Instore
                - expiration: null
                  id: 31
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 2
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Catalog
                  - id: 5
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Checkout
                  - id: 6
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: PCI Gateway
                  - id: 9
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Logistics
                  - id: 16
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Rates and Benefits
                  - id: 19
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: OMS
                  - id: 20
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Conversation Tracker
                  - id: 23
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Message Center
                  - id: 43
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Billing
                  - id: 46
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX Home
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 65
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Pricing
                  - id: 66
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: VTEX IO
                  - id: 74
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Order Authorization
                  - id: 86
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: CatalogV2
                  - id: 89
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Promotions Policy Engine
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Marketplace Seller Whitelabel
                - expiration: null
                  id: 33
                  isPurchased: false
                  products:
                  - id: 1
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: License Manager
                  - id: 55
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Audit
                  - id: 64
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Vtex ID
                  - id: 91
                    domains: []
                    endpoints:
                      webApiUrl: null
                      consoleUrl: null
                    name: Releases
                  name: Buyer Organization
                sponsor:
                  name: John Doe
                  email: john.doe@vtex.com.br
                  phone: '+219999999'
                contact:
                  name: John Doe
                  email: john.doe@vtex.com.br
                  phone: '+219999999'
                operationDate: null
                inactivationDate: null
                creationDate: '2019-12-11T17:02:34'
                hosts: []
                sites:
                - id: 23117
                  name: apiexamples
                  tradingName: UNISUPER, SOCIEDAD ANONIMA
                  LV: null
                  logo: null
                  monetaryUnitId: 1
                  domains: null
                  hosts: []
                  aliases: []
                appKey:
                  token: null
                  name: null
                appKeys:
                - id: 03ccde55547d43b09bbb2e1e6f7d455e
                  appKey: vtexappkey-apiexamples-YSTRGZ
                  appToken: null
                  label: apiexamples
                  createdIn: '2019-12-11T21:06:33'
                  isActive: true
                  isBlocked: false
                - id: d585d6d94fd5415fb36c574a4c22986f
                  appKey: vtexappkey-apiexamples-LVQVVA
                  appToken: null
                  label: tadashi-test
                  createdIn: '2021-10-21T20:00:21.308679'
                  isActive: true
                  isBlocked: false
      deprecated: false
components:
  schemas:
    AppKeyItems:
      description: Object representing application keys.
      type: object
      properties:
        id:
          description: ID of the application key.
          type: string
        appKey:
          description: AppKey.
          type: string
        appToken:
          description: AppToken. For security reasons, it should always be null.
          type: string
          nullable: true
        label:
          description: Label of the application key.
          type: string
        createdIn:
          description: Creation date of the application key.
          type: string
          format: date-time
        isActive:
          description: Defines if the application key is active (`true`) or not (`false`).
          type: boolean
        isBlocked:
          description: Defines if the application key is blocked (`true`) or not (`false`).
          type: boolean
    AccountResponse:
      description: Successful response for `/api/vlm/account`.
      type: object
      properties:
        isActive:
          description: Defines if the account is active (`true`) or not (`false`).
          type: boolean
        id:
          description: ID of the account.
          type: string
        name:
          description: Trading name.
          type: string
        accountName:
          description: Account name.
          type: string
        lv:
          type: string
          description: Level.
          nullable: true
          deprecated: true
        isOperating:
          description: Defines if the account is in production (`true`) or not (`false`).
          type: boolean
        defaultUrl:
          deprecated: true
          description: Default URL.
          type: string
          nullable: true
        district:
          description: Neighborhood of the person assigned as main contact of the store.
          type: string
          nullable: true
        country:
          description: Country of the person assigned as main contact of the store.
          type: string
          nullable: true
        complement:
          description: Additional address of the person assigned as main contact of the store.
          type: string
          nullable: true
        companyName:
          description: Company name.
          type: string
        cnpj:
          description: CNPJ (Corporate Tax ID) of account.
          type: string
          nullable: true
        haveParentAccount:
          description: Defines if the account has a parent account (`true`) or not (`false`).
          type: boolean
        parentAccountId:
          description: ID of the parent account.
          type: string
          nullable: true
        parentAccountName:
          description: Name of the parent account.
          type: string
          nullable: true
        city:
          description: City of the person assigned as main contact of the store.
          type: string
          nullable: true
        address:
          description: Address of the person assigned as main contact of the store.
          type: string
          nullable: true
        logo:
          description: Filename of the account's logotype.
          type: string
          nullable: true
        hasLogo:
          description: Defines if the store's logotype has been uploaded (`true`) or not (`false`).
          type: boolean
        number:
          description: Number of the address of the person assigned as main contact of the store.
          type: string
          nullable: true
        postalCode:
          description: Zip code of the person assigned as main contact of the store.
          type: string
          nullable: true
        state:
          description: State or province of the person assigned as main contact of the store.
          type: string
          nullable: true
        telephone:
          description: Telephone number of the person assigned as main contact of the store.
          type: string
        tradingName:
          description: Trading name.
          type: string
        licenses:
          description: Licenses of the account.
          type: array
          items:
            $ref: '#/components/schemas/LicenseItems'
        sponsor:
          description: Object with information about the sponsor user.
          type: object
          properties:
            name:
              description: Name of the sponsor user.
              type: string
            email:
              description: Email of the sponsor user.
              type: string
            phone:
              description: Phone of the sponsor user.
              type: string
        contact:
          type: object
          description: Information about the person assigned as main contact of the store.
          properties:
            name:
              description: Name of the person assigned as main contact of the store.
              type: string
            email:
              description: Email of the person assigned as main contact of the store.
              type: string
            phone:
              description: Telephone number of the person assigned as main contact of the store.
              type: string
        operationDate:
          description: Date when the account went into production.
          type: string
          nullable: true
          format: date-time
        inactivationDate:
          description: Date when the account was deactivated.
          type: string
          nullable: true
          format: date-time
        creationDate:
          description: Date when the account was created.
          type: string
          format: date-time
        hosts:
          description: Hosts of all stores.
          type: array
          items:
            type: string
            description: Host address.
        sites:
          description: Array of objects representing each store.
          type: array
          items:
            $ref: '#/components/schemas/SiteItems'
        appKey:
          description: Deprecated. Check the `appKeys` object for all appKeys.
          type: object
          properties:
            token:
              type: string
              description: Token.
              nullable: true
              deprecated: true
            name:
              type: string
              description: Token name.
              nullable: true
              deprecated: true
          deprecated: true
        appKeys:
          description: Array of application keys.
          type: array
          items:
            $ref: '#/components/schemas/AppKeyItems'
    LicenseItems:
      description: Object representing licenses.
      type: object
      properties:
        expiration:
          type: string
          format: date-time
          nullable: true
          deprecated: true
          description: Expiration date.
        id:
          description: ID of the category of the license.
          type: number
        isPurchased:
          description: Defines if the license is purchased (`true`) or not (`false`).
          type: boolean
        products:
          description: Array of products.
          type: array
          items:
            description: Object representing products of licenses.
            type: object
            properties:
              id:
                description: ID of the product.
                type: number
              name:
                description: Name of the product.
                type: string
              domains:
                description: List of domains of the product.
                type: array
                items:
                  type: string
                  description: Domain of the product.
                deprecated: true
              endpoints:
                type: object
                description: Endpoints.
                properties:
                  webApiUrl:
                    type: string
                    description: Web API URL.
                    nullable: true
                    deprecated: true
                  consoleUrl:
                    type: string
                    description: Console URL.
                    nullable: true
                    deprecated: true
                deprecated: true
        name:
          description: Name of the category of the license.
          type: string
    SiteItems:
      description: Object containing complete information from a store.
      type: object
      properties:
        id:
          description: ID of the store.
          type: number
        name:
          description: Store name.
          type: string
        tradingName:
          description: Trading name of the store.
          type: string
        LV:
          type: string
          description: Level.
          nullable: true
          deprecated: true
        logo:
          type: string
          description: Logo.
          nullable: true
          deprecated: true
        monetaryUnitId:
          type: number
          description: Monetary unit ID.
          deprecated: true
        domains:
          type: array
          description: List of domains.
          items:
            type: string
            description: Domain.
            deprecated: true
          nullable: true
          deprecated: true
        hosts:
          description: Hosts associated to the store.
          type: array
          items:
            type: string
            description: Host address.
        aliases:
          type: array
          description: Aliases.
          items:
            type: string
            description: Alias.
            deprecated: true
          deprecated: true
  parameters:
    creditAccountId:
      name: creditAccountId
      in: path
      description: Credit account identification.
      required: true
      style: simple
      schema:
        type: string
        example: 01bce461-9g03-12ds-8217-b3d39271e15b
    Accept:
      name: Accept
      in: header
      description: HTTP Client Negotiation _Accept_ Header. Indicates the types of responses the client can understand.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    Content-Type:
      name: Content-Type
      in: header
      description: Type of the content being sent.
      required: true
      style: simple
      schema:
        type: string
        example: application/json
    transactionId:
      name: transactionId
      in: path
      description: Pre-authorization identification.
      required: true
      style: simple
      schema:
        type: string
        example: B2E754DCD7304D22866CB6F221CF0FEB
  securitySchemes:
    VtexIdclientAutCookie:
      type: apiKey
      in: header
      name: VtexIdclientAutCookie
      description: '[User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.'