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

# Get payment status

> Returns payment status, billing mode, and the available pay-per-use option(s). Arlo is pay-per-use; there are no subscriptions.



## OpenAPI

````yaml /api-reference/openapi.yaml get /api/subscription
openapi: 3.1.0
info:
  title: Arlo Health MCP Server
  version: 1.0.0
  description: >
    Healthcare infrastructure for AI agents. Everything an agent needs

    to act in healthcare for its user.


    ## Overview


    This server exposes two interfaces:

    - **MCP** (Model Context Protocol) over streamable HTTP at `/` for AI agents

    - **REST API** at `/api/*` for bots, skills, and direct HTTP clients


    Both interfaces use the same tool handlers and authentication.


    ## Authentication


    OAuth 2.1 with PKCE. All `/api/*` endpoints require a Bearer token.


    Discovery endpoints (no auth required):

    - `/.well-known/oauth-protected-resource`

    - `/.well-known/oauth-authorization-server`

    - `/.well-known/mcp.json` (MCP Server Card)


    ## Service Regions


    Available in Ontario, Canada (`CA-ON`) and California, United States
    (`US-CA`).
  contact:
    name: Arlo Health
    url: https://arlohealth.ai
  license:
    name: Proprietary
    url: https://arlohealth.ai/tos
servers:
  - url: https://mcp.arlohealth.ai
    description: Production MCP Server
security:
  - oauth2:
      - openid
      - profile
      - email
      - offline_access
tags:
  - name: Discovery
    description: MCP and OAuth discovery endpoints (no auth required)
  - name: Profile
    description: User profile and patient information
  - name: Consultations
    description: Healthcare consultation management
  - name: Messaging
    description: Conversation messaging and media
  - name: Prescriptions
    description: Prescription and pharmacy management
  - name: Payment
    description: Billing and pay-per-use payment management
  - name: Webhooks
    description: Webhook registration and status
paths:
  /api/subscription:
    get:
      tags:
        - Payment
      summary: Get payment status
      description: >-
        Returns payment status, billing mode, and the available pay-per-use
        option(s). Arlo is pay-per-use; there are no subscriptions.
      operationId: getPaymentStatus
      responses:
        '200':
          description: Payment status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SubscriptionInfo'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    SubscriptionInfo:
      type: object
      description: >-
        User payment status and pay-per-use option(s). (Schema name retained for
        compatibility; Arlo is pay-per-use, not subscription-based.)
      properties:
        billingMode:
          type: string
          enum:
            - NONE
            - PAY_AS_YOU_GO
            - SUBSCRIPTION
            - LEGACY
        paymentStatus:
          type: string
          enum:
            - PENDING
            - ACTIVE
            - FAILED
            - CANCELLED
            - ACTIVE_UNTIL_EXPIRY
        freeTrialActive:
          type: boolean
        freeTrialEndTimestamp:
          type: integer
          description: Unix timestamp
        nextBillingTimestamp:
          type: integer
          description: Unix timestamp
        nextBillingAmount:
          type: integer
          description: Amount in cents
        paymentOptions:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              title:
                type: string
              price:
                type: string
              description:
                type: string
              priceAmountCents:
                type: integer
              isDefault:
                type: boolean
              billingMode:
                type: string
              interval:
                type: string
  responses:
    Unauthorized:
      description: Missing or invalid authentication
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
              needsAuth:
                type: boolean
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.1 with PKCE
      flows:
        authorizationCode:
          authorizationUrl: /oauth/authorize
          tokenUrl: /oauth/token
          scopes:
            openid: OpenID Connect
            profile: User profile
            email: Email address
            offline_access: Refresh tokens

````