Sustema

ENTITY developer reference

ICOffer

Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.

This is a documentation reading view of an unreleased candidate, not a downloadable replacement schema. Public wire names, types and constraints are retained except for the explicitly marked private-only subsets and route patterns. Private governance references are explained in public language. Use only a separately released, verified generation for clients. Read the explicit exclusions.

This is the public candidate schema reading view. Read it with the operation that uses it; a representable field does not establish enabled coverage or entitlement.

Caller-permitted immutable offer; no source inventory, supplier prices, payment methods or autonomous purchase. Values are published only after the private qualification gate. Zero-unit funded evaluation is explicitly sponsored, not a production price. In this generation a non-available contract_scheduled shape is an explicitly unavailable informational candidate, not commercial publication, a buyable offer or an accepted update promise. Publishing/acceptance remains prohibited until its separate contract/baseline/closure qualification; basic mode none is unchanged.

Declared type: "object"

Declared fields

This list shows only properties declared directly in this schema. Required labels refer only to this schema’s own required array. Referenced, composed and conditional rules can add constraints; a field not listed as required here is not guaranteed to be optional.

offer

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for offer
{
  "$ref": "#/components/schemas/ICVersionRef"
}

tariff_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for tariff_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

terms_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for terms_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

unit

Listed in this schema’s required array.

Declared type
"string"
Reading definition for unit
{
  "type": "string",
  "minLength": 1,
  "maxLength": 80,
  "x-profile-maxLength": "string_characters_max"
}

unit_scale

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for unit_scale
{
  "type": "integer",
  "minimum": 1
}

standards

Listed in this schema’s required array.

Declared type
"array"
Reading definition for standards
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ICStandardRate"
  },
  "minItems": 1,
  "maxItems": 2,
  "x-profile-maxItems": "collection_items_max"
}

bundles

Listed in this schema’s required array.

Declared type
"array"
Reading definition for bundles
{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/ICBundleRate"
  },
  "minItems": 0,
  "maxItems": 8,
  "x-profile-maxItems": "collection_items_max"
}

availability

Listed in this schema’s required array.

Declared type
"string"
Reading definition for availability
{
  "type": "string",
  "enum": [
    "available",
    "not_ready",
    "not_entitled"
  ],
  "x-profile-maxLength": "string_characters_max"
}

allowed_research_modes

Listed in this schema’s required array.

Declared type
"array"
Reading definition for allowed_research_modes
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "existing_only",
      "held_or_known_site",
      "bounded_discovery"
    ],
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 1,
  "maxItems": 3,
  "x-profile-maxItems": "collection_items_max"
}

maximum_entities

Listed in this schema’s required array.

Structural request maximum, also constrained by the disclosed effective response-byte bound and actual content across released adapters. A count alone never guarantees fit. Oversize returns structured reduction guidance before paid work; no silent truncation.

Declared type
"integer"
Reading definition for maximum_entities
{
  "type": "integer",
  "minimum": 1,
  "maximum": 1000,
  "description": "Structural request maximum, also constrained by the disclosed effective response-byte bound and actual content across released adapters. A count alone never guarantees fit. Oversize returns structured reduction guidance before paid work; no silent truncation."
}

maximum_order_seconds

Listed in this schema’s required array.

Maximum integer seconds from original quote.created_at to latest_accounting_at, including settlement margin. Quote producer derives the accounting deadline from requested latest_completion_at and its required margin and refuses the request if that derived latest_accounting_at exceeds created_at+maximum_order_seconds, using existing invalid_request/400, field latest_completion_at, usage_state=not_started. No grant may be backdated after its original accounting deadline.

Declared type
"integer"
Reading definition for maximum_order_seconds
{
  "type": "integer",
  "minimum": 1,
  "description": "Maximum integer seconds from original quote.created_at to latest_accounting_at, including settlement margin. Quote producer derives the accounting deadline from requested latest_completion_at and its required margin and refuses the request if that derived latest_accounting_at exceeds created_at+maximum_order_seconds, using existing invalid_request/400, field latest_completion_at, usage_state=not_started. No grant may be backdated after its original accounting deadline."
}

quote_valid_seconds

Listed in this schema’s required array.

Declared type
"integer"
Reading definition for quote_valid_seconds
{
  "type": "integer",
  "minimum": 1
}

result_access_seconds

Listed in this schema’s required array.

result_access_seconds is measured from this original acquisition.granted_at. Its access_valid_until is the minimum of granted_at plus the accepted original offer duration and all earlier original result/source-rights, deletion and other lawful validity cutoffs. A repeat read or reuse of the same acquisition never renews that stored deadline. Existing access_valid_until values are never extended by this clarification. A new paid acquisition, if separately admitted, uses its own accepted original terms; no automatic refresh or new acquisition is created. Incremental recognition still checks the prior acquisition's actual access_valid_until, so an earlier lawful cutoff can end eligibility within the maximum advertised window.

