Zum Hauptinhalt springen

Datenexportregister

Dieses öffentliche Register beschreibt die Kundendaten, die Terminaro übertragen kann, die dafür verwendete maschinenlesbare Schnittstelle und die Grenzen, die empfangende Provider berücksichtigen müssen.

Informationen nach Artikel 26 der Verordnung (EU) 2023/2854 (Data Act). Dieses Register beschreibt den implementierten Dienst; es enthält keine Aussage darüber, ob ein bestimmter Export rechtlich ausreichend ist.

Umfang des Registers

Das Register umfasst übertragbare Daten, die der Geschäftskunde bereitgestellt hat oder die durch seine Nutzung von Terminaro entstanden sind. Die genauen Felder auf oberster Ebene, ihre JSON-Strukturen und Auslassungsregeln stammen aus demselben Katalog wie die Exportimplementierung.

Ein Feld mit der Kennzeichnung, dass es bei fehlendem Wert ausgelassen wird, erscheint nicht mit einem erfundenen Nullwert. Arrays geben ihre Kardinalität und Zeitstempel ihre Einheit an; interne Rohkennungen werden durch opake Referenzen ersetzt.

Exportierbare Datenkategorien

Die folgenden Ressourcendeklarationen ergeben sechs exportierbare Kategorien. Ihre Feldtabellen bilden das detaillierte Verzeichnis.

  • Konto und Profilaccount
  • Verfügbarkeitavailability
  • Buchungenbookings
  • Kalenderverbindungencalendar_sources
  • E-Mail-Vorlagenemail_templates
  • Teams und Teambuchungenteams

Ausgeschlossene Daten

Der Exportkatalog verwendet sieben abschließende Ausschlussgründe. Sie verhindern, dass Geheimnisse, interne Betriebsdaten und Daten außerhalb der Kontrolle des Kunden die Übertragungsgrenze überschreiten.

  • internal_identifier Rohe Datenbankkennungen bleiben ausgeschlossen. Exportierte Beziehungen verwenden stattdessen deterministische opake Referenzen.
  • legacy_unused Nicht mehr verwendete Altspeicher, die kein Produktionspfad liest oder schreibt, sind nicht Teil des Exports.
  • operational_state Warteschlangen, Leases, Wiederholungszustände, Zustelldiagnosen und andere vorübergehende Betriebszustände bleiben ausgeschlossen.
  • other_data_subject Daten unter der Kontrolle eines anderen Kunden oder Daten, die ausschließlich zu einer anderen betroffenen Person gehören, sind nicht enthalten.
  • provider_internal Nur für den Anbieter bestimmte Verwaltungs- und interne Geschäftsdaten, die keine Kundendaten sind, bleiben ausgeschlossen.
  • secret_material Passwörter, Passwort-Prüfwerte, Authentifizierungsgeheimnisse und Zugangsdaten für verbundene Dienste werden nicht exportiert.
  • service_integrity Sitzungsdaten, einmalig nutzbare Zugangsdaten und Schutzmechanismen zur Missbrauchsabwehr verbleiben im Dienst.

Historische Beziehungen können fehlen, wenn ihr Ziel vor dem Export gelöscht wurde. Bereits versendete Stornierungs-, Umbuchungs- sowie iCal- oder Feed-Links funktionieren nach einer Übertragung nicht mehr, weil der Export nur ihre Prüfwerte enthält, niemals die zu ihrer Nutzung erforderlichen Geheimnisse im Klartext.

Aufbewahrung, Entgelte und Wechselzeiträume

Terminaro erhebt für den Datenexport oder die Übertragung an einen Provider kein Entgelt. Eine gültige autorisierte API-Anfrage beginnt sofort mit der Datenübertragung. Bei einem gewöhnlichen vertraglichen Wechsel folgt auf eine Ankündigungsfrist von bis zu zwei Monaten ein Übergangszeitraum von bis zu 30 Kalendertagen.

