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

# Leia o perfil de faturamento da organização

<Info>
  Requer a ação do IAM **`billing:GetBillingProfile`**. Consulte [permissões de faturamento](/billing/permissions) para obter a lista completa, o que cada uma cobre e um exemplo de política.
</Info>


## OpenAPI

````yaml /pt/api-reference/specs/billing.yaml get /v1/profile
openapi: 3.0.3
info:
  title: Basaltic Billing API
  version: 1.0.0
  description: >
    Preços, uso medido, faturas, pagamentos e créditos para a organização. O
    catálogo de preços (`/v1/prices`) é público; outras operações exigem
    concessão de políticas da organização para ações de faturamento.


    Inclui perfis de faturamento editáveis e status de fatura fiscal /
    downloads. A liquidação de uma fatura e a gestão dos métodos de pagamento
    ocorrem no console.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://billing.basaltic.sh
    description: Endpoint global da API
security:
  - BearerAuth: []
paths:
  /v1/profile:
    get:
      tags:
        - Billing
      summary: Leia o perfil de faturamento da organização
      operationId: getBillingProfile
      responses:
        '200':
          description: >-
            Detalhes de faturamento salvos ou um rascunho incompleto. O cliente
            pré-preenche o e-mail de faturamento do usuário conectado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingProfile'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    BillingProfile:
      type: object
      description: >-
        Destinatário de faturamento da organização. Os rascunhos incompletos são
        salvos; pronto se torna verdadeiro somente depois que todos os campos
        específicos do país são válidos. A nova integração é concluída após essa
        etapa.
      properties:
        customer_type:
          type: string
          enum:
            - ''
            - individual
            - company
        company_name:
          type: string
          maxLength: 75
          description: Nome legal completo do indivíduo ou empresa.
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: Códigos de país ISO 3166-1 alpha-2.
          example: BR
        tax_id:
          type: string
          description: >-
            CPF para um indivíduo brasileiro ou CNPJ para uma empresa
            brasileira. Os dígitos de verificação são validados.
        foreign_tax_id:
          type: string
          maxLength: 50
          description: Identificador estrangeiro; não validado como documento brasileiro.
        no_tax_id_reason:
          type: string
          maxLength: 100
          description: >-
            Necessário para um destinatário estrangeiro sem identificação
            fiscal.
        email:
          type: string
          format: email
          maxLength: 75
          description: >-
            E-mail de cobrança para entrega de fatura fiscal. O formulário de
            integração pré-preenche isso a partir do e-mail do usuário
            conectado.
        phone:
          type: string
          maxLength: 50
        street_name:
          type: string
          maxLength: 50
        street_number:
          type: string
          maxLength: 10
        complement:
          type: string
          maxLength: 30
        neighborhood:
          type: string
          maxLength: 30
        city:
          type: string
          maxLength: 100
        municipality_code:
          type: string
          description: >-
            Código de município de sete dígitos do IBGE, necessário para um
            beneficiário brasileiro.
          example: '3550308'
        state:
          type: string
          maxLength: 100
          description: >-
            UF de duas letras para o Brasil; estado/província de forma livre no
            exterior.
        postal_code:
          type: string
          maxLength: 20
          description: >-
            CEP de oito dígitos para o Brasil; código postal internacional
            opcional no exterior.
        ready:
          type: boolean
          readOnly: true
        missing_fields:
          type: array
          readOnly: true
          items:
            type: string
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Código de erro identificando o tipo de erro
              example: INVALID_INPUT
            message:
              type: string
              description: Mensagem de erro legível pelo ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores não sensíveis opcionais para interpolação de erros
                localizados, codificados por código de erro. Nunca presente para
                erros de servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuração
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Autenticação necessária ou token inválido
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: UNAUTHORIZED
              message: Authentication required
              request_id: 550e8400-e29b-41d4-a716-446655440000
    Forbidden:
      description: Permissões insuficientes
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: ACCESS_DENIED
              message: You don't have permission to perform this action
              request_id: 550e8400-e29b-41d4-a716-446655440000
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >+
        Um token bearer OAuth 2.0, enviado como `Authorization: Bearer <token>`.
        Esta é a forma recomendada de autenticação.


        Obtenha o token trocando o par de chaves de acesso de uma conta de
        serviço em `POST /v1/oauth/token` com `grant_type=client_credentials`.
        Esse é o fluxo padrão de credenciais de cliente; bibliotecas compatíveis
        com OAuth podem obter e renovar o token para você.


        ```

        curl -s -u "$KEY_ID:$SECRET" -d grant_type=client_credentials \
          https://iam.basaltic.sh/v1/oauth/token
        ```


        Os tokens duram uma hora por padrão. O mesmo par de chaves de acesso
        também serve como credencial AWS SigV4 para o endpoint de objetos
        compatível com S3, que aceita somente esse método de autenticação.


````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.