REST Resource: monetization.subscriptions

Ressource : Subscription

Un seul abonnement pour une application.

Représentation JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Champs
packageName

string

Immuable. Nom de package de l'application parente.
productId

string

Immuable. ID unique du produit. Unique dans l'application parente. Les identifiants produit doivent être composés de lettres minuscules (a-z), de chiffres (0-9), de traits de soulignement (_) et de points (.). Il doit commencer par une lettre minuscule ou un chiffre, et comporter entre 1 et 40 caractères (inclus).
basePlans[]

object (BasePlan)

Ensemble des forfaits de base pour cet abonnement. Représente le prix et la durée de l'abonnement si aucune autre offre ne s'applique.
listings[]

object (SubscriptionListing)

Obligatoire. Liste des fiches localisées pour cet abonnement. Doit contenir au moins une entrée pour la langue par défaut de l'application parente.
archived
(deprecated)

boolean

Uniquement en sortie. Obsolète: l'archivage des abonnements n'est pas disponible.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Informations sur les taxes et la conformité légale
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Facultatif. Pays dans lesquels l'achat de cet abonnement est limité aux modes de paiement enregistrés dans le même pays. Si ce champ est vide, aucune restriction liée aux lieux de paiement n'est appliquée.

BasePlan

Un forfait de base unique pour un abonnement.

Représentation JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

  // Union field base_plan_type can be only one of the following:
  "autoRenewingBasePlanType": {
    object (AutoRenewingBasePlanType)
  },
  "prepaidBasePlanType": {
    object (PrepaidBasePlanType)
  },
  "installmentsBasePlanType": {
    object (InstallmentsBasePlanType)
  }
  // End of list of possible types for union field base_plan_type.
}
Champs
basePlanId

string

Obligatoire. Immuable. Identifiant unique de ce forfait de base. Doit être unique dans l'abonnement et conforme à la norme RFC-1034. Autrement dit, il ne peut contenir que des lettres minuscules (a-z), des chiffres (0-9) et des traits d'union (-) et ne doit pas dépasser 63 caractères.
state

enum (State)

Uniquement en sortie. État du forfait de base (actif). Les forfaits de base brouillons et inactifs peuvent être activés ou supprimés. Les forfaits de base actifs peuvent être désactivés. Les forfaits de base inactifs peuvent être annulés. Ce champ ne peut pas être modifié en mettant à jour la ressource. Utilisez plutôt les points de terminaison dédiés.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informations spécifiques à la région pour ce forfait de base.
offerTags[]

object (OfferTag)

Liste contenant jusqu'à 20 tags personnalisés spécifiés pour ce forfait de base et renvoyée à l'application via la bibliothèque Billing. Les offres d'abonnement de ce forfait de base recevront également ces tags d'offre dans la bibliothèque de facturation.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Les informations tarifaires des nouvelles régions seront disponibles sur Play à l'avenir. S'il est omis, le forfait de base ne sera pas automatiquement disponible dans les nouveaux pays où Play pourrait être lancé à l'avenir.
Champ d'union base_plan_type. Type de ce forfait de base. Vous ne devez en définir qu'un seul. base_plan_type ne peut être qu'un des éléments suivants :
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Définissez les dates de renouvellement automatique du forfait de base à intervalle régulier.
prepaidBasePlanType

object (PrepaidBasePlanType)

Définissez les cas où le forfait de base ne se renouvelle pas automatiquement à la fin de la période de facturation.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Défini pour les forfaits de base par versements où un utilisateur s'engage à effectuer un nombre de paiements spécifié.

État

État actuel d'un forfait de base.

Enums
STATE_UNSPECIFIED État non spécifié.
DRAFT Le forfait de base est actuellement à l'état de brouillon et n'a pas été activé. À ce stade, vous pouvez la supprimer en toute sécurité.
ACTIVE Le forfait de base est actif et disponible pour les nouveaux abonnés.
INACTIVE Le forfait de base est inactif et n'est disponible que pour les abonnés existants.

AutoRenewingBasePlanType

Représente un forfait de base qui se renouvelle automatiquement à la fin de sa période d'abonnement.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Champs
billingPeriodDuration

string