Declared type
"integer"
Reading definition for result_access_seconds
{
  "type": "integer",
  "minimum": 1,
  "description": "result_access_seconds is measured from this original acquisition.granted_at. Its access_valid_until is the minimum of granted_at plus the accepted original offer duration and all earlier original result/source-rights, deletion and other lawful validity cutoffs. A repeat read or reuse of the same acquisition never renews that stored deadline. Existing access_valid_until values are never extended by this clarification. A new paid acquisition, if separately admitted, uses its own accepted original terms; no automatic refresh or new acquisition is created. Incremental recognition still checks the prior acquisition's actual access_valid_until, so an earlier lawful cutoff can end eligibility within the maximum advertised window."
}

receipt_access_seconds

Listed in this schema’s required array.

Original receipt access duration, still subject to lawful earlier deletion. For positive incremental windows only, must cover maximum_order_seconds+upgrade_valid_seconds; does not authorise retaining prohibited joins.

Declared type
"integer"
Reading definition for receipt_access_seconds
{
  "type": "integer",
  "minimum": 1,
  "description": "Original receipt access duration, still subject to lawful earlier deletion. For positive incremental windows only, must cover maximum_order_seconds+upgrade_valid_seconds; does not authorise retaining prohibited joins."
}

upgrade_valid_seconds

Listed in this schema’s required array.

Optional half-open incremental eligibility from original acquisition granted_at to granted_at+this duration, checked at dependent acceptance commit. Zero offers no window. Positive values require upgrade<=result_access_seconds and maximum_order_seconds+upgrade<=min(receipt_access_seconds,90*86400). Earlier rights loss, deletion, proved basis change or pending financial review can end eligibility; quotes disclose no private hold cause. This is not a refresh/monitoring interval.

Declared type
"integer"
Reading definition for upgrade_valid_seconds
{
  "type": "integer",
  "minimum": 0,
  "description": "Optional half-open incremental eligibility from original acquisition granted_at to granted_at+this duration, checked at dependent acceptance commit. Zero offers no window. Positive values require upgrade<=result_access_seconds and maximum_order_seconds+upgrade<=min(receipt_access_seconds,90*86400). Earlier rights loss, deletion, proved basis change or pending financial review can end eligibility; quotes disclose no private hold cause. This is not a refresh/monitoring interval."
}

credit_policy_revision

Listed in this schema’s required array.

Declared type
"string"
Reading definition for credit_policy_revision
{
  "type": "string",
  "minLength": 1,
  "maxLength": 200,
  "x-profile-maxLength": "string_characters_max"
}

funding_expiry_rule

Listed in this schema’s required array.

Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for funding_expiry_rule
{
  "const": "duration_eligible_then_earliest_expiry",
  "description": "Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints."
}

eligible_funding_kinds

Listed in this schema’s required array.

Declared type
"array"
Reading definition for eligible_funding_kinds
{
  "type": "array",
  "items": {
    "type": "string",
    "enum": [
      "base",
      "top_up",
      "service_adjustment",
      "sponsored"
    ],
    "x-profile-maxLength": "string_characters_max"
  },
  "minItems": 1,
  "maxItems": 4,
  "x-profile-maxItems": "collection_items_max"
}

free_research_requires_sponsored_pool

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for free_research_requires_sponsored_pool
{
  "const": true
}

offer_binding

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for offer_binding
{
  "$ref": "#/components/schemas/OfferBinding"
}

resolved_policy

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for resolved_policy
{
  "$ref": "#/components/schemas/ResolvedOfferPolicy"
}

included_update_coverage

Listed in this schema’s required array.

The base API explicitly selects none. contract_scheduled cannot be published or sold until a separately qualified contracted-schedule record, covered-set/baseline and finite closure/retention model exist and the offer binds them. No such launch scheduling generation is qualified here. AssessmentPlan is a per-quote assessment/price plan, not that contractual obligation. Short acquisition receipts never implement annual/endpoint obligations. A separately qualified contracted-schedule, covered-set, baseline and finite closure/retention model must govern any future scheduled service; no automatic scheduler, seven-day default or recurring charge.

