Sustema

ENTITY developer reference

OfferPolicyPins

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.

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.

tariff

Listed in this schema’s required array.

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

terms

Listed in this schema’s required array.

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

credit

Listed in this schema’s required array.

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

refresh

Listed in this schema’s required array.

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

retrieval

Listed in this schema’s required array.

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

eligibility

Listed in this schema’s required array.

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

protection

Listed in this schema’s required array.

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

rights

Listed in this schema’s required array.

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

success

Listed in this schema’s required array.

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

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": {
    "tariff": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "terms": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "credit": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "refresh": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "retrieval": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "eligibility": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "protection": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "rights": {
      "$ref": "#/components/schemas/PolicyPin"
    },
    "success": {
      "$ref": "#/components/schemas/PolicyPin"
    }
  },
  "required": [
    "tariff",
    "terms",
    "credit",
    "refresh",
    "retrieval",
    "eligibility",
    "protection",
    "rights",
    "success"
  ]
}

Related schemas

All API operations