REST Resource: subscriptions

Ressource: Abo

JSON-Vorlage für ein Abo.

JSON-Darstellung 
{
  "customerId": string,
  "subscriptionId": string,
  "skuId": string,
  "creationTime": string,
  "kind": string,
  "seats": {
    object (Seats)
  },
  "renewalSettings": {
    object (RenewalSettings)
  },
  "purchaseOrderId": string,
  "status": string,
  "resourceUiUrl": string,
  "billingMethod": string,
  "suspensionReasons": [
    string
  ],
  "customerDomain": string,
  "dealCode": string,
  "skuName": string,
  "plan": {
    "planName": string,
    "isCommitmentPlan": boolean,
    "commitmentInterval": {
      "startTime": string,
      "endTime": string
    }
  },
  "trialSettings": {
    "isInTrial": boolean,
    "trialEndTime": string
  },
  "transferInfo": {
    "transferabilityExpirationTime": string,
    "minimumTransferableSeats": integer,
    "currentLegacySkuId": string
  }
}
Felder
customerId

string

Diese Eigenschaft wird in der Antwort immer als die von Google generierte eindeutige Kennung zurückgegeben. In einer Anfrage kann diese Eigenschaft entweder die primäre Domain oder die von Google generierte eindeutige Kennung sein.
subscriptionId

string

Die subscriptionId ist die Abo-ID und für jeden Kunden eindeutig. Dies ist eine erforderliche Property. Da sich ein subscriptionId bei der Aktualisierung eines Abos ändert, empfehlen wir, diese ID nicht als Schlüssel für persistente Daten zu verwenden. Verwenden Sie die subscriptionId wie unter Alle Reseller-Abos abrufen beschrieben.
skuId

string

Eine erforderliche Property. Die skuId ist eine eindeutige Systemkennung für die Artikelnummer eines Produkts, die einem Kunden im Abo zugewiesen wird. Informationen zu Produkten und SKUs, die in dieser Version der API verfügbar sind, finden Sie unter Produkt- und SKU-IDs.
creationTime

string (int64 format)

Das Attribut creationTime gibt das Datum an, an dem das Abo erstellt wurde. Sie werden im Epochen-Format in Millisekunden angegeben. Beispiel für einen Epochen-Konverter
kind

string

Kennzeichnet die Ressource als Abo. Wert: reseller#subscription
seats

object (Seats)

Dies ist eine erforderliche Property. Die Anzahl und das Limit der Nutzerlizenzen im Tarif.
renewalSettings

object (RenewalSettings)

Verlängerungseinstellungen für den Jahrestarif. Weitere Informationen finden Sie in der Hilfe für Administratoren unter den Verlängerungsoptionen.
purchaseOrderId

string

Dies ist eine optionale Eigenschaft. Diese Auftragsinformationen können Reseller für die Tracking-Nutzung ihres Unternehmens verwenden. Wenn ein purchaseOrderId-Wert angegeben wird, erscheint dieser in den API-Antworten und auf der Rechnung. Die Eigenschaft akzeptiert bis zu 80 Textzeichen.
status

string

Dies ist eine optionale Eigenschaft.
resourceUiUrl

string

URL zur Aboseite des Kunden in der Admin-Konsole Die schreibgeschützte URL wird vom API-Dienst generiert. Diese Option wird verwendet, wenn der Kunde in Ihrer Clientanwendung eine Aufgabe über die Seite „Abos“ in der Admin-Konsole ausführen muss.
billingMethod

string

Schreibgeschütztes Feld, das die aktuelle Abrechnungsmethode für ein Abo zurückgibt.
suspensionReasons[]

string

Schreibgeschütztes Feld mit einer Aufzählung aller aktuellen Sperrungsgründe für ein Abo. Für ein Abo können mehrere Gründe für eine Sperrung gleichzeitig vorliegen, die sich überschneiden. Der STATUS-Wert eines Abos beträgt SUSPENDED, bis alle ausstehenden Sperrungen entfernt wurden.

