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 in einer Antwort immer 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 ist für jeden Kunden eindeutig. Dieses Attribut ist erforderlich. Da sich eine subscriptionId ändert, wenn ein Abo aktualisiert wird, empfehlen wir, diese ID nicht als Schlüssel für persistente Daten zu verwenden. Verwende die subscriptionId wie unter Alle Reseller-Abos abrufen beschrieben.
skuId

string

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

string (int64 format)

Das Attribut creationTime ist das Datum, an dem das Abo erstellt wurde. Die Zeit wird im Epoch-Format in Millisekunden angegeben. Beispiel für einen Epochenkonverter
kind

string

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

object (Seats)

Dieses Attribut ist erforderlich. Die Anzahl und das Limit der Nutzerlizenzen im Plan.
renewalSettings

object (RenewalSettings)

Verlängerungseinstellungen für den Jahrestarif. Weitere Informationen zu Verlängerungsoptionen finden Sie in der Administratorhilfe.
purchaseOrderId

string

Dieses Attribut ist optional. Diese Informationen zur Bestellung sind für Reseller zur Verwendung für das Tracking ihres Unternehmens bestimmt. Wenn ein purchaseOrderId-Wert angegeben ist, wird er in den API-Antworten und auf der Rechnung angezeigt. Das Attribut kann bis zu 80 Klartextzeichen enthalten.
status

string

Dieses Attribut ist optional.
resourceUiUrl

string

URL zur Seite „Abos“ 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 Gründe für die Sperrung eines Abos. Es ist möglich, dass ein Abo mehrere gleichzeitige, sich überschneidende Sperrgründe hat. Die STATUS eines Abos ist SUSPENDED, bis alle ausstehenden Sperrungen aufgehoben wurden.

Mögliche Optionen:

  • PENDING_TOS_ACCEPTANCE: Der Kunde hat sich nicht angemeldet und die Nutzungsbedingungen für die G Suite-Reseller-Dienste nicht akzeptiert.
  • RENEWAL_WITH_TYPE_CANCEL: Die Bindung des Kunden ist abgelaufen und der Dienst wurde am Ende der Laufzeit gekündigt.
  • RESELLER_INITIATED – Eine manuelle Sperrung, die von einem Reseller veranlasst wurde.
  • TRIAL_ENDED: Der Testzeitraum des Kunden ist abgelaufen, ohne dass ein Tarif ausgewählt wurde.
  • OTHER: Der Kunde wurde aus einem internen Grund von Google gesperrt (z.B. Missbrauch).

customerDomain

string

Primärer Domainname des Kunden
dealCode

string

Von Google ausgestellter Code (maximal 100 Zeichen) für ermäßigte Preise für Abos. Der Angebotscode muss in insert-Anfragen enthalten sein, damit der ermäßigte Preis gewährt wird. Diese Property ist optional. Wenn sie leer bleibt, gelten die regulären Preise.
skuName

string

Lesezugriff auf den externen Anzeigenamen der SKU eines Produkts, der einem Kunden im Abo zugewiesen ist. SKU-Namen können von Google nach eigenem Ermessen geändert werden. Informationen zu den in dieser Version der API verfügbaren Produkten und SKUs finden Sie unter Produkt- und SKU-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 unter API-Konzepte.
plan.planName

string

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

Mögliche Werte:

  • ANNUAL_MONTHLY_PAY – Jahrestarif mit monatlichen Zahlungen.
  • ANNUAL_YEARLY_PAY – Jahrestarif mit jährlichen Zahlungen
  • FLEXIBLE – Flexibler Tarif
  • TRIAL – 30-tägiger kostenloser Testzeitraum. Ein Abo im Testzeitraum wird nach dem 30. kostenlosen Tag ausgesetzt, wenn kein Preismodell zugewiesen ist. Wenn Sie changePlan anrufen, wird dem Testzeitraum ein Preismodell zugewiesen, aber nicht aktiviert. Nach dem 30. Tag des kostenlosen Testzeitraums oder sofort nach dem Anruf bei startPaidService beginnt automatisch der zugewiesene Abrechnungszeitraum.
  • FREE: Der kostenlose Tarif ist exklusiv für die Cloud Identity-SKU verfügbar und es fallen keine Kosten an.

plan.isCommitmentPlan

boolean

Der boolesche Wert der Property isCommitmentPlan identifiziert den Plan als Jahrestarif mit Bindung:

  • true: Für das Abo gilt ein Jahrestarif.
  • false – Der Tarif ist kein Jahrestarif.