Declared type
"object"
Reading definition for included_update_coverage
{
  "type": "object",
  "additionalProperties": false,
  "properties": {
    "mode": {
      "enum": [
        "none",
        "contract_scheduled"
      ]
    },
    "coverage_seconds": {
      "type": "integer",
      "minimum": 0,
      "maximum": 7776000
    },
    "schedule_policy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PolicyPin"
        },
        {
          "type": "null"
        }
      ]
    }
  },
  "required": [
    "mode",
    "coverage_seconds",
    "schedule_policy"
  ],
  "allOf": [
    {
      "if": {
        "properties": {
          "mode": {
            "const": "none"
          }
        }
      },
      "then": {
        "properties": {
          "coverage_seconds": {
            "const": 0
          },
          "schedule_policy": {
            "type": "null"
          }
        }
      },
      "else": {
        "properties": {
          "coverage_seconds": {
            "type": "integer",
            "minimum": 1,
            "maximum": 7776000
          },
          "schedule_policy": {
            "$ref": "#/components/schemas/PolicyPin"
          }
        }
      }
    }
  ],
  "description": "The base API explicitly selects none. contract_scheduled cannot be published or sold until a separately qualified contracted-schedule record, covered-set/baseline and finite closure/retention model exist and the offer binds them. No such launch scheduling generation is qualified here. AssessmentPlan is a per-quote assessment/price plan, not that contractual obligation. Short acquisition receipts never implement annual/endpoint obligations. A separately qualified contracted-schedule, covered-set, baseline and finite closure/retention model must govern any future scheduled service; no automatic scheduler, seven-day default or recurring charge."
}

Schema reading view

Read all retained constraints, including any allOf, oneOf, anyOf, conditional and additional-property constraints. The field list does not combine branches. Explicitly marked private-only omissions mean this view is not an executable substitute for the original schema or a released contract.