Mögliche Optionen:

  • PENDING_TOS_ACCEPTANCE: Der Kunde hat sich nicht angemeldet und die Nutzungsbedingungen für die Reseller-Plattform für die G Suite nicht akzeptiert.
  • RENEWAL_WITH_TYPE_CANCEL: Die Zusicherung des Kunden ist abgelaufen und der Dienst wurde zum Ende der Laufzeit gekündigt.
  • RESELLER_INITIATED: Eine manuelle Sperrung, die von einem Reseller ausgelöst wurde.
  • TRIAL_ENDED: Der Testzeitraum des Kunden ist abgelaufen, ohne dass ein Tarif ausgewählt wurde.
  • OTHER: Der Kunde wurde aus internen Google-Gründen gesperrt, z.B. wegen Missbrauchs.

customerDomain

string

Primärer Domainname des Kunden
dealCode

string

Von Google vergebener Code (max. 100 Zeichen) für Rabatte auf Abos. Damit Sie den Rabatt erhalten, muss der Deal-Code in insert-Anfragen enthalten sein. Diese Eigenschaft ist optional. Wenn Sie das Feld leer lassen, gelten die regulären Preise.
skuName

string

Schreibgeschützter externer Anzeigename für die Artikelnummer eines Produkts, die einem Kunden im Abo zugewiesen ist. Die Namen von Artikelnummern können nach Ermessen von Google geändert werden. Informationen zu Produkten und SKUs, die in dieser Version der API verfügbar sind, finden Sie unter Produkt- und SKU-IDs.
plan

object

Das Attribut plan ist erforderlich. In dieser API-Version umfasst die G Suite den flexiblen Tarif, den Jahrestarif und die kostenlose 30-tägige Testversion. Weitere Informationen zu den Preismodellen der API finden Sie unter API-Konzepte.
plan.planName

string

Das Attribut planName ist erforderlich. Dies ist der Name des Abos. Weitere Informationen zu den Google-Preismodellen finden Sie unter API-Konzepte.

Mögliche Werte sind:

  • ANNUAL_MONTHLY_PAY: Der Jahrestarif mit monatlichen Zahlungen.
  • ANNUAL_YEARLY_PAY: Jahrestarif mit jährlichen Zahlungen
  • FLEXIBLE – der flexible Tarif
  • TRIAL: die 30-tägige kostenlose Testversion. Ein Abo im Testzeitraum wird nach dem 30. Tag der kostenlosen Testversion gesperrt, wenn kein Preismodell zugewiesen wird. Wenn Sie changePlan aufrufen, wird einem Testzeitraum ein Abrechnungsmodell zugewiesen, der Tarif wird jedoch nicht aktiviert. Der Testzeitraum beginnt automatisch nach dem 30. Tag der kostenlosen Testversion oder sofort nach dem Anruf bei startPaidService.
  • FREE: Der kostenlose Tarif ist exklusiv für die Cloud Identity-Artikelnummer verfügbar. Es fallen keine Kosten an.

plan.isCommitmentPlan

boolean

Der boolesche Wert der Property isCommitmentPlan gibt an, dass es sich um einen Jahrestarif handelt:

  • true: Beim Abo handelt es sich um einen Jahrestarif.
  • false: Der Tarif ist kein Jahrestarif.
plan.commitmentInterval

object

In dieser Version der API beträgt das Intervall des Jahrestarifs ein Jahr.

plan.commitmentInterval.startTime

string (int64 format)

Das Intervall eines Jahrestarifs (startTime) in Millisekunden im UNIX-Epochen-Format. Beispiel für einen Epochen-Konverter
plan.commitmentInterval.endTime

string (int64 format)

Das Intervall eines Jahrestarifs mit endTime in Millisekunden im UNIX-Epochenformat. Beispiel für einen Epochen-Konverter
trialSettings

object

Sie können den G Suite-Jahrestarif und das flexible Preismodell als 30-tägige kostenlose Testversion nutzen. Weitere Informationen finden Sie unter API-Konzepte.
trialSettings.isInTrial

boolean

Bestimmt, ob Sie ein Abo als 30-tägiger kostenloser Testzeitraum nutzen oder nicht:

  • true: Das Abo befindet sich im Testzeitraum.
  • false: Der Tarif befindet sich nicht im Testzeitraum.
trialSettings.trialEndTime

string (int64 format)

Datum, an dem der Testzeitraum endet. Der Wert wird im UNIX-Epochenformat in Millisekunden angegeben. Beispiel für einen Epochen-Konverter
transferInfo

object

Schreibgeschützte Informationen zur Übertragung des Abos. Weitere Informationen finden Sie unter Übertragbare Abos eines Kunden abrufen.
transferInfo.transferabilityExpirationTime

string (int64 format)

