> ## Documentation Index > Fetch the complete documentation index at: https://docs.besimplo.com/llms.txt > Use this file to discover all available pages before exploring further. # Listar preços > Retorna uma lista paginada de preços da conta. ## OpenAPI ````yaml /api-reference/openapi.yml get /api/v1/prices openapi: 3.1.0 info: title: API - Simplo version: 1.0.0 description: API para cobrança e assinaturas para contas Simplo contact: name: Simplo url: https://besimplo.com email: team@besimplo.com servers: - url: https://besimplo.com description: Produção security: - apiKeyAuth: [] tags: - name: Clientes description: Clientes são as pessoas que pagarão pelos produtos da sua conta - name: Produtos description: Produtos representam os bens ou serviços que você vende - name: Preços description: Preços definem quanto cobrar e a frequência de cobrança de um Produto - name: Assinaturas description: Assinaturas conectam clientes aos seus planos para cobrança recorrente - name: Checkout description: >- Sessões de checkout permitem que clientes completem pagamentos e assinaturas através de uma interface web - name: Faturas description: Faturas representam cobranças geradas para clientes - name: Reembolsos description: Reembolsos permitem devolver pagamentos já realizados aos clientes - name: Webhooks description: > Eventos enviados via HTTP POST para a URL configurada na sua conta. Responda com status 2xx rapidamente. Processe o evento de forma assincrona. Use o campo `event.id` para garantir idempotencia. paths: /api/v1/prices: get: tags: - Preços summary: Listar preços description: Retorna uma lista paginada de preços da conta. operationId: listPrices parameters: - name: active in: query description: Filtrar por status ativo/inativo schema: type: boolean - name: product_id in: query description: Filtrar pelo ID do produto, no formato TypeID com prefixo `prod_`. schema: type: string pattern: ^prod_[0-9a-z]{26}$ example: prod_01h455vb4pex5vsknk084sn02q - name: type in: query description: Filtrar por tipo de cobrança schema: type: string enum: - one_time - recurring - name: limit in: query schema: type: integer minimum: 1 maximum: 100 default: 20 description: Resultados por página - name: page in: query schema: type: string description: Cursor para próxima página responses: '200': description: Lista de preços content: application/json: schema: type: object unevaluatedProperties: false required: - object - url - has_more - data properties: object: type: string description: Tipo do objeto. Sempre "list" para listas. enum: - list example: list url: type: string format: uri-reference description: URL do recurso solicitado. example: /api/v1/prices has_more: type: boolean description: Indica se há mais resultados disponíveis para paginação. example: false data: type: array description: Array de objetos Price. items: type: object unevaluatedProperties: false required: - id - object - active - live_mode - created - currency - product - type - unit_amount - card_installments_enabled - max_card_installments properties: id: type: string pattern: ^price_[0-9a-z]{26}$ readOnly: true description: >- ID único do preço, no formato TypeID com prefixo `price_`. example: price_01h455vb4pex5vsknk084sn02q object: type: string description: Tipo do objeto. Sempre 'price'. enum: - price example: price active: type: boolean description: Se o preço está ativo para novas compras. example: true live_mode: type: boolean description: >- Indica ambiente de produção (true) ou sandbox (false). Dados de sandbox são limpos periodicamente. example: true created: type: integer format: int64 readOnly: true description: Timestamp Unix de quando o preço foi criado. example: 1704672000 currency: type: string description: Moeda do valor. Sempre 'brl' (Real brasileiro). enum: - brl example: brl description: type: - string - 'null' nullable: true description: Nome amigável do preço. example: Plano Mensal Premium product: type: string pattern: ^prod_[0-9a-z]{26}$ description: >- ID do produto associado, no formato TypeID com prefixo `prod_`. example: prod_01h455vb4pex5vsknk084sn02q type: type: string description: | Tipo de cobrança: - one_time: Cobrança única. - recurring: Cobrança recorrente. enum: - one_time - recurring example: recurring unit_amount: type: integer minimum: 0 maximum: 999999 description: >- Valor em centavos. R$ 29,90 = 2990. Máximo R$ 9.999,99. example: 2990 unit_amount_decimal: type: string description: Valor em centavos como string. example: '2990' recurring: oneOf: - type: object unevaluatedProperties: false required: - interval - interval_count properties: interval: type: string description: | Intervalo de cobrança: - day: Diário. - week: Semanal. - month: Mensal. - year: Anual. enum: - day - week - month - year example: month interval_count: type: integer minimum: 1 description: | Número de intervalos entre cobranças. Máximo de 3 anos: - day: máximo 1095 - week: máximo 156 - month: máximo 36 - year: máximo 3 example: 1 - type: 'null' nullable: true description: >- Configuração de recorrência (apenas para type=recurring). external_code: type: - string - 'null' nullable: true description: Código externo para idempotência. maxLength: 250 example: price_premium_monthly card_installments_enabled: type: boolean description: > Indica se este preço permite parcelamento no cartão de crédito. Regras: - preços avulsos podem permitir parcelamento - recorrências diárias e semanais não podem permitir parcelamento - recorrências mensais exigem pelo menos 2 meses para permitir parcelamento example: false max_card_installments: type: integer minimum: 1 maximum: 12 description: > Máximo de parcelas aceitas no cartão. Regras: - quando `card_installments_enabled=false`, o valor efetivo é `1` - preços recorrentes não podem exceder a recorrência em meses, com limite global de `12` - o valor mínimo por parcela é `R$ 5,00` example: 1 effective_max_card_installments: type: integer minimum: 1 maximum: 12 readOnly: true description: > Máximo efetivo de parcelas aceitas no cartão após aplicar as regras de recorrência e valor mínimo. example: 1 installment_selection_available: type: boolean readOnly: true description: >- Indica se a seleção de parcelas está disponível para o preço. example: false '404': description: Não encontrado content: application/problem+json: schema: type: object required: - type - status - title - detail - code properties: type: type: string description: URI que identifica o tipo de problema format: uri enum: - https://problems-registry.smartbear.com/not-found status: type: integer description: O código de status HTTP format: int32 enum: - 404 title: type: string description: O nome do status HTTP enum: - Not Found detail: type: string description: Mensagem descritiva do erro code: type: string description: Código de erro interno da API enum: - NOT_FOUND - RESOURCE_MISSING examples: not_found: summary: Recurso não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: The requested resource was not found code: NOT_FOUND customer_not_found: summary: Cliente não encontrado value: type: https://problems-registry.smartbear.com/not-found status: 404 title: Not Found detail: 'No such customer: ''019abc12-3456-7890-abcd-ef1234567890''' code: RESOURCE_MISSING components: securitySchemes: apiKeyAuth: type: apiKey in: header name: Authorization description: > A chave de API usada para autenticar a requisição e identificar a sua conta. **Exemplo:** `Authorization: ApiKey my-secure-key` ````