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

# Obtener suscripción del sitio web

> Devuelve los productos de suscripción de un sitio web concreto, con su estado y fechas de facturación.



## OpenAPI

````yaml es/api-reference/openapi.json get /api/v1/subscriptions/website
openapi: 3.1.0
info:
  title: API de AthenaHQ
  description: >-
    La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web
    y consultas para optimizar el contenido con IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Servidor de producción
security:
  - apiKey: []
tags:
  - name: Basics
    description: Operaciones principales de la API para gestionar sitios web y consultas
  - name: Metrics
    description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA
  - name: Billing
    description: Endpoints de facturación y créditos para gestionar el uso
  - name: Team Management
    description: Endpoints para gestionar miembros del equipo e invitaciones
  - name: Groups
    description: Endpoints para gestionar grupos de sitios web
  - name: Content
    description: >-
      Endpoints para acceder a los datos del centro de contenidos: pestañas, URL
      monitorizadas y desglose de consultas por URL.
  - name: Pitch Workspace
    description: >-
      Endpoints para acceder a los informes del espacio de propuestas:
      ejecuciones de propuestas con alcance de organización, con competidores,
      consultas, atributos y métricas agregadas.
  - name: Knowledge Base
    description: >-
      Endpoints para leer la base de conocimientos de la marca: datos aprobados
      sobre la marca y los pilares que los organizan.
paths:
  /api/v1/subscriptions/website:
    get:
      tags:
        - Billing
      summary: Obtener suscripción del sitio web
      description: >-
        Devuelve los productos de suscripción de un sitio web concreto, con su
        estado y fechas de facturación.
      operationId: getWebsiteSubscription
      parameters:
        - name: website_id
          in: query
          description: ID del sitio web cuya información de suscripción se quiere obtener
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: Respuesta correcta con los productos de la suscripción
          content:
            application/json:
              schema:
                type: object
                properties:
                  products:
                    type: array
                    items:
                      $ref: '#/components/schemas/SubscriptionProduct'
                required:
                  - products
              example:
                products:
                  - id: pro_monthly
                    name: Pro Plan
                    status: active
                    canceled_at: null
                    cancel_at: null
                    started_at: 1704067200000
                    ended_at: null
        '400':
          description: 'Solicitud incorrecta: parámetros no válidos'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: website_id is required
        '401':
          description: 'Sin autorización: falta la clave de API o no es válida'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Acceso denegado: no tienes acceso a este sitio web'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Unauthorized access to this website
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: Failed to fetch subscription
      security:
        - apiKey: []
components:
  schemas:
    SubscriptionProduct:
      type: object
      description: Producto de suscripción asociado a un sitio web
      required:
        - id
        - name
        - status
      properties:
        id:
          type: string
          description: Identificador único del producto
          example: pro_monthly
        name:
          type: string
          description: Nombre visible del producto
          example: Pro Plan
        status:
          type: string
          enum:
            - active
            - trialing
            - expired
            - canceled
            - past_due
          description: Estado actual de la suscripción
          example: active
        canceled_at:
          type: integer
          nullable: true
          description: >-
            Marca de tiempo en milisegundos de la cancelación de la suscripción
            (null si no se ha cancelado)
          example: null
        cancel_at:
          type: integer
          nullable: true
          description: >-
            Marca de tiempo en milisegundos de la futura cancelación de la
            suscripción (null si no está programada)
          example: null
        started_at:
          type: integer
          nullable: true
          description: Marca de tiempo en milisegundos del inicio de la suscripción
          example: 1704067200000
        ended_at:
          type: integer
          nullable: true
          description: >-
            Marca de tiempo en milisegundos del fin de la suscripción (null si
            sigue activa)
          example: null
    Error:
      type: object
      description: Objeto de respuesta de error
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error que describe qué ha fallado
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clave de API para autenticarse. Puedes crear una
        [aquí](https://app.athenahq.ai/organization?tab=api).

````

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