Der Zeitpunkt, zu dem das Übertragungstoken oder der Übertragungs-Intent abläuft. Die Zeit wird im UNIX-Epochenformat in Millisekunden angegeben.
transferInfo.minimumTransferableSeats

integer

Beim Einfügen eines Abos ist dies die Mindestanzahl von Nutzerlizenzen, die in der Übertragungsbestellung für dieses Produkt aufgeführt sind. Wenn der Kunde beispielsweise 20 Nutzer hat, kann der Reseller keine Übertragungsbestellung von 15 Lizenzen aufgeben. Die Mindestanzahl beträgt 20 Nutzerlizenzen.
transferInfo.currentLegacySkuId

string

Die skuId des aktuellen weiterverkauften Abos. Dieses Feld wird nur ausgefüllt, wenn der Kunde ein Abo mit einer alten Artikelnummer hat und die Aboressource mit der skuId der Artikelnummer gefüllt ist, die für die Übertragung empfohlen wird.

Plätze

JSON-Vorlage für Abo-Lizenzen.

JSON-Darstellung 
{
  "numberOfSeats": integer,
  "maximumNumberOfSeats": integer,
  "licensedNumberOfSeats": integer,
  "kind": string
}
Felder
numberOfSeats

integer

Dies ist eine erforderliche Property und ist exklusiv für Abos mit den Tarifen ANNUAL_MONTHLY_PAY und ANNUAL_YEARLY_PAY verfügbar. Mit dieser Eigenschaft wird die maximale Anzahl der Lizenzen festgelegt, die Nutzern in einem Abo zugewiesen werden können. Der Reseller kann weitere Lizenzen hinzufügen. Nach der Festlegung kann der numberOfSeats jedoch bis zum Verlängerungsdatum nicht mehr reduziert werden. Dem Reseller wird die Rechnung auf Grundlage des Werts numberOfSeats in Rechnung gestellt, unabhängig davon, wie viele dieser Nutzerlizenzen zugewiesen sind.

maximumNumberOfSeats

integer

Dies ist eine erforderliche Property und ist exklusiv für Abos mit dem Abo „FLEXIBLE“ oder „TRIAL“ verfügbar. Mit dieser Property wird die maximale Anzahl lizenzierter Nutzer festgelegt, die für ein Abo zulässig sind. Diese Menge kann bis zum maximal im Vertrag des Resellers festgelegten Limit erhöht werden. Die Mindestmenge ist die aktuelle Anzahl der Nutzer im Kundenkonto.

licensedNumberOfSeats

integer

Schreibgeschütztes Feld mit der aktuellen Anzahl der Nutzer, denen eine Lizenz für das in skuId definierte Produkt zugewiesen ist. Der Wert in diesem Feld entspricht der numerischen Anzahl der Nutzer, die von der Enterprise License Manager API-Methode zurückgegeben wurden: listForProductAndSku.
kind

string

Kennzeichnet die Ressource als Abo-Sitzplatzeinstellung. Wert: subscriptions#seats

RenewalSettings

JSON-Vorlage für die Einstellungen für die Aboverlängerung.

JSON-Darstellung 
{
  "renewalType": string,
  "kind": string
}
Felder
renewalType

string

Verlängerungseinstellungen für den Jahrestarif. Weitere Informationen finden Sie in der Hilfe für Administratoren unter den Verlängerungsoptionen. Beim Verlängern eines Abos ist die renewalType ein erforderliches Attribut.
kind

string

Kennzeichnet die Ressource als Einstellung für die Aboverlängerung. Wert: subscriptions#renewalSettings

Methoden

activate

 Ein Abo wird aktiviert, das zuvor vom Reseller gesperrt wurde.

changePlan

 Aktualisiert ein Abo.

changeRenewalSettings

 Aktualisiert die Verlängerungseinstellungen einer Nutzerlizenz.

changeSeats

 Aktualisiert die Nutzerlizenzeinstellungen eines Abos.

delete

 Kündigt, sperrt oder überträgt ein Abo an den Direktvertrieb.

get

 Ruft ein bestimmtes Abo ab.

insert

 Ein Abo wird erstellt oder übertragen.

list

 Listen der vom Reseller verwalteten Abos.

startPaidService

 Stellen Sie sofort ein 30-tägiges kostenloses Testabo in ein kostenpflichtiges Abo um.

suspend

 Ein aktives Abo wird gesperrt.