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

# Create an installment plan

> Creates an installment plan that splits a total amount into scheduled payments for a customer. The initial charge depends on the deposit and start date: with no deposit and no future start date, the first payment is charged immediately; with a future start date and no deposit, only card validation is performed; with a deposit and no future start date, the deposit plus the first payment are charged immediately; with both, only the deposit is charged immediately.



## OpenAPI

````yaml /openapi.json post /v1/installments
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/installments:
    post:
      tags:
        - Installments
      summary: Create an installment plan
      description: >-
        Creates an installment plan that splits a total amount into scheduled
        payments for a customer. The initial charge depends on the deposit and
        start date: with no deposit and no future start date, the first payment
        is charged immediately; with a future start date and no deposit, only
        card validation is performed; with a deposit and no future start date,
        the deposit plus the first payment are charged immediately; with both,
        only the deposit is charged immediately.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                subMerchantId:
                  type: string
                  description: The subMerchantId associated with the installment.
                  example: mtck-md-1
                customerId:
                  type: string
                  description: The ID of the customer for this installment.
                  example: 2ce8fe11-e111-4d76-a59e-7914d903ec12
                totalAmount:
                  type: number
                  description: The total amount to be paid across all installments.
                  example: 100
                deposit:
                  type: object
                  description: Optional deposit charged at creation time.
                  properties:
                    amount:
                      type: number
                      description: Deposit amount. Use 0 for no deposit.
                      example: 10
                payments:
                  type: object
                  description: Recurring payment schedule configuration.
                  properties:
                    startDate:
                      type: string
                      description: >-
                        Optional first installment date in YYYY-MM-DD format. If
                        omitted or today, first payment is charged immediately.
                      example: '2026-02-10'
                    frequency:
                      type: string
                      description: Billing frequency.
                      example: monthly
                    amount:
                      type: number
                      description: Amount per installment payment.
                      example: 9
                    qty:
                      type: number
                      description: Number of installment payments.
                      example: 10
                  required:
                    - frequency
                    - amount
                    - qty
                paymentToken:
                  type: object
                  description: The customer's permanent payment token.
                  properties:
                    type:
                      type: string
                      example: creditcard
                      description: Type of token supplied.
                    token:
                      type: object
                      properties:
                        provider:
                          type: string
                          example: jupico
                          description: >-
                            Payment provider that issued the token (for example,
                            `jupico`).
                        token:
                          type: string
                          example: f309450d-ef37-42f1-ac04-b04192a8d65f
                          description: The token value.
                      description: Token payload returned by tokenization.
              required:
                - subMerchantId
                - customerId
                - totalAmount
                - payments
                - paymentToken
      responses:
        '201':
          description: Installment successfully created.
        '400':
          description: Bad Request. Invalid input.
        '401':
          description: Unauthorized.
        '500':
          description: Internal Server Error.
      security:
        - basicAuth: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic

````