Qualpay · Schema

UpdateSubscriptionRequest

PaymentsPayment ProcessingMerchant ServicesB2B PaymentsReportingTokenization

Properties

Name Type Description
amt_tran string Format: Variable length, up to 12,2 N
Description: The subscription billing amount. To update the amount for all upcoming billing cycles (the `recur_amt`), send `a
date_next string Format: Fixed length, 10, YYYY-MM-DD format
Description: The next billing date for this subscription.
Conditional Requirement: `payment_flag` i
date_start string Format: Fixed length, 10, YYYY-MM-DD format
Description: The date the subscription will start.
card_id string Format: Fixed length, 32 AN
Description: Update the card ID to be used for recurring charges. The card ID can be updated any time on an active subscription. Send a
payment_flag string Format: Variable length, 3 to 4 A
Description: Determines whether `date_next` changes only the upcoming billing date or all future billing dates. Possible values:
plan_desc string Format: Variable length, AN
Description: A short description of the subscription.
profile_id string Format: Fixed length, 20 N
Description: The Payment Gateway profile ID to be used when billing transactions. The new profile should use the same currency as the or
merchant_id integer Format: Variable length, up to 16 AN
Description: Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on b
View JSON Schema on GitHub

JSON Schema

qualpay-update-subscription-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-update-subscription-request-schema.json",
  "title": "UpdateSubscriptionRequest",
  "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/UpdateSubscriptionRequest",
  "type": "object",
  "properties": {
    "amt_tran": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, up to 12,2 N<br><strong>Description: </strong>The subscription billing amount. To update the amount for all upcoming billing cycles (the `recur_amt`), send `amt_tran` without `date_next`. To update the amount for only one billing cycle, send all of the following:<ul><li>`date_next`,</li><li>`payment_flag` set to `Next`, and</li><li>`amt_tran`.</li></ul>",
      "format": "double"
    },
    "date_next": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 10, YYYY-MM-DD format<br><strong>Description: </strong>The next billing date for this subscription.<br><strong>Conditional Requirement: </strong>`payment_flag` is required when sending `date_next`."
    },
    "date_start": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 10, YYYY-MM-DD format<br><strong>Description: </strong>The date the subscription will start."
    },
    "card_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 32 AN<br><strong>Description: </strong>Update the card ID to be used for recurring charges. The card ID can be updated any time on an active subscription. Send an empty string in this field to udpate the record to charge by the customer's primary form of payment. "
    },
    "payment_flag": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, 3 to 4 A<br><strong>Description: </strong> Determines whether `date_next` changes only the upcoming billing date or all future billing dates. Possible values:<ul> <li>`Next` - The `date_next` value only changes one future billing date (the next billing date).</li> <li>`All` - The `date_next` value changes the next billing date, and all future billing dates are updated in line with the (new) next billing date.</li></ul> <p><strong>Conditional Requirement: </strong>`payment_flag` is required when sending `date_next`.</p>"
    },
    "plan_desc": {
      "type": "string",
      "description": "<strong>Format: </strong>Variable length, AN<br><strong>Description: </strong>A short description of the subscription."
    },
    "profile_id": {
      "type": "string",
      "description": "<strong>Format: </strong>Fixed length, 20 N<br><strong>Description: </strong>The Payment Gateway profile ID to be used when billing transactions. The new profile should use the same currency as the original. "
    },
    "merchant_id": {
      "type": "integer",
      "description": "<strong>Format: </strong>Variable length, up to 16 AN<br><strong>Description: </strong>Identifies the merchant to whom this request applies. Optional field, applicable only if the request is sent on behalf of another merchant.<br><strong>Conditional Requirement: </strong>Required if this request is on behalf of another merchant.",
      "format": "int64"
    }
  }
}

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-update-subscription-request"
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.