Sustema

ENTITY developer reference

OutcomeTariffs

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.

Exact resolved single/bundle prices are carried by existing IC standards/bundles and each quote outcome_prices. These pins identify the schedules used; refresh charges may differ by qualified outcome. No provider-attempt fee.

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.

initial_per_standard_policy

Listed in this schema’s required array.

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

initial_bundle_policy

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for initial_bundle_policy
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/PolicyPin"
    },
    {
      "type": "null"
    }
  ]
}

refresh_changed_per_standard_policy

Listed in this schema’s required array.

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

refresh_unchanged_per_standard_policy

Listed in this schema’s required array.

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

refresh_bundle_policy

Listed in this schema’s required array.

Declared type
Not declared directly; consult the complete field definition.
Reading definition for refresh_bundle_policy
{
  "anyOf": [
    {
      "$ref": "#/components/schemas/PolicyPin"
    },
    {
      "type": "null"
    }
  ]
}

failed_or_unqualified_units

Listed in this schema’s required array.

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

reused_owned_units

Listed in this schema’s required array.

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

retrieval_starts_refresh

Listed in this schema’s required array.

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

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",
  "additionalProperties": false,
  "properties": {
    "initial_per_standard_policy": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "initial_bundle_policy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PolicyPin"
        },
        {
          "type": "null"
        }
      ]
    },
    "refresh_changed_per_standard_policy": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "refresh_unchanged_per_standard_policy": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "refresh_bundle_policy": {
      "anyOf": [
        {
          "$ref": "#/components/schemas/PolicyPin"
        },
        {
          "type": "null"
        }
      ]
    },
    "failed_or_unqualified_units": {
      "const": "0"
    },
    "reused_owned_units": {
      "const": "0"
    },
    "retrieval_starts_refresh": {
      "const": false
    }
  },
  "required": [
    "initial_per_standard_policy",
    "initial_bundle_policy",
    "refresh_changed_per_standard_policy",
    "refresh_unchanged_per_standard_policy",
    "refresh_bundle_policy",
    "failed_or_unqualified_units",
    "reused_owned_units",
    "retrieval_starts_refresh"
  ],
  "description": "Exact resolved single/bundle prices are carried by existing IC standards/bundles and each quote outcome_prices. These pins identify the schedules used; refresh charges may differ by qualified outcome. No provider-attempt fee."
}

Related schemas

All API operations