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

# List subscriptions

> Returns subscriptions, both active and inactive, including their schedules and billing status.



## OpenAPI

````yaml /openapi.json post /v1/query/subscriptions
openapi: 3.0.0
info:
  title: Jupico - OpenAPI 3.0
  description: >-
    The Jupico API lets Service Providers onboard merchants, process card and
    eCheck (ACH) payments, run hosted payment pages, manage recurring billing,
    send payouts, and query every resource. All endpoints use HTTPS with Basic
    authentication and accept and return JSON. Endpoints are grouped by
    workflow: onboard merchants first, then accept payments, then move funds and
    report.
  termsOfService: https://help.jupico.com/references-and-resources/legal
  contact:
    email: support@jupico.com
  license:
    name: Jupico License
    url: https://jupico.com
  version: 1.0.5
servers:
  - url: https://sandbox-platform.jupico.com
security:
  - basicAuth: []
tags:
  - name: Status
    description: Health check for the Jupico API.
  - name: Onboarding Invites
    description: >-
      Create and send invites that onboard merchants through the Jupico-hosted
      flow, with optional pre-filled identity, fees, and payout bank account
      data.
  - name: Provisioning
    description: >-
      Onboard merchants from your own UI. Collect onboarding data and submit it
      through the provisioning chain: applicant → application → submerchant.
  - name: Session
    description: >-
      Create browser authorization sessions for the Jupico web components, so
      card and bank account data is tokenized client-side and never touches your
      servers.
  - name: Tokenization
    description: >-
      Convert one-time tokens from the web components into permanent Jupico
      tokens, or tokenize raw card data if your systems are PCI DSS compliant.
  - name: Customer
    description: >-
      Create and manage customer records that payments, subscriptions,
      installments, and invoices link to.
  - name: Card Transactions
    description: >-
      Process credit and debit card transactions using tokenized card data:
      sale, authorization, capture, void, refund, and rollback.
  - name: eCheck Transactions
    description: >-
      Debit customer bank accounts via eCheck (ACH): sale, void, refund,
      rollback, and bank account tokenization.
  - name: Checkouts
    description: >-
      Hosted checkout sessions where customers complete payment on a
      Jupico-hosted page.
  - name: Payment Links
    description: >-
      Shareable links that open a Jupico-hosted payment page — no integration
      code needed at the point of sharing.
  - name: Invoices
    description: Create and email invoices that customers pay online.
  - name: Subscriptions
    description: >-
      Recurring billing. Plans define billing schedules and pricing models;
      subscriptions enroll customers against a stored payment token.
  - name: Installments
    description: Split a fixed total into scheduled payments with an optional deposit.
  - name: Payouts
    description: >-
      Send funds from a submerchant's available balance to a tokenized bank
      account with on-demand payout instructions.
  - name: Query
    description: >-
      Search and report across every resource: transactions, merchants,
      settlements, balances, disputes, fees, and more. All query endpoints
      accept the same filter, sort, and pagination envelope — see the Query
      Capabilities guide.
paths:
  /v1/query/subscriptions:
    post:
      tags:
        - Query
      summary: List subscriptions
      description: >-
        Returns subscriptions, both active and inactive, including their
        schedules and billing status.
      operationId: findAllSubscription
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          $ref: '#/components/responses/findAllQuerySubscriptions'
      security:
        - basicAuth: []