Kann ein Wechsel technisch nicht innerhalb von 30 Kalendertagen abgeschlossen werden, kann das vertragliche Verfahren für technische Ausnahmen den Übergang um die erforderliche Zeit verlängern, höchstens jedoch auf sieben Monate.

Buchungen werden nach ihrem Ende 90 Tage lang gespeichert. Für stornierte Team-Buchungen gilt der Stornierungszeitpunkt, für andere Team-Buchungen deren Endzeitpunkt. Ein Export enthält die Datensätze, die beim Start des begrenzten Abrufs noch vorhanden sind, keine dauerhafte Kontohistorie.

Übertragungsschnittstelle

Die Ressourcen-API wird unter https://actions.terminaro.eu bereitgestellt. Jede deklarierte Ressource verwendet POST und sendet ein JSON-Objekt als text/plain-Anfrageinhalt. Zugangsdaten und Cursor bleiben dadurch aus URLs heraus.

Bevor der Inhalt gelesen wird, ist ein dezimaler Content-Length-Header erforderlich. Der angegebene und gemessene Inhalt darf höchstens 4096 Byte groß sein. Ein leerer Inhalt startet mit den Standardwerten.

POST /api/export/v1/account HTTP/1.1
Content-Type: text/plain
Content-Length: 16
x-terminaro-export-ticket: <ticket>

{"pageSize":100}

Authentifizierung und Anfragengrenzen

Jede Anfrage muss genau einen Zugangsnachweis senden: entweder ein Terminaro-Paging-Ticket in x-terminaro-export-ticket oder ein Token des empfangenden Providers in x-terminaro-export-token. Anfragen ohne Zugangsnachweis oder mit beiden Nachweisen werden abgelehnt.

Ein Paging-Ticket gilt 15 Minuten lang und für höchstens 200 Anfragen. Eine Nutzung wird verbraucht, bevor Zeilen gelesen werden. Daher können sowohl eine später fehlgeschlagene Anfrage als auch der erneute Client-Versuch jeweils eine Nutzung verbrauchen. Das Paging-Ticket unterscheidet sich vom einmalig nutzbaren Ticket für den Browser-Download.

Provider-Tokens haben den festen Geltungsbereich data-export:read:v1. Standardmäßig gelten sie 30 Tage, sie können für höchstens 90 Tage ausgestellt werden und sind auf drei aktive Tokens pro Kunde begrenzt.

Provider-Tokens sind Server-zu-Server-Zugangsdaten und dürfen nicht in Browsercode, eine öffentliche Seite oder eine URL eingebettet werden. Kunden sollten Einstellungen → Datenexport prüfen und Terminaro kontaktieren, falls dort kein Token ausgestellt werden kann. Das öffentliche Register und der eigene Download des Kunden bleiben unabhängig davon verfügbar.

Provider-Anfragen sind in jedem Fünf-Minuten-Zeitraum auf 120 Anfragen pro Token und 300 Anfragen pro Kunde begrenzt. Eine begrenzte Antwort enthält Retry-After.

Antworten und Fehler

  • 200 gibt einen Ressourcen-Umschlag zurück.
  • 400 bedeutet, dass die angegebene Länge, der JSON-Inhalt, der Cursor oder die Seitengröße nicht akzeptiert werden konnte.
  • 401 ist dieselbe allgemeine Ablehnung für fehlende, widersprüchliche, unbekannte, abgelaufene, ausgeschöpfte oder unpassende Zugangsdaten.
  • 429 meldet eine Anfragengrenze für Provider und enthält Retry-After.
  • 500 meldet einen bereinigten internen Fehler. Fehlerantworten verwenden { "error": "…" }.
  • OPTIONS antwortet beim unterstützten Cross-Origin-Preflight mit 204.

Paginierung, Konsistenz und Schema-Unterstützung

Die optionalen Anfragefelder sind cursor und pageSize. Die Seitengröße beträgt standardmäßig 100 und akzeptiert ganze Zahlen bis 500. Die account-Ressource kann unabhängig von der angeforderten Größe höchstens zwei Quellzeilen pro Seite zurückgeben.

