> ## Documentation Index
> Fetch the complete documentation index at: https://abacatepay-feat-lojista.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar cobranças

> Permite que você recupere uma lista de todas as cobranças criadas.



## OpenAPI

````yaml /openapi-v1.yaml get /billing/list
openapi: 3.1.0
info:
  title: API AbacatePay
  description: API para gerenciamento de cobranças e pagamentos usando o AbacatePay.
  version: 1.0.0
servers:
  - url: https://api.abacatepay.com/v1
    description: Único servidor para os ambientes de produção e sandbox.
security: []
paths:
  /billing/list:
    get:
      summary: Listar cobranças
      description: Permite que você recupere uma lista de todas as cobranças criadas.
      responses:
        '200':
          description: Lista de cobranças retornada com sucesso.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    description: Lista de cobranças criadas.
                    items:
                      $ref: '#/components/schemas/Billing'
                  error:
                    type: 'null'
                    example: null
        '401':
          description: Não autorizado. Falha na autenticação.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: >-
                      Mensagem de erro descrevendo o motivo da falha na
                      autenticação.
                    example: Token de autenticação inválido ou ausente.
      security:
        - bearerAuth: []
components:
  schemas:
    Billing:
      type: object
      properties:
        id:
          type: string
          description: Identificador único da cobrança.
          example: bill_123456
        url:
          type: string
          format: uri
          description: URL onde o usuário pode concluir o pagamento.
          example: https://pay.abacatepay.com/bill-5678
        amount:
          type: number
          description: Valor total a ser pago em centavos. (Deprecated)
          deprecated: true
          example: 4000
        status:
          type: string
          description: Status atual da cobrança.
          enum:
            - PENDING
            - EXPIRED
            - CANCELLED
            - PAID
            - REFUNDED
          example: PENDING
        devMode:
          type: boolean
          description: Indica se a cobrança foi criada em ambiente de testes.
          example: true
        methods:
          type: array
          description: Métodos de pagamento suportados para esta cobrança.
          items:
            type: string
            enum:
              - PIX
              - CARD
          example:
            - PIX
            - CARD
        products:
          type: array
          description: Lista de produtos na cobrança.
          items:
            type: object
            properties:
              id:
                type: string
                description: Identificador único do produto.
                example: prod_123456
              externalId:
                type: string
                description: O id do produto em seu sistema.
                example: prod-1234
              quantity:
                type: integer
                description: Quantidade do produto sendo adquirida.
                example: 2
        frequency:
          type: string
          description: Frequência da cobrança.
          enum:
            - ONE_TIME
            - MULTIPLE_PAYMENTS
          example: ONE_TIME
        nextBilling:
          type: string
          format: date-time
          nullable: true
          description: Data e hora da próxima cobrança, ou null para cobranças únicas.
          example: 'null'
        customer:
          $ref: '#/components/schemas/Customer'
          type: object
          nullable: true
        allowCoupons:
          type: boolean
          nullable: true
          default: false
          description: Se verdadeiro cupons podem ser usados na billing
        coupons:
          type: array
          description: Lista de cupons disponíveis para resem usados com a billing
          nullable: true
          default: []
          items:
            type: string
      required:
        - id
        - url
        - status
        - devMode
        - methods
        - products
        - frequency
        - createdAt
        - updatedAt
    Customer:
      type: object
      description: Os dados do seu cliente.
      required:
        - name
        - cellphone
        - email
        - taxId
      additionalProperties: false
      properties:
        id:
          type: string
          description: Identificador único do cliente
          example: bill_123456
        metadata:
          type: object
          description: Dados do cliente
          properties:
            name:
              type: string
              description: Nome completo do seu cliente
              example: Daniel Lima
            cellphone:
              type: string
              description: Celular do cliente
              example: (11) 4002-8922
            email:
              type: string
              description: E-mail do cliente
              example: daniel_lima@abacatepay.com
            taxId:
              type: string
              description: CPF ou CNPJ do cliente.
              example: 123.456.789-01
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Cabeçalho de autenticação Bearer no formato `Bearer
        <abacatepay-api-key>` onde `<abacatepay-api-key>` é a sua chave de API.

````