Account and partner response objects

These definitions describe grouped resource summaries, purchases, users, event passes and partner cascade access, including their conditional relationships. A missing relationship may be null or omitted as stated. Do not assume stored values are converted to another type unless a conversion is stated. Common response rules apply.

Grouped resources

Subscription/purchase/transaction summary pages use items with one wrapper object containing resources. The outer paginator counts resources.

FieldType / presenceMeaning and conditions
itemsarray with one wrapper objectContains resources even when that array is empty.
items[].resourcesarraySelected active resources of active related partners within the selected resource’s partner.
resources[].idintegerResource record identifier.
resources[].title, .key, .hoststored strings / nullable textDisplay name, public resource key and configured host.
resources[].plansarray; subscription summary onlyMembership summaries below.
resources[].purchasesarray; purchase summary onlyPurchase records; unpaginated inside each resource.
resources[].transactionsarray; transaction summary onlyTransaction records; unpaginated inside each resource.

Membership summary

Under resources[].plans; this is different from a catalog Pricing.

FieldType / presenceMeaning and conditions
idintegerPlan ID.
title, slug, descriptionstored string / nullable textPlan name, label and description.
subscriptionobjectMembership summary: id (integer Pricing ID), title (stored text), expiration_date (nullable timestamp) and autorenew (boolean). No active-membership-only filter is promised.

Transaction

Under resources[].transactions. Monetary units and timestamp timezone are unspecified.

FieldType / presenceMeaning and conditions
idintegerTransaction ID.
datetimestamp stringTransaction creation time.
amountintegerStored transaction amount; no currency conversion.
amount_refundedintegerStored refunded amount.
currencystored stringCurrency code.
cardstring / nullCard last four digits when available; not the full card number.
typestring / nullCard brand, not a generic transaction category.
pay_systemstored stringPayment-system label, such as stripe.
statusstored stringPayment status. succeeded, free and manual are treated as successful by the source; requires_source_action requires further source authentication. This is not a complete status enum, nor an authorization to perform a payment action.

Purchase

Every record includes the base fields and item/relation below. Additional fields depend on item_type and whether the referenced record exists.

FieldType / presenceMeaning and conditions
id, item_idintegerPurchase ID and purchased record ID.
item_typestringPurchased category; recognized projections include content, subscription, bundle and ti_event_ticket_pass. Not a complete enum promise.
item_keystringResolved content key for content; string form of item_id otherwise.
discount, price, amountintegerStored discount, price and subtotal amount respectively; units unspecified.
currencystringStored currency code.
created_attimestamp stringPurchase creation time.
processing_fee_wallkit, processing_fee_paymentstored numeric / nullableRecorded platform/payment fees; no unit or recalculation guarantee.
processing_vatstored numeric / nullableRecorded VAT value.
processing_taxes_json_datadecoded JSON or stored value / nullableFetched string tax data is decoded only when neither empty nor "0". Empty strings and the string "0" remain unchanged; no fixed property schema.
relation_modelstored string / nullableRelationship category used to select relation.
relation_idstored numeric / nullableRelated record ID.
itemobject / nullContent: base content; subscription: general Pricing; bundle: id, title, price, currency, created_at (stored values); ticket pass: expanded pass. Unknown/missing item can be null.
relationobject / nullMembership relationship or sponsored subscription; unrecognized relationship is null.
item_titlestored string / nullable; conditionalContent/bundle title, or combined plan+Pricing/event+ticket title when referenced records exist.
extradecoded value / empty object; fetched content onlySame extra projection as fetched content; no fixed property schema.
subscription_typestored string; subscription onlyPricing type when Pricing exists.
planobject; subscription onlyid and title of the Pricing’s plan (stored values).
subscriptionobject; subscription with membership onlysubscription_start_date, subscription_end_date (nullable timestamps), autorenew (stored flag; no explicit conversion).
TiEvent, TiEventTicket, TiEventTicketPassobjects; ticket-pass with event onlyEvent, ticket without ti_event, and base pass without owner/assign/ticket expansion.

Purchase content

Purchase item for content uses the base content projection: fields below; it does not add id, VAT, content_type or taxonomies.

FieldType / presenceMeaning and conditions
key, title, description, price, currency, extra, link, created_at, updated_at, published_at, images, is_payable_contentsame types/meaning as content with term arraysExactly these base fields; image objects use that definition.

Membership relationship

Purchase relation for a UserPlanRelationships record uses these stored fields; do not infer all are cast booleans/integers.

FieldType / presenceMeaning and conditions
id, parent_id, user_id, admin_id, plan_id, subscription_id, team_idstored numeric IDs / nullable referencesRelationship, hierarchy, identity, plan, Pricing and team references.
subscription_end_datetimestamp / nullMembership expiration.
is_team_subscription, autorenew, is_trial, is_allowed_next_subscriptionstored flagsTeam membership, renewal choice, trial and next-Pricing permission.
sponsored_subscription_id, sponsored_subscription_slot_idstored numeric / nullSponsorship and slot references.
created_attimestamp stringRelationship creation time.

Purchase relation for sponsored_subscriptions. Missing appended relationships are null; an incomplete mapping can omit later additions.