Jede Antwort enthält category, continueCursor, frozenAt, isDone, page, resource, schemaVersion. Einzelressourcen werden mit einer Antwort abgeschlossen; paginierte Ressourcen können einen Cursor zurückgeben.

Eine leere Seite ist nicht zwangsläufig das Ende: team-bookings kann Teams ohne gespeicherte Buchungen durchlaufen und dennoch einen Cursor zurückgeben. Beenden Sie den Abruf erst, wenn isDone true und continueCursor null ist.

Cursor sind opak, aber nicht verschlüsselt. Übernehmen Sie sie unverändert.

frozenAt ist die Obergrenze für den Erstellungszeitpunkt von Datensätzen in einem begrenzten Abruf, keine Momentaufnahme der Datenbank. Später erstellte Datensätze sind ausgeschlossen; vorhandene Datensätze können zwischen zwei Seitenanfragen dennoch geändert oder gelöscht werden.

Die aktuelle Schema-Hauptversion ist 1. Sie steht sowohl im Endpunktpfad als auch in jedem Antwort-Umschlag.

Version 1 ist die erste Schema-Hauptversion. Daher gibt es keine vorherige Hauptversion und kein früheres Kompatibilitätsfenster.

Ressourcen und Felder

Die implementierte Übertragung deklariert derzeit 8 Ressourcen. Diese Tabellen werden aus der Deklaration und ihren vollständigen Feldmetadaten erzeugt.

Scrollen Sie horizontal durch die Tabellen, um alle Spalten zu sehen.

account

POST /api/export/v1/account · Konto und Profil · paginated

Exportfelder der Ressource account
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
customerSettingsbookingPageFallbackLanguagestringomitted_when_absentstringfalse
customerSettingsbookingUuidstringalwaysstringfalse
customerSettingscontractAudiencestringomitted_when_absentstringfalse
customerSettingscreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
customerSettingscurrentTermEndnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingsdataExportProviderTokenInstructionsarrayalwaysproviderTokenInstructionsfalse
  • zero_or_more
customerSettingsdisplayNamestringalwaysstringfalse
customerSettingsdpaAcceptedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingsdpaVersionstringomitted_when_absentstringfalse
customerSettingsdunningLevelnumberomitted_when_absentnumberfalse
customerSettingsemailstringalwaysstringfalse
customerSettingsemailFromstringomitted_when_absentstringfalse
customerSettingsentitlementsobjectomitted_when_absententitlementsfalse
customerSettingsfeedReminderMinutesarrayomitted_when_absentarrayOfNumbersfalse
  • zero_or_more
customerSettingshideCustomerNameInFeedbooleanomitted_when_absentbooleanfalse
customerSettingshideVisitorNamesInFeedbooleanomitted_when_absentbooleanfalse
customerSettingsidstringalwaysopaqueReferencefalse
customerSettingslanguagestringomitted_when_absentstringfalse
customerSettingslastSepaDebitAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingslegalImprintTextstringomitted_when_absentstringfalse
customerSettingslegalImprintUrlstringomitted_when_absentstringfalse
customerSettingslegalPrivacyTextstringomitted_when_absentstringfalse
customerSettingslegalPrivacyUrlstringomitted_when_absentstringfalse
customerSettingsonboardingCompletedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingspaymentGracePeriodEndsAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingspaymentMethodTypestringomitted_when_absentstringfalse
customerSettingsplanstringomitted_when_absentstringfalse
customerSettingsscheduledPlanChangeobjectomitted_when_absentscheduledPlanChangefalse
customerSettingsselfServiceRegisteredAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingsshowFreeSlotsInFeedbooleanomitted_when_absentbooleanfalse
customerSettingssourceTablestringalwaysstringfalse
customerSettingssubscriptionStatusstringomitted_when_absentstringfalse
customerSettingstermsAcceptedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingstermsVersionstringomitted_when_absentstringfalse
customerSettingsupdatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
customerSettingsuserRefstringomitted_when_absentopaqueReferencefalse
usercreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
userdisplayUsernamestringomitted_when_absentstringOrNulltrue
useremailstringalwaysstringfalse
useremailVerifiedbooleanalwaysbooleanfalse
useridstringalwaysopaqueReferencefalse
userimagestringomitted_when_absentstringOrNulltrue
usernamestringalwaysstringfalse
userphoneNumberstringomitted_when_absentstringOrNulltrue
userphoneNumberVerifiedbooleanomitted_when_absentbooleanOrNulltrue
usersourceTablestringalwaysstringfalse
userupdatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
useruserRefstringomitted_when_absentopaqueReferencefalse
userusernamestringomitted_when_absentstringOrNulltrue
legalAcceptancesacceptedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
legalAcceptancescustomerSettingsRefstringalwaysopaqueReferencefalse
legalAcceptancesdocumentstringalwaysstringfalse
legalAcceptancesidstringalwaysopaqueReferencefalse
legalAcceptancessourcestringalwaysstringfalse
legalAcceptancessourceTablestringalwaysstringfalse
legalAcceptancesversionstringalwaysstringfalse

