Sponsorship and slot projections

A sponsorship record connects sponsor, configured publisher Pricing and slots. It is not the Pricing ID or an individual membership record. All timestamps are stored strings/null with no timezone guarantee. If response mapping fails, it can return an object with missing fields or []. The fields below describe the intended response; a complete object is not guaranteed.

Sponsorship record with membership summary

FieldType / presenceMeaning
idstored integerSponsorship record ID.
sponsor_idstored integer / nullPaying/owning sponsor person ID.
subscription_idstored integer / nullConfigured publisher Pricing ID, not membership ID.
title, descriptionstored string / nullSponsorship display text.
is_paying_by_sponsorboolean after fetch/saveStored payer-selection flag; not a charge/refund receipt.
activated_at, expired_attimestamp / nullParent stored markers, not proof of every slot’s access.
created_at, updated_attimestamp stringsParent record times.
subscription_end_datetimestamp / nullFirst membership found by sponsorship ID; null without one.
autorenew, is_allowed_next_subscription, is_trialstored flags / nullFirst associated membership’s renewal/next-Pricing/trial values, null without one. No ordering or per-slot guarantee.

Expanded sponsor record

Sponsorship record with membership summary plus:

FieldType / presenceMeaning
sponsorfull user / nullSponsor serialized without resource argument.
subscriptiongeneral Pricing / nullCatalog choice, not an attached membership object.
slotsarray, [] possibleBase slot plus recipient as full user/null. No nested sponsored_subscription inside these embedded slots.

Base slot

FieldType / presenceMeaning
idstored integerSlot ID.
sponsored_subscription_idstored integer / nullParent sponsorship ID.
recipient_idstored integer / nullBound recipient person ID; email alone is distinct.
recipient_emailstored string / nullInvitation contact. Not verified identity proof.
activation_codestored string / nullSlot activation credential; protect separately from session tokens.
activated_attimestamp / nullStored activation marker.
activated_iddeployment-dependent, optionalSerializer requests this attribute, but pinned model declares no such property; presence/type not established. Never substitute for recipient_id.
created_at, updated_attimestamp stringsSlot record times.

Sponsor slot list/detail/invitation/clear use this base slot: no recipient user or nested parent expansion.

Recipient invitation slot

Base slot plus sponsored_subscription: sponsorship record with membership summary, sponsor and subscription, without slots; null if parent relation is absent. No recipient expansion.

Expanded recipient slot

Base slot plus recipient (full user/null, without resource context) and sponsored_subscription as in the recipient invitation slot (no nested slots). Activation and sponsor-payment-off use this projection.

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