> ## 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.

# Leer el perfil de facturación de la organización

<Info>
  Requiere la acción de IAM **`billing:GetBillingProfile`**. Consulta [permisos de facturación](/billing/permissions) para obtener la lista completa, lo que cubre cada una y un ejemplo de política.
</Info>


## OpenAPI

````yaml /es/api-reference/specs/billing.yaml get /v1/profile
openapi: 3.0.3
info:
  title: Basaltic Billing API
  version: 1.0.0
  description: >
    Precios, uso medido, facturas, pagos y créditos para la organización. El
    catálogo de precios (`/v1/prices`) es público; otras operaciones requieren
    concesiones de políticas de organización para acciones de facturación.


    Incluye perfiles de facturación editables y estado de factura fiscal /
    descargas. La liquidación de una factura y la gestión de los métodos de pago
    se realizan en la consola.
  contact:
    name: Basaltic Support
    email: ping@basaltic.sh
  license:
    name: Proprietary
    url: https://basaltic.sh/terms
servers:
  - url: https://billing.basaltic.sh
    description: Endpoint de API global
security:
  - BearerAuth: []
paths:
  /v1/profile:
    get:
      tags:
        - Billing
      summary: Leer el perfil de facturación de la organización
      operationId: getBillingProfile
      responses:
        '200':
          description: >-
            Detalles de facturación guardados o un borrador incompleto. El
            cliente rellena previamente el correo electrónico de facturación del
            usuario que ha iniciado sesión.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BillingProfile'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
components:
  schemas:
    BillingProfile:
      type: object
      description: >-
        Destinatario de facturación de la organización. Los borradores
        incompletos se guardan; listo se convierte en verdadero solo después de
        que todos los campos específicos del país sean válidos. La incorporación
        de nuevos usuarios se completa después de este paso.
      properties:
        customer_type:
          type: string
          enum:
            - ''
            - individual
            - company
        company_name:
          type: string
          maxLength: 75
          description: Nombre legal completo de la persona o empresa.
        country:
          type: string
          minLength: 2
          maxLength: 2
          description: ISO 3166-1 alpha-2 código de país.
          example: BR
        tax_id:
          type: string
          description: >-
            CPF para una persona física brasileña o CNPJ para una empresa
            brasileña. Los dígitos de verificación son validados.
        foreign_tax_id:
          type: string
          maxLength: 50
          description: Identificador extranjero; no validado como documento brasileño.
        no_tax_id_reason:
          type: string
          maxLength: 100
          description: Requerido para un destinatario extranjero sin identificación fiscal.
        email:
          type: string
          format: email
          maxLength: 75
          description: >-
            Correo electrónico de facturación para la entrega de facturas
            fiscales. El formulario de incorporación lo rellena previamente
            desde el correo electrónico del usuario que ha iniciado sesión.
        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 municipio de siete dígitos del IBGE, requerido para un
            beneficiario brasileño.
          example: '3550308'
        state:
          type: string
          maxLength: 100
          description: >-
            UF de dos letras para Brasil; estado/provincia de forma libre en el
            extranjero.
        postal_code:
          type: string
          maxLength: 20
          description: >-
            CEP de ocho dígitos para Brasil; código postal internacional
            opcional en el extranjero.
        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 error que identifica el tipo de error
              example: INVALID_INPUT
            message:
              type: string
              description: Mensaje de error legible por el ser humano
              example: Invalid request parameters
            params:
              type: object
              additionalProperties: true
              description: >-
                Valores no sensibles opcionales para la interpolación de errores
                localizados, codificados por código de error. Nunca presente por
                errores del servidor.
              example:
                instances: 2
                pools: 0
            request_id:
              type: string
              format: uuid
              description: Solicitar ID para depuración
              example: 550e8400-e29b-41d4-a716-446655440000
  responses:
    Unauthorized:
      description: Se requiere autenticación o el token no es vá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: Permisos 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: >+
        Un token bearer de OAuth 2.0, enviado como `Authorization: Bearer
        <token>`. Esta es la forma recomendada de autenticación.


        Obtén el token intercambiando el par de claves de acceso de una cuenta
        de servicio en `POST /v1/oauth/token` con
        `grant_type=client_credentials`. Es el flujo estándar de credenciales de
        cliente; las bibliotecas compatibles con OAuth pueden obtener y renovar
        el token por ti.


        ```

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


        Los tokens duran una hora por defecto. El mismo par de claves de acceso
        también sirve como credencial AWS SigV4 para el endpoint de objetos
        compatible con S3, que solo acepta ese método de autenticación.


````

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