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

# List subscription configurations

> Retrieve a paginated list of subscription management configurations for your account.

Each configuration represents a subscription management setup with phone numbers for receiving opt-out/opt-in requests and a callback URL for webhook events.




## OpenAPI

````yaml get /v2/notify/management/subscriptions
openapi: 3.1.0
info:
  title: Prelude API
  version: 2.0.0
  description: The Prelude API allows you to send messages to your users.
  contact:
    email: support@prelude.so
servers:
  - url: https://api.prelude.dev
    description: Production server
security:
  - apiToken: []
tags:
  - name: Notify
    description: Send transactional and marketing messages with compliance enforcement.
  - name: Transactional
    description: Send transactional messages (deprecated - use Notify API instead).
  - name: Verify
    description: Verify phone numbers.
  - name: Watch
    description: Evaluate email addresses and phone numbers for trustworthiness.
  - name: Lookup
    description: >-
      Retrieve detailed information about a phone number including carrier data,
      line type, and portability status.
paths:
  /v2/notify/management/subscriptions:
    get:
      tags:
        - Notify
      summary: List subscription configurations
      description: >
        Retrieve a paginated list of subscription management configurations for
        your account.


        Each configuration represents a subscription management setup with phone
        numbers for receiving opt-out/opt-in requests and a callback URL for
        webhook events.
      operationId: listSubscriptionConfigs
      parameters:
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            maximum: 200
            default: 50
          description: Maximum number of configurations to return per page
        - name: cursor
          in: query
          required: false
          schema:
            type: string
          description: Pagination cursor from the previous response
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSubscriptionConfigsResponse'
        '400':
          description: KO
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    ListSubscriptionConfigsResponse:
      type: object
      required:
        - configs
      properties:
        configs:
          type: array
          description: A list of subscription management configurations.
          items:
            type: object
            required:
              - id
              - name
              - callback_url
              - messages
              - created_at
              - updated_at
            properties:
              id:
                type: string
                description: The subscription configuration ID.
                examples:
                  - subcfg_01k8ap1btqf5r9fq2c8ax5fhc9
              name:
                type: string
                description: The human-readable name for the subscription configuration.
                examples:
                  - Marketing Campaign
              callback_url:
                type: string
                format: uri
                description: The URL to call when subscription status changes.
                examples:
                  - https://your-app.com/webhooks/subscription
              messages:
                type: object
                description: The subscription messages configuration.
                properties:
                  help_message:
                    type: string
                    description: Message sent when user requests help.
                    examples:
                      - Reply STOP to unsubscribe or START to resubscribe.
                  stop_message:
                    type: string
                    description: Message sent when user unsubscribes.
                    examples:
                      - >-
                        You have been unsubscribed and will not receive further
                        messages. Reply START to resubscribe.
                  start_message:
                    type: string
                    description: Message sent when user subscribes.
                    examples:
                      - >-
                        You have been resubscribed and will receive messages
                        again. Reply STOP to unsubscribe.
              mo_phone_numbers:
                type: array
                description: A list of phone numbers for receiving inbound messages.
                items:
                  type: object
                  required:
                    - country_code
                    - phone_number
                  properties:
                    country_code:
                      type: string
                      description: The ISO 3166-1 alpha-2 country code.
                      examples:
                        - US
                        - FR
                    phone_number:
                      type: string
                      description: >-
                        The phone number in E.164 format for long codes, or
                        short code format for short codes.
                      examples:
                        - '+15551234567'
                        - '36184'
                example:
                  - country_code: US
                    phone_number: '+15551234567'
                  - country_code: FR
                    phone_number: '36184'
              created_at:
                type: string
                format: date-time
                description: The date and time when the configuration was created.
                examples:
                  - '2024-01-01T12:00:00Z'
              updated_at:
                type: string
                format: date-time
                description: The date and time when the configuration was last updated.
                examples:
                  - '2024-01-01T12:00:00Z'
        next_cursor:
          type: string
          description: >-
            Pagination cursor for the next page of results. Omitted if there are
            no more pages.
          examples:
            - eyJwayI6IjEyMzQ1Njc4LTkwYWItMTJjZC00NTY3LTg5MGFiMTJjZGU0NTYifQ==
    Error:
      type: object
      properties:
        code:
          type: string
          description: The error code.
          examples:
            - invalid_phone_number
        message:
          type: string
          examples:
            - >-
              The provided phone number is invalid. Provide a valid E.164 phone
              number.
          description: A human-readable message describing the error.
        type:
          type: string
          examples:
            - bad_request
          description: The error type.
        request_id:
          type: string
          examples:
            - 3d19215e-2991-4a05-a41a-527314e6ff6a
          description: >-
            A string that identifies this specific request. Report it back to us
            to help us diagnose your issues.
      required:
        - code
        - message
        - type
  securitySchemes:
    apiToken:
      type: http
      scheme: bearer

````