> ## 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 plans

> Returns subscription plans with their schedules and pricing configuration.



## OpenAPI

````yaml /openapi.json post /v1/query/subscriptions/plan
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/plan:
    post:
      tags:
        - Query
      summary: List plans
      description: >-
        Returns subscription plans with their schedules and pricing
        configuration.
      operationId: findAllPlan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          $ref: '#/components/responses/findAllPlans'
      security:
        - basicAuth: []
components:
  responses:
    findAllPlans:
      description: Find Plans
      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.
                    planId:
                      type: string
                      description: Unique identifier of the subscription plan.
                    hostedSession:
                      type: object
                      properties:
                        hostedSessionId:
                          type: string
                          description: Identifier of the hosted session.
                        url:
                          type: string
                          description: URL of the hosted page for this object.
                      description: Configuration for the hosted payment page.
                    name:
                      type: string
                      description: Display name.
                    description:
                      type: string
                      description: Free-text description.
                    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.
                          unit:
                            type: string
                            description: Unit label for usage-based pricing.
                          discount:
                            type: object
                            properties:
                              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: number
                                    description: Price charged each billing cycle.
                                description: 'Flat pricing: a fixed price per billing cycle.'
                              flatTiered:
                                type: object
                                properties:
                                  tiers:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        tierId:
                                          type: string
                                          description: Identifier of the tier.
                                        name:
                                          type: string
                                          description: Display name of the tier.
                                        description:
                                          type: string
                                          description: >-
                                            Description of the tier shown to the
                                            customer.
                                        price:
                                          type: number
                                          description: Price of the tier per billing cycle.
                                        featuresSettings:
                                          type: object
                                          properties:
                                            label:
                                              type: string
                                              description: >-
                                                Heading displayed above the feature
                                                list.
                                            features:
                                              type: array
                                              items:
                                                type: object
                                                properties:
                                                  name:
                                                    type: string
                                                    description: Display name.
                                                  description:
                                                    type: string
                                                    description: Free-text description.
                                              description: Feature list displayed for this tier.
                                          description: >-
                                            Display settings for the tier's feature
                                            list.
                                    description: Available tiers for this schedule.
                                description: Flat pricing with selectable tiers.
                              perModule:
                                type: object
                                properties:
                                  modules:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        moduleId:
                                          type: string
                                          description: Identifier of the module.
                                        name:
                                          type: string
                                          description: Display name.
                                        description:
                                          type: string
                                          description: Free-text description.
                                        price:
                                          type: number
                                          description: Price per billing cycle.
                                    description: Modules available for subscription.
                                description: >-
                                  Per-module pricing: the customer subscribes to
                                  individual modules.
                              perUsageQuantity:
                                type: object
                                properties:
                                  unitPrice:
                                    type: number
                                    description: Price per unit of usage.
                                description: >-
                                  Usage-based pricing with a single per-unit
                                  price.
                              perUsageVolume:
                                type: object
                                properties:
                                  steps:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        stepId:
                                          type: string
                                          description: Identifier of the volume step.
                                        startQty:
                                          type: integer
                                          description: >-
                                            First unit quantity this step applies
                                            to.
                                        endQty:
                                          type: integer
                                          description: Last unit quantity this step applies to.
                                        unitPrice:
                                          type: number
                                          description: Price per unit within this volume step.
                                    description: Volume pricing steps.
                                description: >-
                                  Usage-based pricing where the unit price
                                  depends on total volume.
                              perUsageTiered:
                                type: object
                                properties:
                                  tiers:
                                    type: array
                                    items:
                                      type: object
                                      properties:
                                        tierId:
                                          type: string
                                          description: Identifier of the tier.
                                        name:
                                          type: string
                                          description: Display name of the tier.
                                        description:
                                          type: string
                                          description: >-
                                            Description of the tier shown to the
                                            customer.
                                        unitPrice:
                                          type: number
                                          description: Price per unit.
                                        quantitySettings:
                                          type: object
                                          properties:
                                            tiers:
                                              type: array
                                              items:
                                                type: integer
                                              description: Available tiers for this schedule.
                                          description: Quantity settings for the pricing model.
                                    description: Available tiers for this schedule.
                                description: >-
                                  Usage-based pricing with tiered rates per
                                  volume step.
                            description: Pricing model configuration for this schedule.
                      description: Billing schedules for the plan.
                    status:
                      type: string
                      description: Current status.
                    subscribersQuantity:
                      type: integer
                      description: Number of active subscribers on this plan.
                    subMerchantDbaName:
                      type: string
                      description: DBA name of the submerchant that owns the plan.
                description: The response payload.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````