Obligatoire. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide.
gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Les valeurs acceptables sont P0D (zéro jour), P3D (3 jours), P7J (7 jours), P14D (14 jours) et P30D (30 jours). Si aucune valeur n'est spécifiée, une valeur par défaut sera utilisée en fonction de la durée de la période récurrente.
accountHoldDuration

string

Facultatif. Période de blocage de compte de l'abonnement, spécifiée au format ISO 8601. Les valeurs acceptables doivent être comprises entre JOURS et P0D (zéro jour) et P30J (30 jours). Si aucune valeur n'est spécifiée, la valeur par défaut est P30D (30 jours).
resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs peuvent se réabonner à ce forfait de base sur les surfaces Google Play. Si aucune valeur n'est spécifiée, la valeur par défaut est RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Le mode de calcul au prorata pour le forfait de base détermine ce qui se passe lorsqu'un utilisateur passe à ce forfait à partir d'un autre forfait de base. Si aucune valeur n'est spécifiée, la valeur par défaut est CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indique si le forfait de base renouvelé est rétrocompatible.

Le forfait de base rétrocompatible est renvoyé par la méthode abandonnée querySkuDetailsAsync() de la Bibliothèque Google Play Billing.

Un seul forfait de base renouvelé peut être marqué comme compatible avec les anciennes versions pour un abonnement donné.
legacyCompatibleSubscriptionOfferId

string

ID de l'offre d'abonnement compatible avec les anciennes versions.

L'offre d'abonnement rétrocompatible est renvoyée par la méthode abandonnée querySkuDetailsAsync() de la Bibliothèque Google Play Billing.

Une seule offre d'abonnement peut être marquée comme compatible avec les anciennes versions pour un forfait de base à renouvellement donné.

Si vous ne souhaitez pas que votre offre d'abonnement soit compatible avec les anciennes versions, définissez ce champ sur une chaîne vide.

ResubscribeState

État du réabonnement du forfait de base.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED État non spécifié.
RESUBSCRIBE_STATE_ACTIVE Le réabonnement est actif.
RESUBSCRIBE_STATE_INACTIVE La fonctionnalité de réabonnement est inactive.

SubscriptionProrationMode

Mode de calcul au prorata utilisé pour renouveler les forfaits de base.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Mode non spécifié.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Le nouveau forfait de base des utilisateurs sera facturé à la fin de la période de facturation en cours.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Le nouveau forfait de base sera facturé aux utilisateurs immédiatement et dans leur intégralité. La durée restante de l'abonnement en cours sera utilisée pour prolonger la durée du nouveau forfait.

PrepaidBasePlanType

Représente un forfait de base qui ne se renouvelle pas automatiquement à la fin de celui-ci et qui doit être renouvelé manuellement par l'utilisateur.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Champs
billingPeriodDuration

string

Obligatoire. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide.
timeExtension

enum (TimeExtension)

Indique si les utilisateurs peuvent prolonger ce forfait de base prépayé sur les surfaces Google Play. Si aucune valeur n'est spécifiée, la valeur par défaut est TIME_EXTENSION_ACTIVE.

TimeExtension

Prolongation de la durée du forfait de base.

Enums
TIME_EXTENSION_UNSPECIFIED État non spécifié.
TIME_EXTENSION_ACTIVE Le prolongement de temps est actif. Les utilisateurs sont autorisés à créditer leur forfait prépayé ou à le prolonger.
TIME_EXTENSION_INACTIVE L'extension de temps est inactive. Les utilisateurs ne peuvent pas créditer leur forfait prépayé ni le prolonger.

InstallmentsBasePlanType

Représente un forfait de base de versements où un utilisateur s'engage à effectuer un nombre de paiements spécifié.

Représentation JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Champs
billingPeriodDuration

string

Obligatoire. Période d'abonnement, spécifiée au format ISO 8601. Pour obtenir la liste des périodes de facturation acceptées, consultez le centre d'aide.
committedPaymentsCount

integer

Obligatoire. Nombre de paiements pour lesquels l'utilisateur s'engage.
renewalType

enum (RenewalType)

Obligatoire. Type de renouvellement du forfait de base des versements. Détermine le comportement à la fin de l'engagement initial.
gracePeriodDuration

string

Délai de grâce de l'abonnement, spécifié au format ISO 8601. Les valeurs acceptables sont P0D (zéro jour), P3D (3 jours), P7J (7 jours), P14D (14 jours) et P30D (30 jours). Si aucune valeur n'est spécifiée, une valeur par défaut sera utilisée en fonction de la durée de la période récurrente.
accountHoldDuration