plan.commitmentInterval

object

In dieser Version der API beträgt das Intervall für den Jahrestarif ein Jahr.

plan.commitmentInterval.startTime

string (int64 format)

startTime eines Jahrestarifs in Millisekunden im UNIX-Epoch-Format. Beispiel für einen Epochenkonverter
plan.commitmentInterval.endTime

string (int64 format)

endTime des Intervalls eines Jahrestarifs in Millisekunden im UNIX-Epoch-Format. Beispiel für einen Epochenkonverter
trialSettings

object

Für die G Suite mit einer jährlichen Bindung und flexiblen Preismodellen können Sie einen 30-tägigen kostenlosen Testzeitraum nutzen. Weitere Informationen finden Sie unter API-Konzepte.
trialSettings.isInTrial

boolean

Bestimmt, ob sich ein Abo in einem 30-tägigen kostenlosen Testzeitraum befindet:

  • true: Das Abo befindet sich in der Testphase.
  • false – Das Abo befindet sich nicht im Testzeitraum.
trialSettings.trialEndTime

string (int64 format)

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

object

Nur-Lese-Informationen zur Übertragung des Abos. Weitere Informationen findest du unter Übertragbare Abos für einen Kunden abrufen.
transferInfo.transferabilityExpirationTime

string (int64 format)

Der Zeitpunkt, zu dem das Übertragungstoken oder die Übertragungsabsicht abläuft. Die Zeit wird im Unix-Epoch-Format in Millisekunden angegeben.
transferInfo.minimumTransferableSeats

integer

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

string

Die skuId des aktuellen weiterverkauften Abos. Dieser Wert wird nur dann ausgefüllt, wenn der Kunde ein Abo mit einer alten SKU hat und die Aboressource mit der skuId der für die Übertragung empfohlenen SKU ausgefüllt ist.

Plätze

JSON-Vorlage für Aboplätze

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

integer

Diese Property ist erforderlich und gilt ausschließlich für Abos mit ANNUAL_MONTHLY_PAY- und ANNUAL_YEARLY_PAY-Tarifen. Mit dieser Property wird die maximale Anzahl von Lizenzen festgelegt, die Nutzern in einem Abo zugewiesen werden können. Der Reseller kann weitere Lizenzen hinzufügen. Die numberOfSeats kann jedoch erst bei der Verlängerung reduziert werden. Dem Reseller wird der Wert von numberOfSeats in Rechnung gestellt, unabhängig davon, wie viele dieser Nutzerlizenzen zugewiesen sind.

maximumNumberOfSeats

integer

Diese Property ist erforderlich und gilt ausschließlich für Abos mit FLEXIBLE- oder TRIAL-Tarif. Mit dieser Property wird die maximale Anzahl der lizenzierten Nutzer für ein Abo festgelegt. Diese Menge kann bis zum im Resellervertrag festgelegten Höchstwert erhöht werden. Die Mindestmenge entspricht der aktuellen 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 dieses Felds entspricht der Anzahl der Nutzer, die von der Enterprise License Manager API-Methode listForProductAndSku zurückgegeben wird.
kind

string

Gibt an, dass die Ressource eine Einstellung für Aboplätze ist. Wert: subscriptions#seats

RenewalSettings

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

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

string

Verlängerungseinstellungen für den Jahrestarif. Weitere Informationen zu Verlängerungsoptionen finden Sie in der Administratorhilfe. Bei der Verlängerung eines Abos ist das Attribut renewalType erforderlich.
kind

string

Gibt an, dass die Ressource eine Einstellung für die Aboverlängerung ist. Wert: subscriptions#renewalSettings

Methoden

activate

 Aktiviert ein Abo, das zuvor vom Reseller gesperrt wurde.

changePlan

 Aktualisiert einen Abotarif.

changeRenewalSettings

 Aktualisiert die Verlängerungseinstellungen einer Nutzerlizenz.

changeSeats

 Aktualisiert die Nutzerlizenzeinstellungen eines Abos.

delete

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

get

 Ruft ein bestimmtes Abo ab.

insert

 Erstellt oder überträgt ein Abo.

list

 Listen der vom Reseller verwalteten Abos.

startPaidService

 Sie können ein Abo mit 30-tägigem kostenlosen Testzeitraum sofort in ein kostenpflichtiges Abo umwandeln.

suspend

 Ein aktives Abo wird pausiert.