ENTITY developer reference
SubscriptionUsage
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.
current_offer_id
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for current_offer_id
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
}current_offer_version
Listed in this schema’s required array.
- Declared type
"integer"
Reading definition for current_offer_version
{
"type": "integer",
"minimum": 1
}tariff_version
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for tariff_version
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
}full_monthly_included_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for full_monthly_included_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
}period_initial_granted_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for period_initial_granted_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
}period_upgrade_granted_units
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for period_upgrade_granted_units
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
}pending_change_status
Listed in this schema’s required array.
- Declared type
"string"
Reading definition for pending_change_status
{
"type": "string",
"enum": [
"none",
"payment_pending",
"payment_action_required",
"reconciling",
"activating",
"scheduled",
"refund_required"
],
"x-profile-maxLength": "string_characters_max"
}next_offer_id
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for next_offer_id
{
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}next_offer_version
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for next_offer_version
{
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
}next_monthly_included_units
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for next_monthly_included_units
{
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}next_effective_at
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for next_effective_at
{
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}recovery_path
Listed in this schema’s required array.
- Declared type
- Not declared directly; consult the complete field definition.
Reading definition for recovery_path
{
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}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": {
"current_offer_id": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
"current_offer_version": {
"type": "integer",
"minimum": 1
},
"tariff_version": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
"full_monthly_included_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
},
"period_initial_granted_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
},
"period_upgrade_granted_units": {
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max",
"maxLength": 30
},
"pending_change_status": {
"type": "string",
"enum": [
"none",
"payment_pending",
"payment_action_required",
"reconciling",
"activating",
"scheduled",
"refund_required"
],
"x-profile-maxLength": "string_characters_max"
},
"next_offer_id": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"next_offer_version": {
"anyOf": [
{
"type": "integer",
"minimum": 1
},
{
"type": "null"
}
]
},
"next_monthly_included_units": {
"anyOf": [
{
"type": "string",
"pattern": "^(0|[1-9][0-9]*)$",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"next_effective_at": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
},
"recovery_path": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 200,
"x-profile-maxLength": "string_characters_max"
},
{
"type": "null"
}
]
}
},
"required": [
"current_offer_id",
"current_offer_version",
"tariff_version",
"full_monthly_included_units",
"period_initial_granted_units",
"period_upgrade_granted_units",
"pending_change_status",
"next_offer_id",
"next_offer_version",
"next_monthly_included_units",
"next_effective_at",
"recovery_path"
]
}