string

Facultatif. Période de blocage de compte pour l'abonnement, spécifiée exclusivement en jours et au format ISO 8601. Les valeurs acceptables vont de P0D (zéro jour) à P30D (30 jours). Si aucune valeur n'est spécifiée, la valeur par défaut est P30D (30 jours).
resubscribeState

enum (ResubscribeState)

Indique si les utilisateurs peuvent se réabonner à ce forfait de base sur les surfaces Google Play. Si aucune valeur n'est spécifiée, la valeur par défaut est RESUBSCRIBE_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

Le mode de calcul au prorata pour le forfait de base détermine ce qui se passe lorsqu'un utilisateur passe à ce forfait à partir d'un autre forfait de base. Si aucune valeur n'est spécifiée, la valeur par défaut est CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Type de renouvellement du forfait de base des versements. Détermine le comportement à la fin de l'engagement initial.

Enums
RENEWAL_TYPE_UNSPECIFIED État non spécifié.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Renouvellement périodique sans engagement pour la période de facturation.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Renouvellement avec l'engagement de la même durée que l'engagement initial.

RegionalBasePlanConfig

Configuration d'un forfait de base spécifique à une région.

Représentation JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Champs
regionCode

string

Obligatoire. Code de région auquel s'applique cette configuration, tel que défini par la norme ISO 3166-2, par exemple "US".
newSubscriberAvailability

boolean

Indique si le forfait de base dans la région spécifiée est disponible pour les nouveaux abonnés. L'abonnement des abonnés existants ne sera pas résilié si cette valeur est définie sur "false". Si aucune valeur n'est spécifiée, la valeur par défaut est "false".
price

object (Money)

Prix du forfait de base dans la région spécifiée. Doit être défini si le forfait de base est disponible pour les nouveaux abonnés. Doit être défini dans la devise associée à la région spécifiée.

OtherRegionsBasePlanConfig

Informations tarifaires pour tous les nouveaux pays dans lesquels Play peut être lancé.

Représentation JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Champs
usdPrice

object (Money)

Obligatoire. Prix en USD à utiliser dans toutes les nouvelles régions dans lesquelles Play peut être lancé.
eurPrice

object (Money)

Obligatoire. Prix en EUR à utiliser dans toutes les nouvelles régions dans lesquelles Play peut être lancé.
newSubscriberAvailability

boolean

Indique si le forfait de base est disponible pour les nouveaux abonnés dans de nouveaux pays où Play peut être lancé. Si aucune valeur n'est spécifiée, la valeur par défaut est "false".

SubscriptionListing

Métadonnées d'un abonnement visibles par le consommateur.

Représentation JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Champs
languageCode

string

Obligatoire. Langue de la fiche, telle que définie par la norme BCP-47 (par exemple, "en-US".
title

string

Obligatoire. Titre de cet abonnement dans la langue de cette fiche. Texte brut.
benefits[]

string

Liste des avantages présentée à l'utilisateur sur des plates-formes telles que le Play Store et dans les processus de restauration dans la langue de cette fiche. Texte brut. Liste numérotée de quatre avantages maximum.
description

string

Description de cet abonnement dans la langue de cette fiche. Ne doit pas dépasser 80 caractères. Texte brut.

RestrictedPaymentCountries

Pays où l'achat de ce produit est limité aux modes de paiement enregistrés dans le même pays. Si ce champ est vide, aucune restriction liée aux lieux de paiement n'est appliquée.

Représentation JSON 
{
  "regionCodes": [
    string
  ]
}
Champs
regionCodes[]

string

Obligatoire. Codes régionaux auxquels imposer des restrictions de paiement, tels que définis par la norme ISO 3166-2 (par exemple, "US".

Méthodes

archive
(deprecated)

 Obsolète: l'archivage des abonnements n'est pas disponible.

batchGet

 Lit un ou plusieurs abonnements.

batchUpdate

 Met à jour un lot d'abonnements.

create

 Crée un abonnement.

delete

 Supprime un abonnement.

get

 Lit un seul abonnement.

list

 Liste tous les abonnements associés à une application donnée.

patch

 Met à jour un abonnement existant.