FieldType / presenceMeaning and conditions
id, sponsor_id, subscription_idstored numeric IDsSponsorship, sponsoring user and Pricing.
title, descriptionstored strings / nullableSponsorship display text.
is_paying_by_sponsorbooleanSelects the sponsor as payer; does not prove that payment was collected.
activated_at, expired_attimestamp / nullableActivation and expiration times.
created_at, updated_attimestamp stringsRecord times.
subscription_end_datetimestamp / nullRelated membership expiration, or null.
autorenew, is_allowed_next_subscription, is_trialstored flags / nullRelated membership settings, or null without a relationship.
sponsorfull user / nullSponsoring user.
subscriptiongeneral Pricing / nullSponsored Pricing.
slotsarrayEach slot has id, sponsored_subscription_id, recipient_id (stored numeric/null), recipient_email, activation_code (stored string/null), activated_id (stored reference/null), activated_at (nullable timestamp), created_at, updated_at (timestamps), recipient (full user/null). No nested sponsored_subscription is added in this slot projection.

User

Nested purchase sponsor/recipient uses the full projection; pass owner/assign uses the short projection. Stored contact text can be null. These are returned data, not fields required by the request.

FieldType / presenceMeaning and conditions
idstored integerUser ID.
emailstring / nullable stored textEmail address; decoded in full projection.
first_name, last_namestring / nullableUser name.
company, jobstring / nullableCompany and occupation.
country, city, address, state, zipstring / nullableStored address details.
phone, facebook_id, google_idstring / nullableContact/social identifiers.
photosmap / empty arrayPhoto slug or image-size key to URL; may use configured fallback image URLs.
nick_namestring / nullable; full onlyStored nickname.
created_at, updated_attimestamp strings; full onlyUser record times.
active, confirmboolean; full onlyResolved activation and confirmation state. With resource context, active means the relationship is neither suspended nor locked and confirm resolves its confirmation flag; global user state applies without a relationship.
extradynamic object; full onlyResource extra properties; empty object without resource-specific context.
uid, user_resource_created_atstring / null; full onlyResource UID and resource relationship creation time; null without resource context.
languageobject / null; full onlyResource-language record; nested purchase getUser has no resource argument, so null here.
lockedstored flag / false; full onlyResource lock state; false without resource context.
can_own_teamsboolean; full onlyComputed team ownership capability.
last_activity_datetimestamp / null; full onlyLast recorded session activity.
onlinesource-derived activity flag; full onlyActivity indicator; do not use as a live presence or access guarantee.
settings, roleraw settings / null and string; admin context, full onlyConditional resource settings and role; no fixed settings schema. Nested purchase user has no resource argument, so settings can be null.

Event

Cascade applied_ti_event and purchase TiEvent use this base event projection.

FieldType / presenceMeaning and conditions
idstored integerEvent ID.
slug, title, descriptionstored string / nullableEvent label and display text.
location, timezonestored string / nullableLocation and configured timezone; timestamps below have no universal UTC guarantee.
registration_page, url, contact_emailstored string / nullableRegistration page, event link and contact address.
statusstored stringEvent status; no closed enum here.
start_date, end_datetimestamp / nullableEvent schedule.
active, is_virtualstored flagsActivation and virtual-event settings.
photoarrayMedia objects with slug and url (stored strings); empty when none.

Event ticket

Cascade source_ti_event_ticket and expanded pass ticket include ti_event; purchase TiEventTicket base does not.

FieldType / presenceMeaning and conditions
id, ti_event_idstored numeric IDsTicket and event identifiers.
title, slug, descriptionstored string / nullableTicket display text and label.
quantity, min_quantity_order, max_quantity_orderstored numeric / nullableConfigured stock/order quantities.
pricestored numericStored ticket price; units unspecified.
currencystored stringCurrency code.
statusstored stringConfigured ticket status; no closed enum.
start_date, end_datetimestamp / nullableTicket availability schedule.
is_private, active, is_applied_vatstored flagsVisibility, activation and VAT settings; no explicit boolean cast guaranteed here.
vat_percentstored number / nullableConfigured VAT percentage.
extradecoded JSON value / nullableTicket-defined extra data.
ti_eventevent; expanded/cascade onlyParent event; absent in base purchase TiEventTicket.

Event pass

Purchase TiEventTicketPass uses base fields. Purchase item for a pass uses expanded fields too.

FieldType / presenceMeaning and conditions
id, owner_id, assign_idstored numeric / nullable referencesPass, owning user and assigned user.
extrastored extra value / nullablePass-defined additional data.
activestored flagActivation setting.
owner, assignshort user / null; expanded onlyOwner and assigned recipient.
ti_event_ticketexpanded ticket / null; expanded onlyTicket including its event when available. No auth_link is added by these selected projections.

Cascade access

Top-level plan and event matches; cached/helper-level failure can also produce empty values, so absence is not a detailed diagnostic.

FieldType / presenceMeaning and conditions
cascade_access_planobject / nullAt most one match; applied_plan (plan), source_resource (source resource), source_subscription (general Pricing).
cascade_access_ti_eventarrayAt most 100 entries, no caller paging or guaranteed selection order. Each has applied_ti_event (event), source_resource, source_ti_event_ticket (expanded ticket).

Source resource

Cascade uses the resource projection without a partner object.

FieldType / presenceMeaning and conditions
title, key, hoststored string / nullableDisplay name, public key and configured host.
activestored flagActivation setting.
created_attimestamp stringCreation time.
logoURL string / nullResource logo, or null when none exists.

Full diagram

Use the arrow keys to scroll. Escape closes this view.

Search documentation

Enter at least 2 characters.

    ↑ ↓ move through results · Enter opens · Escape closes