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 Property wird immer in einer Antwort als von Google generierte eindeutige Kennung zurückgegeben. In einer Anfrage kann diese Property 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 dauerhafte 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 ist. Informationen zu Produkten und Artikelnummern, die in dieser Version der API verfügbar sind, finden Sie unter Produkt- und Artikelnummer-IDs.
creationTime

string (int64 format)

Die Property creationTime ist das Datum, an dem das Abo erstellt wurde. Sie wird im Millisekunden-Format im Epochenformat angegeben. Beispiel für einen Epoch Converter
kind

string

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

object (Seats)

Dies ist eine erforderliche Property. Anzahl und Beschränkung der Nutzerlizenzen im Plan.
renewalSettings

object (RenewalSettings)

Verlängerungseinstellungen für den Jahrestarif. Weitere Informationen finden Sie im Hilfeartikel Chrome-Richtlinien für Nutzer oder Browser festlegen.
purchaseOrderId

string

Dies ist eine optionale Property. Diese PO-Informationen sind für Reseller gedacht, die sie zur Verfolgung der Unternehmensnutzung verwenden möchten. Wenn ein purchaseOrderId-Wert angegeben ist, erscheint er in den API-Antworten und wird in der Rechnung angezeigt. Die Property akzeptiert bis zu 80 Textzeichen.
status

string

Dies ist eine optionale Property.
resourceUiUrl

string

URL zur Seite „Abos“ des Kunden in der Admin-Konsole. Die schreibgeschützte URL wird vom API-Dienst generiert. Dies wird verwendet, wenn Ihre Client-Anwendung erfordert, dass der Kunde eine Aufgabe über die Seite „Abos“ in der Admin-Konsole ausführt.
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. Es ist möglich, dass ein Abo viele Gründe hat, die gleichzeitig ausgesetzt werden. Das Abo für STATUS ist SUSPENDED, bis alle ausstehenden Sperrungen entfernt wurden.

Mögliche Optionen:

  • PENDING_TOS_ACCEPTANCE – Der Kunde hat sich nicht angemeldet und die Nutzungsbedingungen der G Suite-Reseller-Dienste akzeptiert.
  • RENEWAL_WITH_TYPE_CANCEL – Die Verpflichtung des Kunden ist abgelaufen und sein Dienst wurde am Ende der Laufzeit gekündigt.
  • RESELLER_INITIATED: Eine manuelle Sperrung, die von einem Reseller veranlasst wird.
  • TRIAL_ENDED: Der Testzeitraum des Kunden ist abgelaufen, ohne dass ein Plan ausgewählt wurde.
  • OTHER – Der Kunde wurde aus internen Gründen (z.B. wegen Missbrauchs) gesperrt.

customerDomain

string

Name der primären Domain des Kunden
dealCode

string

Von Google ausgestellter Code (maximal 100 Zeichen) für ermäßigte Preise für Abos. Der Deal-Code muss in insert-Anfragen enthalten sein, damit Sie einen Rabatt erhalten. Dieses Attribut ist optional. Wenn das Feld leer ist, gelten die regulären Preise.
skuName

string

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

object

Das Attribut plan ist erforderlich. In dieser Version der API sind die G Suite-Tarife der flexible Tarif, der Jahrestarif und der 30-tägige kostenlose Testzeitraum. Weitere Informationen zu den Preismodellen der API finden Sie hier.
plan.planName

string

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

Mögliche Werte:

  • ANNUAL_MONTHLY_PAY: Der Jahrestarif mit monatlichen Zahlungen.
  • ANNUAL_YEARLY_PAY – Der Jahrestarif mit jährlichen Zahlungen
  • FLEXIBLE – Der flexible Tarif
  • TRIAL: Der 30-tägige kostenlose Testzeitraum. Wenn kein Preismodell zugewiesen ist, wird das Probeabo nach dem 30. Tag gesperrt. Wenn Sie changePlan anrufen, wird dieser ein Preismodell zugewiesen, der Tarif wird jedoch nicht aktiviert. Der zugewiesene Testzeitraum beginnt automatisch nach dem 30. kostenlosen Tag oder unmittelbar nach dem Anruf bei startPaidService.
  • FREE: Der kostenlose Tarif ist nur für Cloud Identity verfügbar und wird nicht abgerechnet.

plan.isCommitmentPlan

boolean

