> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lerian.studio/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter pacote de cobrança



## OpenAPI

````yaml pt/openapi/v3-current/ledger.yaml get /v1/organizations/{organization_id}/billing-packages/{billing_package_id}
openapi: 3.1.0
info:
  title: API Midaz Ledger
  description: >-
    Referência completa da API para serviços do Midaz Ledger incluindo
    gerenciamento de organizações, operações de ledger, ativos, segmentos,
    portfolios, contas, tipos de conta, transações, operações, saldos, rotas de
    operação, rotas de transação e índices de metadata.
  version: 3.7.8
servers:
  - url: https://ledger.sandbox.lerian.net
security: []
tags:
  - name: API de Organizações
  - name: API de Ledgers
  - name: API de Ativos
  - name: API de Segmentos
  - name: API de Portfolios
  - name: API de Tipos de Conta
  - name: API de Contas
  - name: API de Saldos
  - name: API de Transações
  - name: API de Operações
  - name: API de Rotas de Operação
  - name: API de Rotas de Transação
  - name: API de Índices de Metadata
  - name: API de Titulares
  - name: API de Instrumentos
  - name: API de Pacotes de Cobrança
  - name: API de Pacotes
  - name: API de Cálculo de Cobrança
  - name: API de Estimativa
  - name: API de Criptografia
  - name: API de Proteção
  - name: API de Taxas de Ativos
paths:
  /v1/organizations/{organization_id}/billing-packages/{billing_package_id}:
    get:
      tags:
        - API de Pacotes de Cobrança
      summary: Obter pacote de cobrança
      parameters:
        - $ref: '#/components/parameters/OrganizationId'
        - name: billing_package_id
          in: path
          required: true
          description: ID do pacote de cobrança (UUID)
          schema:
            type: string
        - $ref: '#/components/parameters/XRequestId'
        - $ref: '#/components/parameters/Authorization'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FeeBillingPackage'
        default:
          description: Erro
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    OrganizationId:
      name: organization_id
      in: path
      description: O identificador único da Organização associada ao Ledger.
      required: true
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
        format: uuid
    XRequestId:
      name: X-Request-Id
      in: header
      description: >-
        Um identificador único utilizado para rastrear e acompanhar cada
        requisição.
      required: false
      example: 019c96a0-0a98-7287-9a31-786e0809c769
      schema:
        type: string
        format: uuid
    Authorization:
      name: Authorization
      in: header
      required: false
      schema:
        type: string
      description: >
        Token JWT bearer para autenticação.

        Obrigatório quando `PLUGIN_AUTH_ENABLED=true` (exigido em implantações
        multi-tenant).

        Opcional no modo OSS single-tenant padrão.

        Formato: `Bearer <token>`
  schemas:
    FeeBillingPackage:
      additionalProperties: false
      properties:
        accountTarget:
          $ref: '#/components/schemas/FeeAccountTarget'
        assetCode:
          examples:
            - BRL
          type: string
        countMode:
          examples:
            - perRoute
          type: string
        createdAt:
          examples:
            - '2026-01-01T00:00:00Z'
          type: string
        creditAccountAlias:
          examples:
            - account_fees_credit
          type: string
        debitAccountAlias:
          examples:
            - account_fees_debit
          type: string
        deletedAt:
          examples:
            - '2026-06-01T00:00:00Z'
          type: string
        description:
          examples:
            - Charges per completed transaction route
          type: string
        discountTiers:
          items:
            $ref: '#/components/schemas/FeeDiscountTier'
          type:
            - array
            - 'null'
        enable:
          examples:
            - true
          type:
            - boolean
            - 'null'
        eventFilter:
          $ref: '#/components/schemas/FeeEventFilter'
        feeAmount:
          examples:
            - '50.00'
          type: string
        freeQuota:
          examples:
            - 100
          format: int64
          type: integer
        id:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        label:
          examples:
            - Monthly Volume Billing
          type: string
        ledgerId:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        maintenanceCreditAccount:
          examples:
            - account_maintenance_credit
          type: string
        organizationId:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        pricingModel:
          examples:
            - tiered
          type: string
        tiers:
          items:
            $ref: '#/components/schemas/FeePricingTier'
          type:
            - array
            - 'null'
        type:
          examples:
            - volume
          type: string
        updatedAt:
          examples:
            - '2026-01-01T00:00:00Z'
          type: string
      required:
        - id
        - organizationId
        - ledgerId
        - label
        - type
        - enable
        - createdAt
        - updatedAt
      type: object
    Error:
      additionalProperties: false
      properties:
        code:
          description: >-
            Código de erro de domínio estável e legível por máquina, com escopo
            no serviço emissor (formato: <SERVICE>-NNNN).
          examples:
            - ERR-0001
          type: string
        detail:
          description: >-
            Uma explicação legível por humanos específica para esta ocorrência
            do problema.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Lista opcional de detalhes de erro individuais
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            Uma referência de URI que identifica a ocorrência específica do
            problema.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: Código de status HTTP
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            Um resumo curto e legível por humanos do tipo de problema. Este
            valor não deve mudar entre ocorrências do erro.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: >-
            Uma referência de URI para a documentação legível por humanos do
            erro.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    FeeAccountTarget:
      additionalProperties: false
      properties:
        aliases:
          examples:
            - - account_alpha
              - account_beta
          items:
            type: string
          type:
            - array
            - 'null'
        portfolioId:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
        segmentId:
          examples:
            - 00000000-0000-0000-0000-000000000000
          type: string
      type: object
    FeeDiscountTier:
      additionalProperties: false
      properties:
        discountPercentage:
          examples:
            - '10.00'
          type: string
        minQuantity:
          examples:
            - 1000
          format: int64
          type: integer
      required:
        - minQuantity
        - discountPercentage
      type: object
    FeeEventFilter:
      additionalProperties: false
      properties:
        status:
          examples:
            - APPROVED
          type: string
        transactionRoute:
          examples:
            - payment_route
          type: string
      required:
        - transactionRoute
        - status
      type: object
    FeePricingTier:
      additionalProperties: false
      properties:
        maxQuantity:
          examples:
            - 999
          format: int64
          type: integer
        minQuantity:
          examples:
            - 0
          format: int64
          type: integer
        unitPrice:
          examples:
            - '1.50'
          type: string
      required:
        - minQuantity
        - unitPrice
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Onde o erro ocorreu, por exemplo 'body.items[3].tags' ou
            'path.thing-id'
          type: string
        message:
          description: Texto da mensagem de erro
          type: string
        value:
          description: O valor na localização informada
      type: object

````