availability

POST /api/export/v1/availability · Verfügbarkeit · single

Exportfelder der Ressource availability
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
customerSettingsavailabilityConfirmedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
customerSettingsbufferMinutesnumberalwaysnumberfalse
customerSettingsdaysAheadnumberalwaysnumberfalse
customerSettingsidstringalwaysopaqueReferencefalse
customerSettingsminLeadTimeMinutesnumberomitted_when_absentnumberfalse
customerSettingsslotDurationMinutesnumberalwaysnumberfalse
customerSettingssourceTablestringalwaysstringfalse
customerSettingstimeWindowsarrayalwaystimeWindowsfalse
  • zero_or_more
customerSettingstimezonestringalwaysstringfalse
customerSettingsuserRefstringomitted_when_absentopaqueReferencefalse
customerSettingsworkingDaysarrayalwaysarrayOfNumbersfalse
  • zero_or_more

bookings

POST /api/export/v1/bookings · Buchungen · paginated

Exportfelder der Ressource bookings
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
bookingscancelledAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
bookingscreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
bookingscustomerSettingsRefstringalwaysopaqueReferencefalse
bookingsendTimenumberalwaysunixMillisecondsfalse
  • unix_milliseconds
bookingsidstringalwaysopaqueReferencefalse
bookingsoriginalStartTimenumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
bookingspreviousStartTimenumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
bookingsreasonstringomitted_when_absentstringfalse
bookingsrescheduledAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
bookingssourceTablestringalwaysstringfalse
bookingsstartTimenumberalwaysunixMillisecondsfalse
  • unix_milliseconds
bookingsstatusstringalwaysstringfalse
bookingsteamBookingRefstringomitted_when_absentopaqueReferencefalse
bookingsteamMemberRefstringomitted_when_absentopaqueReferencefalse
bookingsvisitorCompanystringomitted_when_absentstringfalse
bookingsvisitorEmailstringalwaysstringfalse
bookingsvisitorLanguagestringalwaysstringfalse
bookingsvisitorNamestringalwaysstringfalse
bookingsvisitorPhonestringomitted_when_absentstringfalse
bookingsvisitorTimezonestringalwaysstringfalse

calendar-sources

POST /api/export/v1/calendar-sources · Kalenderverbindungen · paginated

Exportfelder der Ressource calendar-sources
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
calendarSourcescaldavCalendarUrlstringomitted_when_absentstringfalse
calendarSourcescaldavUrlstringomitted_when_absentstringfalse
calendarSourcescaldavUsernamestringomitted_when_absentstringfalse
calendarSourcescreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
calendarSourcescustomerSettingsRefstringalwaysopaqueReferencefalse
calendarSourcesenabledbooleanalwaysbooleanfalse
calendarSourcesgoogleAccountKeystringomitted_when_absentstringfalse
calendarSourcesgoogleCalendarIdstringomitted_when_absentstringfalse
calendarSourcesidstringalwaysopaqueReferencefalse
calendarSourceslabelstringalwaysstringfalse
calendarSourcessourceTablestringalwaysstringfalse
calendarSourcestypestringalwaysstringfalse