components:
  responses:
    findAllQuerySubscriptions:
      description: Find Subscriptions
      content:
        application/json:
          schema:
            type: object
            properties:
              success:
                type: boolean
                description: >-
                  Whether the request was processed successfully. Declines
                  return HTTP 200 with `success: false`.
              message:
                type: string
                description: Human-readable result message.
              code:
                type: string
                description: Machine-readable result code. See the Error Codes reference.
              data:
                type: array
                items:
                  type: object
                  properties:
                    _id:
                      type: string
                      description: Internal document identifier.
                    facId:
                      type: string
                      description: Facilitator identifier assigned by Jupico.
                    spProductId:
                      type: string
                      description: >-
                        Identifier of the Service Provider product the merchant
                        belongs to.
                    subMerchantId:
                      type: string
                      description: Unique identifier of the submerchant.
                    subscriptionId:
                      type: string
                      description: Unique identifier of the subscription.
                    planId:
                      type: string
                      description: Unique identifier of the subscription plan.
                    schedules:
                      type: array
                      items:
                        type: object
                        properties:
                          scheduleId:
                            type: string
                            description: >-
                              Identifier of the plan schedule the subscription
                              uses.
                          order:
                            type: integer
                            description: Display order, starting at 1.
                          label:
                            type: string
                            description: Display label for this schedule.
                          invoiceDescription:
                            type: string
                            description: >-
                              Description shown on invoices generated by this
                              schedule.
                          frequency:
                            type: string
                            description: Billing frequency.
                          cyclesQty:
                            type: integer
                            description: Number of billing cycles before the schedule ends.
                          executionDays:
                            type: array
                            items:
                              type: integer
                            description: Days on which scheduled charges execute.
                          discount:
                            type: object
                            properties:
                              enabled:
                                type: boolean
                                description: Whether this setting is enabled.
                              percentage:
                                type: integer
                                description: Discount percentage.
                            description: Discount applied to the schedule.
                          pricingModel:
                            type: object
                            properties:
                              type:
                                type: string
                                description: The type.
                              free:
                                type: object
                                properties:
                                  daysQty:
                                    type: integer
                                    description: Number of free days before billing begins.
                                description: Free trial configuration.
                              flat:
                                type: object
                                properties:
                                  price:
                                    type: integer
                                    description: Price charged each billing cycle.
                                description: 'Flat pricing: a fixed price per billing cycle.'
                            description: Pricing model configuration for this schedule.
                          enabled:
                            type: boolean
                            description: Whether this setting is enabled.
                      description: Billing schedules for the plan.
                    executions:
                      type: array
                      items:
                        type: object
                        properties:
                          executionId:
                            type: string
                            description: Identifier of the billing execution.
                          date:
                            type: string
                            format: date-time
                            description: Invoice issue date (ISO 8601).
                          amount:
                            type: integer
                            description: The amount of the transaction.
                          pricingModel:
                            type: object
                            properties:
                              type:
                                type: string
                                description: The type.
                              free:
                                type: object
                                properties:
                                  daysQty:
                                    type: integer
                                    description: Number of free days before billing begins.
                                description: Free trial configuration.
                              flat:
                                type: object
                                properties:
                                  price:
                                    type: integer
                                    description: Price charged each billing cycle.
                                description: 'Flat pricing: a fixed price per billing cycle.'
                            description: Pricing model configuration for this schedule.
                          scheduleId:
                            type: string
                            description: >-
                              Identifier of the plan schedule the subscription
                              uses.
                          transactionId:
                            type: string
                            description: Unique identifier of the original transaction.
                          invoiceId:
                            type: string
                            description: Unique identifier of the invoice.
                          status:
                            type: string
                            description: Current status.
                      description: Billing executions for this subscription.
                    startDate:
                      type: string
                      format: date-time
                      description: >-
                        Optional first payment date (YYYY-MM-DD). If omitted,
                        payments start immediately.
                    status:
                      type: string
                      description: Current status.
                    customerId:
                      type: string
                      description: Unique identifier of the customer.
                    token:
                      type: string
                      description: The token value.
                    nextExecution:
                      type: object
                      properties:
                        executionId:
                          type: string
                          description: Identifier of the billing execution.
                        date:
                          type: string
                          format: date-time
                          description: Invoice issue date (ISO 8601).
                        amount:
                          type: integer
                          description: The amount of the transaction.
                        pricingModel:
                          type: object
                          properties:
                            type:
                              type: string
                              description: The type.
                            free:
                              type: object
                              properties:
                                daysQty:
                                  type: integer
                                  description: Number of free days before billing begins.
                              description: Free trial configuration.
                            flat:
                              type: object
                              properties:
                                price:
                                  type: integer
                                  description: Price charged each billing cycle.
                              description: 'Flat pricing: a fixed price per billing cycle.'
                          description: Pricing model configuration for this schedule.
                        scheduleId:
                          type: string
                          description: >-
                            Identifier of the plan schedule the subscription
                            uses.
                        transactionId:
                          type: string
                          description: Unique identifier of the original transaction.
                        invoiceId:
                          type: string
                          description: Unique identifier of the invoice.
                        status:
                          type: string
                          description: Current status.
                      description: Next scheduled billing execution.
                    creditCard:
                      type: object
                      properties:
                        _id:
                          type: string
                          description: Internal document identifier.
                        facId:
                          type: string
                          description: Facilitator identifier assigned by Jupico.
                        subMerchantId:
                          type: string
                          description: Unique identifier of the submerchant.
                        token:
                          type: string
                          description: The token value.
                        cardHolderName:
                          type: string
                          description: Name of the cardholder.
                        expirationMonth:
                          type: string
                          description: Two-digit expiration month (01-12).
                        expirationYear:
                          type: string
                          description: Two-digit expiration year.
                        cardLogo:
                          type: string
                          description: Card brand logo identifier.
                        truncatedCardNumber:
                          type: string
                          description: Masked card number.
                      description: Credit card acceptance settings.
                description: The response payload.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````