Qualpay · Schema

RecurringPlanListResponse

PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization

Properties

Name Type Description
code integer Format: Fixed length, 1 N
Description: Response code from the API. `0` indicates success. Refer to
message string Format: Variable length AN
Description: A short description of the API response code.
totalPages integer Format: Variable length N
Description: Total number of pages.
totalRecords integer Format: Variable length, up to 3 N
Description: Total number of records up to a maximum of 100.
data array An array of the resource object.
View JSON Schema on GitHub

JSON Schema

qualpay-recurring-plan-list-response-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-recurring-plan-list-response-schema.json",
  "title": "RecurringPlanListResponse",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/qualpay-recurring-billing-api-openapi.yml#/components/schemas/RecurringPlanListResponse",
  "type": "object",
  "properties": {
    "code": {
      "type": "integer",
      "description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>Response code from the API. `0` indicates success. Refer to <a href=\"/docs/api-conventions#platform-api-response-codes\" target=\"_blank\">Platform API Response Codes</a> for the entire list of return codes.",
      "format": "int32",
      "readOnly": true
    },
    "message": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the API response code.",
      "readOnly": true
    },
    "totalPages": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length N<br><strong>Description: </strong>Total number of pages. ",
      "format": "int32",
      "readOnly": true
    },
    "totalRecords": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 3 N<br><strong>Description: </strong>Total number of records up to a maximum of 100.",
      "format": "int32",
      "readOnly": true
    },
    "data": {
      "type": "array",
      "description": "An array of the resource object.",
      "readOnly": true,
      "items": {
        "$ref": "#/$defs/RecurringPlan"
      }
    }
  },
  "$defs": {
    "RecurringPlan": {
      "type": "object",
      "properties": {
        "merchant_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>The unique ID assigned to a merchant.",
          "format": "int64"
        },
        "plan_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>Unique ID generated for a plan.",
          "format": "int64"
        },
        "plan_code": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>A unique alphanumeric code provided by the merchant to identify the plan."
        },
        "plan_name": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>A unique name assigned to the plan. "
        },
        "plan_desc": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>A short description of the plan."
        },
        "plan_frequency": {
          "type": "integer",
          "description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong> The billing frequency. Possible values: <ul> <li>`0` - Weekly</li> <li>`1` - Bi-weekly</li> <li>`3` - Monthly</li> <li>`4` - Quarterly</li> <li>`5` - Bi-annually</li> <li>`6` - Annually</li> <li>`7` - Daily</li> </ul>",
          "format": "int32",
          "enum": [
            0,
            1,
            3,
            4,
            5,
            6,
            7
          ]
        },
        "interval": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 2 N<br><strong>Description: </strong>Number of months or weeks in a subscription cycle. For example, if `plan_frequency` is `3` (Monthly) and `interval` is `2`, a customer using this plan will be billed every 2 months until the subscription is complete or canceled. Applicable only for monthly or weekly `plan_frequency`. <br><strong>Default: </strong>1",
          "format": "int32"
        },
        "plan_duration": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 4 N<br><strong>Description: </strong> Number of billing cycles in the recurring transaction. For example, if `plan_frequency` is `3` (monthly) and `plan_duration` is `6`, the customer will be billed every month for 6 months. `-1` indicates bill until canceled.",
          "format": "int32"
        },
        "status": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 1 A<br><strong>Description: </strong>Status of the plan. Possible values:<ul><li>`E` - Active</li><li>`A` - Archived</li><li>`D` - Deleted</li></ul>",
          "enum": [
            "E",
            "A",
            "D"
          ]
        },
        "trial_duration": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 2 N<br><strong>Description: </strong>Number of billing cycles in a trial period.",
          "format": "int32"
        },
        "amt_trial": {
          "type": "number",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>Amount to be billed during the trial period.",
          "format": "double"
        },
        "amt_setup": {
          "type": "number",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>One-time fee amount.",
          "format": "double"
        },
        "amt_tran": {
          "type": "number",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>Plan transaction amount, which is the amount that will be billed each cycle. ",
          "format": "double"
        },
        "tran_currency": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 3 AN<br><strong>Description: </strong>The ISO numeric currency code. This must be a currency code associated with one of your payment profiles; contact Qualpay to add currencies. Refer to <a href=\"/docs/references#currency-codes\" target=\"_blank\">Currency Codes</a> for a list of currency codes.<br><strong>Default: </strong>840"
        },
        "profile_id": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 20 N<br><strong>Description: </strong>Payment Gateway profile ID that will be used for subscriptions on this plan. "
        },
        "bill_specific_day": {
          "type": "boolean",
          "description": "<strong>Description: </strong>If set to `true`, the customer will be billed on a specific start date.<br><strong>Default: </strong>false"
        },
        "day_of_week": {
          "type": "integer",
          "description": "<strong>Format: </strong>Fixed length, 1 N<br><strong>Description: </strong>This field represents the day of the week on which the system will bill for weekly or biweekly plans. Use one of the following codes: <ul><li>`1` - Sunday</li><li>`2` - Monday</li><li>`3` - Tuesday</li><li>`4` - Wednesday</li><li>`5` - Thursday</li><li>`6` - Friday</li><li>`7` - Saturday</li></ul><p><strong>Conditional Requirement: </strong>Applicable only when billing is on a specific day, i.e., `bill_specific_day` is set to `true`.</p>",
          "format": "int32"
        },
        "day_of_month": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 2 N<br><strong>Description: </strong>Day of the month on which the system will bill for monthly or annual plans. Use `1`-`31` to specify the day of month when the customer will be billed. Use `32` if billing should be on the last day of month. <br><strong>Conditional Requirement: </strong>Applicable only when `bill_specific_day` is set to `true` (i.e., billing is on a specific day).",
          "format": "int32"
        },
        "month": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 2 N<br><strong>Description: </strong>Month on which the system will bill for monthly or annual plans. Possible values:<ul><li>`1` - January</li><li>`2` - February</li><li>`3` - March</li><li>`4` - April</li><li>`5` - May</li><li>`6` - June</li><li>`7` - July</li><li>`8` - August</li><li>`9` - September</li><li>`10` - October</li><li>`11` - November</li><li>`12` - December</li></ul><p><strong>Conditional Requirement: </strong>Applicable only when billing is on a specific day, i.e., `bill_specific_day` is set to `true`.</p>",
          "format": "int32"
        },
        "prorate_first_pmt": {
          "type": "boolean",
          "description": "<strong>Description: </strong>`true` if the first payment should be prorated. <br><strong>Conditional Requirement: </strong>Applicable only when billing is on a specific day, i.e., `bill_specific_day` flag is set to `true`."
        },
        "amt_prorate": {
          "type": "number",
          "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>The fixed prorated amount for first payment. If set to `0` or undefined, the system will calculate the prorated amount based on the number of days remaining in the first cycle. <br><strong>Conditional Requirement: </strong>This field is applicable only if `prorate_first_pmt` is set to `true`. ",
          "format": "double"
        },
        "db_timestamp": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>Date/time the plan was created."
        },
        "mod_timestamp": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length AN<br><strong>Description: </strong>Date/time the plan was last modified."
        }
      }
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/qualpay-recurring-plan-list-response"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.