email-templates

POST /api/export/v1/email-templates · E-Mail-Vorlagen · single

Exportfelder der Ressource email-templates
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
customerSettingsemailTemplateAdminNotificationBodystringomitted_when_absentstringfalse
customerSettingsemailTemplateAdminNotificationBodyDestringomitted_when_absentstringfalse
customerSettingsemailTemplateAdminNotificationSubjectstringomitted_when_absentstringfalse
customerSettingsemailTemplateAdminNotificationSubjectDestringomitted_when_absentstringfalse
customerSettingsemailTemplateCancellationBodystringomitted_when_absentstringfalse
customerSettingsemailTemplateCancellationBodyDestringomitted_when_absentstringfalse
customerSettingsemailTemplateCancellationSubjectstringomitted_when_absentstringfalse
customerSettingsemailTemplateCancellationSubjectDestringomitted_when_absentstringfalse
customerSettingsemailTemplateVisitorConfirmationBodystringomitted_when_absentstringfalse
customerSettingsemailTemplateVisitorConfirmationBodyDestringomitted_when_absentstringfalse
customerSettingsemailTemplateVisitorConfirmationSubjectstringomitted_when_absentstringfalse
customerSettingsemailTemplateVisitorConfirmationSubjectDestringomitted_when_absentstringfalse
customerSettingsidstringalwaysopaqueReferencefalse
customerSettingssourceTablestringalwaysstringfalse
customerSettingsuserRefstringomitted_when_absentopaqueReferencefalse

team-bookings

POST /api/export/v1/team-bookings · Teams und Teambuchungen · paginated

Exportfelder der Ressource team-bookings
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
teamBookingsassignedMemberCustomerSettingsRefsarrayalwaysopaqueReferenceArrayfalse
  • zero_or_more
teamBookingsassignedTeamMemberRefsarrayomitted_when_absentopaqueReferenceArrayfalse
  • zero_or_more
teamBookingscancelledAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamBookingscreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamBookingsendTimenumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamBookingsidstringalwaysopaqueReferencefalse
teamBookingsreasonstringomitted_when_absentstringfalse
teamBookingssourceTablestringalwaysstringfalse
teamBookingsstartTimenumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamBookingsstatusstringalwaysstringfalse
teamBookingsteamRefstringalwaysopaqueReferencefalse
teamBookingsvisitorCompanystringomitted_when_absentstringfalse
teamBookingsvisitorEmailstringalwaysstringfalse
teamBookingsvisitorLanguagestringalwaysstringfalse
teamBookingsvisitorNamestringalwaysstringfalse
teamBookingsvisitorPhonestringomitted_when_absentstringfalse
teamBookingsvisitorTimezonestringalwaysstringfalse

team-members

POST /api/export/v1/team-members · Teams und Teambuchungen · paginated

Exportfelder der Ressource team-members
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
teamMembersacceptedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamMembersconsentVersionnumberomitted_when_absentnumberfalse
teamMemberscreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamMembersdeactivatedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamMembersidstringalwaysopaqueReferencefalse
teamMembersinvitedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamMemberslastAssignedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamMembersmemberCustomerSettingsRefstringalwaysopaqueReferencefalse
teamMembersmemberDisplayNamestringomitted_when_absentstringfalse
teamMembersmemberEmailstringomitted_when_absentstringfalse
teamMembersremovalReasonstringomitted_when_absentstringfalse
teamMembersremovedAtnumberomitted_when_absentunixMillisecondsfalse
  • unix_milliseconds
teamMemberssourceTablestringalwaysstringfalse
teamMembersstatusstringalwaysstringfalse
teamMembersteamRefstringalwaysopaqueReferencefalse
teamMembersupdatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds

teams

POST /api/export/v1/teams · Teams und Teambuchungen · paginated

Exportfelder der Ressource teams
QuelltabelleFeldJSON-TypVorkommenStrukturNullwert zulässigKardinalität oder Einheit
teamsavailabilityModestringalwaysstringfalse
teamsbookingPageFallbackLanguagestringomitted_when_absentstringfalse
teamsbookingUuidstringalwaysstringfalse
teamscreatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamsdaysAheadnumberalwaysnumberfalse
teamsdisplayNamestringalwaysstringfalse
teamsenabledbooleanalwaysbooleanfalse
teamsidstringalwaysopaqueReferencefalse
teamsownerCustomerSettingsRefstringalwaysopaqueReferencefalse
teamsrespectMemberWorkingHoursbooleanalwaysbooleanfalse
teamsslotDurationMinutesnumberalwaysnumberfalse
teamssourceTablestringalwaysstringfalse
teamsteamBufferOverrideMinutesnumberomitted_when_absentnumberfalse
teamsteamGridBufferMinutesnumberalwaysnumberfalse
teamsteamMinLeadTimeOverrideMinutesnumberomitted_when_absentnumberfalse
teamstimeWindowsarrayalwaystimeWindowsfalse
  • zero_or_more
teamstimezonestringalwaysstringfalse
teamsupdatedAtnumberalwaysunixMillisecondsfalse
  • unix_milliseconds
teamsworkingDaysarrayalwaysarrayOfNumbersfalse
  • zero_or_more

Definitionen der JSON-Strukturen

Felder auf oberster Ebene verweisen auf diese gemeinsamen Definitionen. Objektmitglieder, Array-Elemente und Vereinigungsvarianten sind rekursiv aufgeführt, damit empfangende Provider verschachtelte Strukturen nicht herleiten müssen.

Scrollen Sie horizontal durch die Tabelle, um alle Spalten zu sehen.

Benannte JSON-Strukturen, auf die Exportfelder verweisen
StrukturArtJSON-TypNullwert zulässigDefinition
arrayOfNumbersarrayarrayfalse
  • zero_or_more
  • items → number
booleanscalarbooleanfalse
booleanOrNullunionbooleantrueboolean | null
entitlementsobjectobjectfalse
  • customBranding → boolean (always)
  • maxBookingsPerMonth → numberOrNull (always)
  • maxCalendars → number (always)
  • maxTeams → numberOrNull (omitted_when_absent)
nullscalarnulltrue
numberscalarnumberfalse
numberOrNullunionnumbertruenumber | null
opaqueReferencescalarstringfalseopaque-reference
opaqueReferenceArrayarrayarrayfalse
  • zero_or_more
  • items → opaqueReference
providerTokenInstructionobjectobjectfalse
  • dpaAcceptedAtAtIssuance → unixMilliseconds (always)
  • dpaVersionAtIssuance → string (always)
  • expiresAt → unixMilliseconds (always)
  • issuedAt → unixMilliseconds (always)
  • issuerEmailSnapshot → string (always)
  • recipientCountryCode → string (always)
  • recipientName → string (always)
  • recipientRole → string (always)
  • scope → string (always)
  • termsAcceptedAtAtIssuance → unixMilliseconds (always)
  • termsVersionAtIssuance → string (always)
  • transferDeclaredAt → unixMilliseconds (always)
  • transferRegion → string (always)
providerTokenInstructionsarrayarrayfalse
  • zero_or_more
  • items → providerTokenInstruction
scheduledPlanChangeobjectobjectfalse
  • effectiveAt → unixMilliseconds (always)
  • targetPlan → string (always)
stringscalarstringfalse
stringOrNullunionstringtruestring | null
timeWindowobjectobjectfalse
  • end → string (always)
  • start → string (always)
timeWindowsarrayarrayfalse
  • zero_or_more
  • items → timeWindow
unixMillisecondsscalarnumberfalseunix_milliseconds