{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/qualpay/json-schema/qualpay-subscription-labels-list-response-schema.json",
  "title": "SubscriptionLabelsListResponse",
  "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/SubscriptionLabelsListResponse",
  "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/SubscriptionLabel"
      }
    }
  },
  "$defs": {
    "SubscriptionLabel": {
      "type": "object",
      "properties": {
        "source": {
          "type": "string",
          "description": "<strong>Constant:</strong> `SUBSCRIPTION`<br><strong>Description:</strong> This field is set by the system and is not required when adding, editing, or deleting entries.",
          "readOnly": true
        },
        "source_id": {
          "type": "integer",
          "description": "<strong>Format: </strong>Variable length, up to 10 N<br><strong>Description: </strong>The ID of the subscription with this custom field.  When adding, editing, or deleting entries, this attribute is assigned from the path parameter.",
          "format": "int64",
          "readOnly": true
        },
        "name": {
          "type": "string",
          "description": "<strong>Format: </strong>Variable length, up to 64 AN<br><strong>Description: </strong>The name of the custom field."
        },
        "value": {
          "type": "string",
          "description": "<strong>Format: </strong>Fixed length, 128 AN<br><strong>Description: </strong>The value of the custom field."
        }
      }
    }
  }
}