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

# Get notification settings

> Returns global reminder settings for the API key owner. Bark secrets are never returned; barkConfigured indicates whether a valid Bark endpoint is already configured in the web app.



## OpenAPI

````yaml /api/openapi.yaml get /api/v1/notification-settings
openapi: 3.1.0
info:
  title: Subscription Manager Public API
  version: 1.0.0
  description: >-
    Public API for subscription CRUD automation through Developer API keys. The
    operation descriptions include AI-oriented task semantics, risk levels, and
    confirmation guidance for agent integrations.
servers:
  - url: https://your-site.example
    description: Replace with your deployed Subscription Manager site URL.
security:
  - bearerApiKey: []
tags:
  - name: Subscriptions
    description: Create, read, update, and delete subscriptions for the API key owner.
    x-ai:
      domain: subscription_management
      ownerScope: authenticated_api_key_owner
      writeSafety: >-
        Confirm create, update, and delete operations with the user before
        calling them from an AI agent. Write operations require an API key with
        the write scope. Soft cancel/pause/resume via status is not supported.
  - name: Analytics
    description: >-
      Computed spend summaries, duplicate detection, and optimization
      candidates. Read-only; money is reported per currency and never converted.
  - name: Audit
    description: Read-only audit trail of write operations performed through the API.
  - name: Notification settings
    description: >-
      Global reminder settings. Writable fields are limited to enabled and
      daysBefore. Bark URL, test push, timeZone, and locale are web-managed.
paths:
  /api/v1/notification-settings:
    get:
      tags:
        - Notification settings
      summary: Get notification settings
      description: >-
        Returns global reminder settings for the API key owner. Bark secrets are
        never returned; barkConfigured indicates whether a valid Bark endpoint
        is already configured in the web app.
      operationId: getNotificationSettings
      responses:
        '200':
          description: Notification settings.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSettingsResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
components:
  headers:
    XRateLimitLimit:
      description: Total allowed requests in the current fixed window.
      schema:
        type: integer
        example: 60
    XRateLimitRemaining:
      description: Requests remaining in the current fixed window.
      schema:
        type: integer
        example: 59
    XRateLimitReset:
      description: Unix timestamp in seconds when the fixed window resets.
      schema:
        type: integer
        example: 1781690400
    RetryAfter:
      description: >-
        Seconds to wait before retrying. Sent with 429 responses, including when
        too many invalid API key attempts are throttled.
      schema:
        type: integer
        example: 2700
  schemas:
    NotificationSettingsResponse:
      type: object
      required:
        - data
        - requestId
      properties:
        data:
          $ref: '#/components/schemas/NotificationSettings'
        requestId:
          type: string
      additionalProperties: false
    NotificationSettings:
      type: object
      required:
        - enabled
        - daysBefore
        - barkConfigured
        - updatedAt
      properties:
        enabled:
          type: boolean
          description: Global reminder master switch.
        daysBefore:
          type: integer
          enum:
            - 1
            - 3
            - 7
            - 14
          description: Days before renewal or trial end to send a reminder.
        timeZone:
          type: string
          nullable: true
          description: >-
            Read-only IANA time zone captured from the web app. Not writable
            through the public API.
        locale:
          type: string
          nullable: true
          description: >-
            Read-only reminder locale captured from the web app. Not writable
            through the public API.
        barkConfigured:
          type: boolean
          description: >-
            True when a valid Bark endpoint is already configured in the web
            app. Secrets are never returned.
        updatedAt:
          type: string
          format: date-time
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
        - requestId
      properties:
        error:
          $ref: '#/components/schemas/Error'
        requestId:
          type: string
      additionalProperties: false
    Error:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        field:
          type: string
          description: Field that caused the error when the server can identify one.
        suggestedFix:
          type: string
          description: Human- and AI-readable correction hint.
        allowedValues:
          type: array
          items:
            type: string
          description: Allowed enum values when the error is caused by an unsupported enum.
        writableFields:
          type: array
          items:
            type: string
          description: >-
            Writable subscription fields when the error is caused by a
            non-writable field.
      additionalProperties: false
  responses:
    Unauthorized:
      description: The API key is missing, invalid, or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            invalidApiKey:
              value:
                error:
                  code: invalid_api_key
                  message: Invalid API key
                requestId: request-1
    NotFound:
      description: The subscription was not found for the API key owner.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missing:
              value:
                error:
                  code: subscription_not_found
                  message: Subscription not found
                requestId: request-1
    RateLimited:
      description: The user request limit or invalid-auth attempt limit was exceeded.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/XRateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/XRateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/XRateLimitReset'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            rateLimited:
              value:
                error:
                  code: rate_limit_exceeded
                  message: Rate limit exceeded
                requestId: request-1
            tooManyInvalidKeys:
              value:
                error:
                  code: rate_limit_exceeded
                  message: Too many invalid API key attempts
                requestId: request-1
    InternalError:
      description: Unexpected server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internal:
              value:
                error:
                  code: internal_error
                  message: Internal server error
                requestId: request-1
  securitySchemes:
    bearerApiKey:
      type: http
      scheme: bearer
      description: >-
        Developer API key generated in the app. Keys carry scopes; a read key
        can call list, get, notification settings, analytics, and audit
        endpoints, while a write key additionally allows create, update, delete,
        and notification settings updates.
      x-default: subm_your_key_here

````