> ## 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. # Get a plan > Returns a single subscription plan by its `planId`, including schedules and pricing configuration. ## OpenAPI ````yaml /openapi.json post /v1/query/subscriptions/plan/{planId} 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/{planId}: post: tags: - Query summary: Get a plan description: >- Returns a single subscription plan by its `planId`, including schedules and pricing configuration. operationId: findPlanById parameters: - in: path name: planId required: true schema: type: string description: planID requestBody: required: true content: application/json: schema: type: object responses: '200': $ref: '#/components/responses/findPlanById' security: - basicAuth: [] components: responses: findPlanById: description: Find Plan By Id content: application/json: schema: type: object properties: success: type: boolean description: >- Whether the request was processed successfully. Declines return HTTP 200 with `success: false`. data: type: object properties: plan: 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. title: type: string description: Title. subTitle: type: string description: Subtitle displayed under the plan title. 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. description: Pricing model configuration for this schedule. enabled: type: boolean description: Whether this setting is enabled. description: Billing schedules for the plan. cancelOptions: type: array items: type: string description: Cancellation options offered to subscribers. status: type: string description: Current status. isDeleted: type: boolean description: Whether the record is soft-deleted. __v: type: integer description: Internal document version. Ignore. createdAt: type: string description: Timestamp when the object was created (ISO 8601). updatedAt: type: string description: Timestamp when the object was last updated (ISO 8601). description: The plan object. subMerchant: 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. status: type: string description: Current status. blockDuplicates: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: Duplicate-transaction blocking settings. transactionAmountLimit: type: integer description: Maximum amount per card transaction. eCheckAmountLimit: type: integer description: Maximum amount per eCheck transaction. fees: type: object properties: platform: type: object properties: perTransaction: type: object additionalProperties: type: object properties: discountRate: type: number fixed: type: number reverseFixed: type: boolean description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: type: object properties: period: type: string example: daily description: Billing period for this recurring fee. fixed: type: number example: 3 description: >- Fixed fee amount charged each time this event occurs. since: type: string format: date-time example: '2025-08-01T03:00:00.000Z' description: >- Start of the window during which this fee applies (ISO 8601). until: type: string format: date-time example: '2025-08-23T03:00:00.000Z' description: >- End of the window during which this fee applies (ISO 8601). status: type: string example: enabled description: >- Whether this recurring fee is currently active. isTriggerFirstTx: type: boolean example: false description: >- When true, the recurring fee starts only after the merchant processes their first transaction. isProrated: type: boolean example: true description: >- Whether the first billing period is prorated. description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. description: Fee configuration at the platform level. spProduct: type: object properties: perTransaction: type: object additionalProperties: type: object properties: discountRate: type: number fixed: type: number reverseFixed: type: boolean description: >- Event-based fees, one entry per transaction event type. perPeriod: type: array items: type: string description: >- Recurring fees charged on a fixed schedule, such as monthly service fees. perIncident: type: array items: type: string description: Fees charged per incident. description: >- Fee configuration at the Service Provider product level. description: >- Fee configuration. Overrides values from the fees template. reserve: type: object properties: enabled: type: boolean description: Whether this setting is enabled. cap: type: integer description: Reserve cap amount. percentage: type: integer description: Discount percentage. description: Reserve configuration. payout: type: object properties: mode: type: string description: Payout mode. frequency: type: string description: Billing frequency. executionDays: type: array items: type: integer description: Days on which scheduled charges execute. description: Payout configuration. subMerchantApplicationId: type: string description: Identifier of the merchant application. payoutBankAccounts: type: array items: type: object properties: accountRouting: type: string description: 9-digit ABA routing number. accountNumber: type: string description: Bank account number. accountType: type: string description: Bank account type, such as `checking`. entityType: type: string description: Entity type of the account holder. nameOnAccount: type: string description: Name on the bank account. status: type: string description: Current status. isPreferred: type: boolean description: >- Whether this is the preferred account for payouts. processor: type: object properties: stripe: type: object properties: status: type: string description: Current status. description: Stripe processor configuration. description: Processor configuration. bankAccountToken: type: string description: >- Token of the bank account that receives the payout. isDeleted: type: boolean description: Whether the record is soft-deleted. description: Bank accounts where the merchant receives payouts. email: type: string description: Email address. mobileNumber: type: string description: Mobile number (numeric only). processor: type: object properties: type: type: string description: The type. simulator: type: object properties: merchantId: type: string description: Merchant identifier at the processor. status: type: string description: Current status. description: Simulator processor configuration (Sandbox). cybersource: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: CyberSource processor configuration. fiserv: type: object properties: url: type: array items: type: string description: URL of the hosted page for this object. description: Fiserv processor configuration. stripe: type: object properties: owners: type: array items: type: string description: Business owners. description: Stripe processor configuration. description: Processor configuration. identity: type: object properties: business: type: object properties: legalName: type: string description: Registered legal name of the business. dbaName: type: string description: >- The merchant's doing-business-as name. Appears on customer statements unless overridden. tinType: type: string description: >- Type of tax identification number: `SSN`, `EIN`, or `Other`. federalTaxId: type: string description: Federal tax ID, 9 digits. phoneNumber: type: string description: Business phone number. address: type: object properties: streetNum: type: string description: Street number. streetName: type: string description: Street name. city: type: string description: City name. state: type: string description: Two-letter US state code. postalCode: type: string description: ZIP or postal code. country: type: string description: Two-letter ISO country code. type: type: string description: The type. description: Registered business address. websiteUrl: type: string description: Business website URL. ownershipType: type: string description: Legal structure of the business. businessEstablishedDate: type: string description: >- Date the business was established (YYYY-MM-DD). expectedMonthlyVolume: type: integer description: >- Expected monthly processing volume, used in underwriting. mccCode: type: string description: >- Four-digit merchant category code (MCC) that classifies the business. businessType: type: string description: Business type classification. irsStatus: type: string description: IRS TIN-matching status. description: Business identity details. contacts: type: array items: type: object properties: firstName: type: string description: First name. lastName: type: string description: Last name. email: type: string description: Email address. phoneNumber: type: string description: Phone number. ssn: type: string description: Social Security number, 9 digits. birthDate: type: string description: Date of birth (YYYY-MM-DD). position: type: string description: Role of the owner in the business. _id: type: string description: Internal document identifier. description: Contacts for the business. acceptedCards: type: array items: type: object properties: type: type: string description: The type. description: Card brands the merchant accepts. description: Identity details for the business and its owners. progress: type: object properties: isStartApplication: type: boolean description: Whether the merchant started the application. isCompleteProfile: type: boolean description: Whether the merchant completed their profile. isSubmit: type: boolean description: Whether the merchant submitted the application. description: Onboarding progress flags. rules: type: object properties: knowYourBusiness: type: object properties: passed: type: boolean description: Whether the check passed. checksIds: type: array items: type: string description: >- Identifiers of the verification checks performed. description: Know Your Business (KYB) verification results. payoutBankAccount: type: object properties: passed: type: boolean description: Whether the check passed. checksIds: type: array items: type: string description: >- Identifiers of the verification checks performed. description: Payout bank account verification result. uniqueLocation: type: object properties: passed: type: boolean description: Whether the check passed. checksIds: type: array items: type: string description: >- Identifiers of the verification checks performed. description: Unique-location verification result. acknowledged: type: object properties: passed: type: boolean description: Whether the check passed. checksIds: type: array items: type: string description: >- Identifiers of the verification checks performed. description: Acknowledgement state of merchant agreements. merchantMonitoring: type: object properties: passed: type: boolean description: Whether the check passed. checksIds: type: array items: type: string description: >- Identifiers of the verification checks performed. score: type: integer description: Monitoring risk score. description: Merchant monitoring results. description: Risk and compliance rule results. tokenization: type: object properties: publicKey: type: string description: Public key used for tokenization. description: Tokenization configuration. settings: type: object properties: branding: type: object properties: primaryColor: type: string description: Primary color (hex). secondaryColor: type: string description: Secondary color (hex). backgroundColor: type: string description: Background color (hex). contrastColor: type: string description: Contrast color (hex). textColor: type: string description: Text color (hex). description: Brand colors and logo for the hosted page. hostedSession: type: object properties: functions: type: object properties: collectBillingAddress: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Collect the customer's billing address during checkout. collectShippingAddress: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Collect the customer's shipping address during checkout. collectEmail: type: object properties: enabled: type: boolean description: Whether this setting is enabled. updateCustomer: type: boolean description: >- When true, the collected value is saved to the customer record. description: >- Collect the customer's email address during checkout. collectPhoneNumber: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Collect the customer's phone number during checkout. notes: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Free-text notes displayed on the hosted page. callToAction: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: Customization of the pay button. description: >- Data-collection and display options for the hosted page. paymentMethods: type: object properties: creditCard: type: object properties: enabled: type: boolean description: Whether this setting is enabled. cards: type: array items: type: string description: Card brands accepted. description: >- Credit card acceptance settings for the hosted page. eCheck: type: object properties: enabled: type: boolean description: Whether this setting is enabled. accounts: type: array items: type: string description: Bank account types accepted. description: >- eCheck (ACH) acceptance settings for the hosted page. applePay: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Apple Pay acceptance settings for the hosted page. googlePay: type: object properties: enabled: type: boolean description: Whether this setting is enabled. description: >- Google Pay acceptance settings for the hosted page. description: Payment methods offered on the hosted page. description: Configuration for the hosted payment page. invoice: type: object properties: invoiceNumber: type: string description: Invoice number displayed to the customer. description: Invoice settings. description: Merchant settings. logs: type: array items: type: string description: Event log entries. tags: type: array items: type: string description: Tags applied to the merchant. acknowledgedAt: type: string description: Timestamp when the merchant acknowledged (ISO 8601). validations: type: object properties: enabled: type: boolean description: Whether this setting is enabled. avs: type: object properties: addressNumber: type: boolean description: AVS result for the street number. addressPostalCode: type: boolean description: AVS result for the postal code. description: Address Verification Service (AVS) results. cvv: type: object properties: cvcCheck: type: boolean description: Result of the card verification code check. description: CVV check result. description: Verification results returned by the issuer. createdAt: type: string description: Timestamp when the object was created (ISO 8601). description: The submerchant object. description: The response payload. code: type: string description: Machine-readable result code. See the Error Codes reference. securitySchemes: basicAuth: type: http scheme: basic ````