Mit dem booleschen Wert der Property isCommitmentPlan wird der Jahrestarif als Jahrestarif festgelegt:

  • true: Das Abo ist ein Jahrestarif.
  • false: Der Tarif ist kein Jahrestarif.
plan.commitmentInterval

object

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

plan.commitmentInterval.startTime

string (int64 format)

Ein Jahrestarif mit einer Laufzeit von startTime in Millisekunden im UNIX-Epochenformat. Beispiel für einen Epoch Converter
plan.commitmentInterval.endTime

string (int64 format)

Ein Jahrestarif mit einem Intervall von endTime in Millisekunden im UNIX-Epochenformat. Beispiel für einen Epoch Converter
trialSettings

object

Sie können das Jahresabo für die G Suite und die flexiblen Preismodelle 30 Tage lang kostenlos testen. Weitere Informationen finden Sie unter API-Konzepte.
trialSettings.isInTrial

boolean

Legt fest, ob sich ein Abo im 30-tägigen kostenlosen Testzeitraum befindet oder nicht:

  • true: Der Tarif befindet sich in der Testphase.
  • false: Der Tarif befindet sich nicht in der Testphase.
trialSettings.trialEndTime

string (int64 format)

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

object

Schreibgeschützte Übertragungsinformationen für das Abo. Weitere Informationen finden Sie unter Übertragbare Abos für einen Kunden abrufen.
transferInfo.transferabilityExpirationTime

string (int64 format)

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

integer

Wenn Sie ein Abo abschließen, ist dies die Mindestanzahl von Lizenzen, die in der Übertragungsbestellung für dieses Produkt angegeben ist. Wenn der Kunde beispielsweise 20 Nutzer hat, kann der Reseller keine Übertragungsanfrage mit 15 Lizenzen aufgeben. Das Minimum ist 20 Sitze.
transferInfo.currentLegacySkuId

string

Die skuId des aktuell weiterverkauften Abos. Wird nur ausgefüllt, wenn der Kunde ein Abo mit einer alten Artikelnummer hat. Für die Aboressource werden die skuId der für die Übertragung empfohlenen Artikelnummer verwendet.

Plätze

JSON-Vorlage für Abolizenzen.

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

integer

Das ist eine erforderliche Property und nur für Abos mit ANNUAL_MONTHLY_PAY- und ANNUAL_YEARLY_PAY-Tarifen verfügbar. Mit dieser Property wird die maximale Anzahl von Lizenzen festgelegt, die Nutzern in einem Abo zugewiesen werden können. Der Wiederverkäufer kann weitere Lizenzen hinzufügen, aber nach der Festlegung kann die numberOfSeats erst nach der Verlängerung reduziert werden. Die Abrechnung für den Reseller basiert auf dem Wert numberOfSeats, unabhängig davon, wie viele dieser Nutzerlizenzen zugewiesen sind.

maximumNumberOfSeats

integer

Das ist eine erforderliche Property und nur für Abos mit FLEXIBLE- oder TRIAL-Tarifen verfügbar. Mit dieser Property wird die maximale Anzahl an lizenzierten Nutzern für ein Abo festgelegt. Diese Menge kann auf das im Resellervertrag festgelegte Limit erhöht werden. Die Mindestmenge ist die aktuelle Anzahl der Nutzer im Kundenkonto.

licensedNumberOfSeats

integer

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

string

Kennzeichnet die Ressource als Abolizenz. 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 im Hilfeartikel Chrome-Richtlinien für Nutzer oder Browser festlegen. Wenn du ein Abo verlängerst, ist renewalType eine erforderliche Property.
kind

string

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

Methoden

activate

 Aktiviert ein Abo, das zuvor vom Reseller gesperrt wurde.

changePlan

 Aktualisiert ein Abo.

changeRenewalSettings

 Aktualisiert die Einstellungen für die Verlängerung der Nutzerlizenz

changeSeats

 Aktualisiert die Lizenzeinstellungen eines Nutzers für ein Abo

delete

 Kündigt, sperrt oder überträgt ein Abo zur direkten Nutzung

get

 Ruft ein bestimmtes Abo ab.

insert

 Erstellt oder überträgt ein Abo.

list

 Listen mit Abos, die vom Reseller verwaltet werden.

startPaidService

 Verschieben Sie ein 30-tägiges Probeabo sofort auf ein kostenpflichtiges Abo.

suspend

 Sperrt ein aktives Abo.