{
  "type": "object",
  "properties": {
    "offer": {
      "$ref": "#/components/schemas/ICVersionRef"
    },
    "tariff_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "terms_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "unit": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "x-profile-maxLength": "string_characters_max"
    },
    "unit_scale": {
      "type": "integer",
      "minimum": 1
    },
    "standards": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ICStandardRate"
      },
      "minItems": 1,
      "maxItems": 2,
      "x-profile-maxItems": "collection_items_max"
    },
    "bundles": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/ICBundleRate"
      },
      "minItems": 0,
      "maxItems": 8,
      "x-profile-maxItems": "collection_items_max"
    },
    "availability": {
      "type": "string",
      "enum": [
        "available",
        "not_ready",
        "not_entitled"
      ],
      "x-profile-maxLength": "string_characters_max"
    },
    "allowed_research_modes": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "existing_only",
          "held_or_known_site",
          "bounded_discovery"
        ],
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 1,
      "maxItems": 3,
      "x-profile-maxItems": "collection_items_max"
    },
    "maximum_entities": {
      "type": "integer",
      "minimum": 1,
      "maximum": 1000,
      "description": "Structural request maximum, also constrained by the disclosed effective response-byte bound and actual content across released adapters. A count alone never guarantees fit. Oversize returns structured reduction guidance before paid work; no silent truncation."
    },
    "maximum_order_seconds": {
      "type": "integer",
      "minimum": 1,
      "description": "Maximum integer seconds from original quote.created_at to latest_accounting_at, including settlement margin. Quote producer derives the accounting deadline from requested latest_completion_at and its required margin and refuses the request if that derived latest_accounting_at exceeds created_at+maximum_order_seconds, using existing invalid_request/400, field latest_completion_at, usage_state=not_started. No grant may be backdated after its original accounting deadline."
    },
    "quote_valid_seconds": {
      "type": "integer",
      "minimum": 1
    },
    "result_access_seconds": {
      "type": "integer",
      "minimum": 1,
      "description": "result_access_seconds is measured from this original acquisition.granted_at. Its access_valid_until is the minimum of granted_at plus the accepted original offer duration and all earlier original result/source-rights, deletion and other lawful validity cutoffs. A repeat read or reuse of the same acquisition never renews that stored deadline. Existing access_valid_until values are never extended by this clarification. A new paid acquisition, if separately admitted, uses its own accepted original terms; no automatic refresh or new acquisition is created. Incremental recognition still checks the prior acquisition's actual access_valid_until, so an earlier lawful cutoff can end eligibility within the maximum advertised window."
    },
    "receipt_access_seconds": {
      "type": "integer",
      "minimum": 1,
      "description": "Original receipt access duration, still subject to lawful earlier deletion. For positive incremental windows only, must cover maximum_order_seconds+upgrade_valid_seconds; does not authorise retaining prohibited joins."
    },
    "upgrade_valid_seconds": {
      "type": "integer",
      "minimum": 0,
      "description": "Optional half-open incremental eligibility from original acquisition granted_at to granted_at+this duration, checked at dependent acceptance commit. Zero offers no window. Positive values require upgrade<=result_access_seconds and maximum_order_seconds+upgrade<=min(receipt_access_seconds,90*86400). Earlier rights loss, deletion, proved basis change or pending financial review can end eligibility; quotes disclose no private hold cause. This is not a refresh/monitoring interval."
    },
    "credit_policy_revision": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "x-profile-maxLength": "string_characters_max"
    },
    "funding_expiry_rule": {
      "const": "duration_eligible_then_earliest_expiry",
      "description": "Exclude grants whose original expiry is at or before latest_accounting_at, then allocate earliest-expiring otherwise eligible grants with funding ID tie break. Preserve original expiry, scope and paid-service constraints."
    },
    "eligible_funding_kinds": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "base",
          "top_up",
          "service_adjustment",
          "sponsored"
        ],
        "x-profile-maxLength": "string_characters_max"
      },
      "minItems": 1,
      "maxItems": 4,
      "x-profile-maxItems": "collection_items_max"
    },
    "free_research_requires_sponsored_pool": {
      "const": true
    },
    "offer_binding": {
      "$ref": "#/components/schemas/OfferBinding"
    },
    "resolved_policy": {
      "$ref": "#/components/schemas/ResolvedOfferPolicy"
    },
    "included_update_coverage": {
      "type": "object",
      "additionalProperties": false,
      "properties": {
        "mode": {
          "enum": [
            "none",
            "contract_scheduled"
          ]
        },
        "coverage_seconds": {
          "type": "integer",
          "minimum": 0,
          "maximum": 7776000
        },
        "schedule_policy": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/PolicyPin"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "required": [
        "mode",
        "coverage_seconds",
        "schedule_policy"
      ],
      "allOf": [
        {
          "if": {
            "properties": {
              "mode": {
                "const": "none"
              }
            }
          },
          "then": {
            "properties": {
              "coverage_seconds": {
                "const": 0
              },
              "schedule_policy": {
                "type": "null"
              }
            }
          },
          "else": {
            "properties": {
              "coverage_seconds": {
                "type": "integer",
                "minimum": 1,
                "maximum": 7776000
              },
              "schedule_policy": {
                "$ref": "#/components/schemas/PolicyPin"
              }
            }
          }
        }
      ],
      "description": "The base API explicitly selects none. contract_scheduled cannot be published or sold until a separately qualified contracted-schedule record, covered-set/baseline and finite closure/retention model exist and the offer binds them. No such launch scheduling generation is qualified here. AssessmentPlan is a per-quote assessment/price plan, not that contractual obligation. Short acquisition receipts never implement annual/endpoint obligations. A separately qualified contracted-schedule, covered-set, baseline and finite closure/retention model must govern any future scheduled service; no automatic scheduler, seven-day default or recurring charge."
    }
  },
  "required": [
    "offer",
    "tariff_revision",
    "terms_revision",
    "unit",
    "unit_scale",
    "standards",
    "bundles",
    "availability",
    "allowed_research_modes",
    "maximum_entities",
    "maximum_order_seconds",
    "quote_valid_seconds",
    "result_access_seconds",
    "receipt_access_seconds",
    "upgrade_valid_seconds",
    "credit_policy_revision",
    "funding_expiry_rule",
    "eligible_funding_kinds",
    "free_research_requires_sponsored_pool",
    "offer_binding",
    "resolved_policy",
    "included_update_coverage"
  ],
  "additionalProperties": false,
  "description": "Caller-permitted immutable offer; no source inventory, supplier prices, payment methods or autonomous purchase. Values are published only after the private qualification gate. Zero-unit funded evaluation is explicitly sponsored, not a production price. In this generation a non-available contract_scheduled shape is an explicitly unavailable informational candidate, not commercial publication, a buyable offer or an accepted update promise. Publishing/acceptance remains prohibited until its separate contract/baseline/closure qualification; basic mode none is unchanged.",
  "allOf": [
    {
      "if": {
        "properties": {
          "availability": {
            "const": "available"
          }
        },
        "required": [
          "availability"
        ]
      },
      "then": {
        "properties": {
          "included_update_coverage": {
            "properties": {
              "mode": {
                "const": "none"
              }
            }
          }
        }
      }
    }
  ],
  "x-incremental-window-qualification": {
    "applies_when": "upgrade_valid_seconds > 0",
    "all": [
      "upgrade_valid_seconds <= result_access_seconds",
      "maximum_order_seconds + upgrade_valid_seconds <= min(receipt_access_seconds, 7776000)"
    ],
    "zero": "No incremental window; no new maximum-order constraint.",
    "enforcement": "Private offer compiler before publication and acceptance, using integer arithmetic; not a JSON Schema cross-field arithmetic claim."
  }
}

Related schemas

All API operations