REST Resource: purchases.subscriptions

Ressource: SubscriptionPurchase

Eine SubscriptionPurchase-Ressource gibt den Status des Abokaufs eines Nutzers an.

JSON-Darstellung 
{
  "kind": string,
  "startTimeMillis": string,
  "expiryTimeMillis": string,
  "autoResumeTimeMillis": string,
  "autoRenewing": boolean,
  "priceCurrencyCode": string,
  "priceAmountMicros": string,
  "introductoryPriceInfo": {
    object (IntroductoryPriceInfo)
  },
  "countryCode": string,
  "developerPayload": string,
  "paymentState": integer,
  "cancelReason": integer,
  "userCancellationTimeMillis": string,
  "cancelSurveyResult": {
    object (SubscriptionCancelSurveyResult)
  },
  "orderId": string,
  "linkedPurchaseToken": string,
  "purchaseType": integer,
  "priceChange": {
    object (SubscriptionPriceChange)
  },
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string,
  "profileId": string,
  "acknowledgementState": integer,
  "externalAccountId": string,
  "promotionType": integer,
  "promotionCode": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Felder
kind

string

Diese Art stellt ein subscriptionPurchase-Objekt im androidpublisher-Dienst dar.
startTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo gewährt wurde, in Millisekunden seit der Epoche.
expiryTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo abläuft, in Millisekunden seit der Epoche.
autoResumeTimeMillis

string (int64 format)

Zeitpunkt, zu dem das Abo automatisch fortgesetzt wird, in Millisekunden seit der Epoche. Nur vorhanden, wenn der Nutzer die Pausierung des Abos beantragt hat.
autoRenewing

boolean

Gibt an, ob das Abo automatisch verlängert wird, wenn das aktuelle Ablaufdatum erreicht wird.
priceCurrencyCode

string

ISO 4217-Währungscode für den Abopreis. Wenn der Preis beispielsweise in britischen Pfund angegeben ist, lautet der „priceCurrencyCode“ „GBP“.
priceAmountMicros

string (int64 format)

Preis des Abos. In Ländern ohne Steuern ist der Preis ohne Steuern angegeben. In Ländern, in denen Steuern im Preis enthalten sind, ist der Preis inklusive Steuern. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten einer Währungseinheit entsprechen. Wenn der Abopreis beispielsweise 1, 99 € beträgt, ist „priceAmountMicros“ gleich 1990000.
introductoryPriceInfo

object (IntroductoryPriceInfo)

Informationen zum Einführungspreis des Abos. Dieser Hinweis wird nur angezeigt, wenn das Abo zu einem Einführungspreis gekauft wurde.

Dieses Feld gibt nicht an, ob sich das Abo derzeit im Einführungszeitraum befindet.
countryCode

string

Der ISO 3166-1 alpha-2-Länder-/Regionscode des Nutzers zum Zeitpunkt der Gewährung des Abos.
developerPayload

string

Ein vom Entwickler angegebener String mit zusätzlichen Informationen zu einer Bestellung.
paymentState

integer

Der Zahlungsstatus des Abos. Mögliche Werte: 0. Zahlung ausstehend 1. Zahlung erhalten 2. Kostenloser Testzeitraum 3. Ausstehendes verschobenes Upgrade/Downgrade

Nicht vorhanden für gekündigte oder abgelaufene Abos.
cancelReason

integer

Der Grund, warum ein Abo gekündigt wurde oder nicht automatisch verlängert wird. Mögliche Werte: 0. Der Nutzer hat Abo 1 gekündigt. Das Abo wurde vom System gekündigt, z. B. aufgrund eines Abrechnungsproblems. Abo wurde durch ein neues Abo 3 ersetzt. Abo wurde vom Entwickler gekündigt
userCancellationTimeMillis

string (int64 format)

Der Zeitpunkt, zu dem das Abo vom Nutzer gekündigt wurde, in Millisekunden seit der Epoche. Nur vorhanden, wenn „cancelReason“ den Wert „0“ hat.
cancelSurveyResult

object (SubscriptionCancelSurveyResult)

Informationen, die der Nutzer beim Kündigen eines Abos angibt (Umfrage zum Kündigungsgrund).
orderId

string

Die Bestell-ID der letzten wiederkehrenden Bestellung, die mit dem Kauf des Abos verknüpft ist. Wenn das Abo aufgrund einer abgelehnten Zahlung gekündigt wurde, ist dies die Bestell-ID der Bestellung, bei der die Zahlung abgelehnt wurde.
linkedPurchaseToken

string

Das Kauftoken des ursprünglichen Kaufs, wenn dieses Abo eine der folgenden Optionen ist: 0. Noch nicht abgelaufenes, gekündigtes Abo noch einmal abschließen 1. Upgrade/Downgrade von einem vorherigen Abo

Angenommen, ein Nutzer registriert sich und Sie erhalten Kauftoken X. Der Nutzer kündigt und durchläuft den Registrierungsvorgang noch einmal, bevor sein Abo abläuft. Sie erhalten Kauftoken Y. Schließlich wechselt der Nutzer zu einem höherwertigen Abo und Sie erhalten Kauftoken Z. Wenn du diese API mit dem Kauftoken Z aufrufst, wird dieses Feld auf „Y“ gesetzt. Wenn du diese API mit dem Kauftoken Y aufrufst, wird dieses Feld auf X gesetzt. Wenn du diese API mit dem Kauftoken X aufrufst, wird dieses Feld nicht festgelegt.
purchaseType

integer

Die Art des Kaufs des Abos. Dieses Feld wird nur festgelegt, wenn der Kauf nicht über die standardmäßige In-App-Abrechnung erfolgt ist. Mögliche Werte: 0. Test (d.h. in einem Lizenztestkonto gekauft) 1. Aktionsartikel (d.h. mit einem Gutscheincode gekauft)
priceChange

object (SubscriptionPriceChange)

Die neuesten verfügbaren Informationen zu Preisänderungen. Dieser Hinweis wird nur angezeigt, wenn eine bevorstehende Preisänderung für das Abo noch nicht angewendet wurde.

Sobald das Abo mit dem neuen Preis verlängert oder gekündigt wurde, werden keine Informationen zur Preisänderung zurückgegeben.
profileName

string

Der Profilname des Nutzers zum Zeitpunkt des Kaufs des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
emailAddress

string

Die E-Mail-Adresse des Nutzers, die zum Zeitpunkt des Kaufs des Abos verwendet wurde. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
givenName

string

Der Vorname des Nutzers zum Zeitpunkt des Kaufs des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
familyName

string

Der Nachname des Nutzers zum Zeitpunkt des Kaufs des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
profileId

string

Die Google-Profil-ID des Nutzers zum Zeitpunkt des Kaufs des Abos. Nur für Käufe mit „Abonnieren mit Google“ verfügbar.
acknowledgementState

integer

Der Bestätigungsstatus des Aboprodukts. Mögliche Werte: 0. Noch nicht bestätigt 1. Bestätigt
externalAccountId

string

Nutzerkonto-ID im Drittanbieterdienst. Nur vorhanden, wenn die Kontoverknüpfung im Rahmen des Abokaufvorgangs erfolgte.
promotionType

integer

Die Art des Angebots, das auf diesen Kauf angewendet wurde. Dieses Feld wird nur festgelegt, wenn beim Kauf des Abos ein Angebot angewendet wird. Mögliche Werte: 0. Einmaliger Code 1. Vanity-Code
promotionCode

string

Der Gutscheincode, der auf diesen Kauf angewendet wurde. Dieses Feld wird nur festgelegt, wenn beim Kauf des Abos ein Angebot mit einem Vanity-Code angewendet wurde.
obfuscatedExternalAccountId

string

Eine verschleierte Version der ID, die eindeutig mit dem Konto des Nutzers in Ihrer App verknüpft ist. Diese ID ist bei den folgenden Käufen vorhanden: * Wenn die Kontoverknüpfung im Rahmen des Abokaufvorgangs erfolgte. * Sie wurde beim Kauf mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid angegeben.
obfuscatedExternalProfileId

string

Eine verschleierte Version der ID, die eindeutig mit dem Profil des Nutzers in Ihrer App verknüpft ist. Diese ID ist nur vorhanden, wenn sie beim Kauf mit https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid angegeben wurde.

IntroductoryPriceInfo

Enthält Informationen zum Einführungspreis für ein Abo.

JSON-Darstellung 
{
  "introductoryPriceCurrencyCode": string,
  "introductoryPriceAmountMicros": string,
  "introductoryPricePeriod": string,
  "introductoryPriceCycles": integer
}
Felder
introductoryPriceCurrencyCode

string

ISO 4217-Währungscode für den Einführungspreis des Abos. Wenn der Preis beispielsweise in britischen Pfund angegeben ist, lautet der „priceCurrencyCode“ „GBP“.
introductoryPriceAmountMicros

string (int64 format)

Einführungspreis des Abos, ohne Steuern. Die Währung ist dieselbe wie „priceCurrencyCode“. Der Preis wird in Mikroeinheiten angegeben, wobei 1.000.000 Mikroeinheiten einer Währungseinheit entsprechen. Wenn der Abopreis beispielsweise 1, 99 € beträgt, ist „priceAmountMicros“ gleich 1990000.
introductoryPricePeriod

string

Zeitraum des Einführungspreises, angegeben im ISO 8601-Format. Gängige Werte sind unter anderem „P1W“ (eine Woche), „P1M“ (ein Monat), „P3M“ (drei Monate), „P6M“ (sechs Monate) und „P1Y“ (ein Jahr).
introductoryPriceCycles

integer

Die Anzahl der Abrechnungszeiträume, für die ein Einführungspreis angeboten werden soll.

SubscriptionCancelSurveyResult

Informationen, die der Nutzer beim Kündigen eines Abos angibt (Umfrage zum Kündigungsgrund).

JSON-Darstellung 
{
  "cancelSurveyReason": integer,
  "userInputCancelReason": string
}
Felder
cancelSurveyReason

integer

Der in der Umfrage vom Nutzer ausgewählte Grund für die Kündigung. Mögliche Werte: 0. Sonstiges 1. Ich nutze diesen Dienst zu selten 2. Technische Probleme 3. Kostengründe 4. Weil ich eine bessere App gefunden habe
userInputCancelReason

string

Der benutzerdefinierte Grund für die Stornierung. Ist nur vorhanden, wenn „cancelReason“ den Wert „0“ hat.

SubscriptionPriceChange

Enthält die Informationen zur Preisänderung für ein Abo, mit denen die Aufrufabfolge für die Preisänderung in der App gesteuert werden kann. Dies kann in Form einer Bestätigung durch den Nutzer oder einer Anpassung der App für eine erfolgreiche Conversion erfolgen.

JSON-Darstellung 
{
  "newPrice": {
    object (Price)
  },
  "state": integer
}
Felder
newPrice

object (Price)

Der neue Preis, zu dem das Abo verlängert wird, wenn die Preisänderung vom Nutzer akzeptiert wird.
state

integer

Der aktuelle Status der Preisänderung. Mögliche Werte: 0. Ausstehend: Status für eine ausstehende Preisänderung, bei der der Nutzer noch zustimmen muss. In diesem Status können Sie optional eine Bestätigung des Nutzers über die In-App API einholen. 1. Akzeptiert: Geben Sie bei einer akzeptierten Preisänderung an, zu welchem Preis das Abo verlängert wird, sofern es nicht gekündigt wird. Die Preisänderung wird zu einem zukünftigen Datum wirksam, wenn das Abo verlängert wird. Die Änderung wird möglicherweise nicht bei der nächsten Verlängerung des Abos berücksichtigt.

Methoden

acknowledge

 Bestätigt den Kauf eines Abos.

cancel

 Kündigt den Abokauf eines Nutzers.

defer

 Der Kauf eines Abos wird bis zu einem bestimmten Ablaufdatum verschoben.

get

 Prüft, ob der Abokauf eines Nutzers gültig ist, und gibt das Ablaufdatum zurück.

refund

 Der Abokauf eines Nutzers wird erstattet, das Abo bleibt jedoch bis zum Ablaufdatum gültig und wird fortgesetzt.

revoke

 Der Abokauf eines Nutzers wird erstattet und sofort widerrufen.