REST Resource: purchases.subscriptionsv2

Ressource : SubscriptionPurchaseV2

Indique l'état de l'achat d'un abonnement par un utilisateur.

Représentation JSON
{
  "kind": string,
  "regionCode": string,
  "lineItems": [
    {
      object (SubscriptionPurchaseLineItem)
    }
  ],
  "startTime": string,
  "subscriptionState": enum (SubscriptionState),
  "linkedPurchaseToken": string,
  "pausedStateContext": {
    object (PausedStateContext)
  },
  "canceledStateContext": {
    object (CanceledStateContext)
  },
  "testPurchase": {
    object (TestPurchase)
  },
  "acknowledgementState": enum (AcknowledgementState),
  "externalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "subscribeWithGoogleInfo": {
    object (SubscribeWithGoogleInfo)
  },
  "etag": string,
  "outOfAppPurchaseContext": {
    object (OutOfAppPurchaseContext)
  },
  "onHoldStateContext": {
    object (OnHoldStateContext)
  },
  "inGracePeriodStateContext": {
    object (InGracePeriodStateContext)
  }
}
Champs
kind

string

Ce genre représente un objet SubscriptionPurchaseV2 dans le service androidpublisher.

regionCode

string

Code ISO 3166-1 alpha-2 du pays/de la région de facturation de l'utilisateur au moment de l'octroi de l'abonnement.

lineItems[]

object (SubscriptionPurchaseLineItem)

Informations au niveau de l'article pour l'achat d'un abonnement. Les articles d'un même achat doivent tous être associés à un AutoRenewingPlan ou à un PrepaidPlan.

startTime

string (Timestamp format)

Heure à laquelle l'abonnement a été accordé. Non défini pour les abonnements en attente (l'abonnement a été créé, mais le paiement est en attente lors de l'inscription).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

subscriptionState

enum (SubscriptionState)

État actuel de l'abonnement.

linkedPurchaseToken

string

Jeton d'achat de l'ancien abonnement si celui-ci correspond à l'un des cas suivants : * Réinscription à un abonnement résilié, mais non expiré * Passage à un niveau d'abonnement supérieur ou inférieur par rapport à un abonnement précédent. * Passer d'un forfait prépayé à un abonnement à renouvellement automatique * Passer d'un abonnement à renouvellement automatique à un abonnement prépayé * Recharger un abonnement prépayé

pausedStateContext

object (PausedStateContext)

Contexte supplémentaire concernant les abonnements suspendus. Uniquement présent si l'abonnement est actuellement à l'état SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Contexte supplémentaire sur les abonnements résiliés. Uniquement présent si l'abonnement est actuellement défini sur l'état SUBSCRIPTION_STATE_CANCELED ou SUBSCRIPTION_STATE_EXPIRED.

testPurchase

object (TestPurchase)

Présent uniquement si cet achat d'abonnement est un achat test.

acknowledgementState

enum (AcknowledgementState)

État de confirmation de l'abonnement.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Identifiant du compte utilisateur dans le service tiers.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Profil utilisateur associé aux achats effectués avec S'abonner avec Google.

etag

string

Tag d'entité représentant l'état actuel de l'abonnement. Le développeur fournira cet etag pour les actions d'abonnement. Cet etag est toujours présent pour les abonnements prépayés et à renouvellement automatique.

outOfAppPurchaseContext

object (OutOfAppPurchaseContext)

Contexte supplémentaire pour les achats hors application. Ces informations ne sont présentes que pour les réabonnements (achats d'abonnement effectués après l'expiration de l'abonnement précédent au même produit) effectués via le centre des abonnements Google Play. Ce champ sera supprimé une fois que vous aurez confirmé l'abonnement.

onHoldStateContext

object (OnHoldStateContext)

Facultatif. Contexte supplémentaire sur les abonnements à l'état ON_HOLD. Uniquement présent si l'abonnement est actuellement à l'état SUBSCRIPTION_STATE_ON_HOLD.

inGracePeriodStateContext

object (InGracePeriodStateContext)

Facultatif. Contexte supplémentaire concernant les abonnements à l'état IN_GRACE_PERIOD. Présent uniquement si l'abonnement est actuellement à l'état SUBSCRIPTION_STATE_IN_GRACE_PERIOD.

SubscriptionState

États potentiels d'un abonnement (par exemple, actif ou annulé). Les articles d'un achat d'abonnement peuvent être tous des forfaits à renouvellement automatique ou des forfaits prépayés.

Enums
SUBSCRIPTION_STATE_UNSPECIFIED État d'abonnement non spécifié.
SUBSCRIPTION_STATE_PENDING L'abonnement a été créé, mais le paiement est en attente lors de l'inscription. Dans cet état, tous les articles sont en attente de paiement.
SUBSCRIPTION_STATE_ACTIVE L'abonnement est actif. - (1) Si l'abonnement est un forfait à renouvellement automatique, au moins un élément est autoRenewEnabled et n'a pas expiré. - (2) Si l'abonnement est un forfait prépayé, au moins un élément n'a pas expiré.
SUBSCRIPTION_STATE_PAUSED Votre abonnement est suspendu. L'état n'est disponible que lorsque l'abonnement est un forfait à renouvellement automatique. Dans cet état, tous les éléments sont en pause.
SUBSCRIPTION_STATE_IN_GRACE_PERIOD L'abonnement est en délai de grâce. L'état n'est disponible que lorsque l'abonnement est un forfait à renouvellement automatique. Dans cet état, tous les éléments sont en période de grâce.
SUBSCRIPTION_STATE_ON_HOLD L'abonnement est en attente (suspendu). L'état n'est disponible que lorsque l'abonnement est un forfait à renouvellement automatique. Dans cet état, tous les éléments sont en attente.
SUBSCRIPTION_STATE_CANCELED L'abonnement est résilié, mais n'a pas encore expiré. L'état n'est disponible que lorsque l'abonnement est un forfait à renouvellement automatique. Tous les éléments ont la valeur "false" pour autoRenewEnabled.
SUBSCRIPTION_STATE_EXPIRED L'abonnement a expiré. Tous les éléments ont un expiryTime dans le passé.
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED La transaction en attente pour l'abonnement est annulée. Si cet achat en attente concernait un abonnement existant, utilisez linkedPurchaseToken pour obtenir l'état actuel de cet abonnement.

PausedStateContext

Informations spécifiques à un abonnement à l'état "Mis en pause".

Représentation JSON
{
  "autoResumeTime": string
}
Champs
autoResumeTime

string (Timestamp format)

Heure à laquelle l'abonnement sera automatiquement réactivé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CanceledStateContext

Informations spécifiques à un abonnement à l'état SUBSCRIPTION_STATE_CANCELED ou SUBSCRIPTION_STATE_EXPIRED.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of mutually exclusive fields.
}
Champs
Raison pour laquelle un abonnement a été résilié. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
userInitiatedCancellation

object (UserInitiatedCancellation)

L'abonnement a été résilié par l'utilisateur.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

L'abonnement a été résilié par le système, par exemple en raison d'un problème de facturation.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

L'abonnement a été résilié par le développeur.

replacementCancellation

object (ReplacementCancellation)

L'abonnement a été remplacé par un nouvel abonnement.

Fin des champs mutuellement exclusifs.

UserInitiatedCancellation

Informations spécifiques aux résiliations initiées par les utilisateurs.

Représentation JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Champs
cancelSurveyResult

object (CancelSurveyResult)

Informations fournies par l'utilisateur lorsqu'il termine la procédure de résiliation de l'abonnement (enquête sur le motif de la résiliation).

cancelTime

string (Timestamp format)

Heure à laquelle l'abonnement a été résilié par l'utilisateur. L'utilisateur peut toujours avoir accès à l'abonnement après cette date. Utilisez lineItems.expiry_time pour déterminer si un utilisateur a toujours accès au contenu.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

CancelSurveyResult

Résultat de l'enquête d'annulation lorsque l'abonnement a été annulé par l'utilisateur.

Représentation JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Champs
reason

enum (CancelSurveyReason)

Raison sélectionnée par l'utilisateur dans l'enquête sur l'annulation.

reasonUserInput

string

Défini uniquement pour CANCEL_SURVEY_REASON_OTHERS. Il s'agit de la réponse libre de l'utilisateur à l'enquête.

CancelSurveyReason

Raison sélectionnée par l'utilisateur dans l'enquête sur l'annulation.

Enums
CANCEL_SURVEY_REASON_UNSPECIFIED Motif d'annulation de l'enquête non spécifié.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE L'abonnement n'est pas assez utilisé.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Problèmes techniques lors de l'utilisation de l'application.
CANCEL_SURVEY_REASON_FOUND_BETTER_APP L'utilisateur a trouvé une meilleure application.
CANCEL_SURVEY_REASON_OTHERS Autres raisons.

SystemInitiatedCancellation

Ce type ne comporte aucun champ.

Informations spécifiques aux annulations initiées par le système Google.

DeveloperInitiatedCancellation

Ce type ne comporte aucun champ.

Informations spécifiques aux annulations initiées par les développeurs.

ReplacementCancellation

Ce type ne comporte aucun champ.

Informations spécifiques aux résiliations causées par le remplacement d'un abonnement.

TestPurchase

Ce type ne comporte aucun champ.

Indique si cet achat d'abonnement est un achat test.

AcknowledgementState

États de confirmation possibles pour un abonnement.

Enums
ACKNOWLEDGEMENT_STATE_UNSPECIFIED État d'accusé de réception non spécifié.
ACKNOWLEDGEMENT_STATE_PENDING L'abonnement n'est pas encore confirmé.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED L'abonnement est confirmé.

ExternalAccountIdentifiers

Identifiant du compte utilisateur dans le service tiers.

Représentation JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Champs
externalAccountId

string

Identifiant du compte utilisateur dans le service tiers. Présent uniquement si l'association de comptes a eu lieu dans le cadre du parcours d'achat de l'abonnement.

obfuscatedExternalAccountId

string

Version obscurcie de l'ID associé au seul compte de l'utilisateur dans votre application. Présent pour les achats suivants : * Si l'association de compte a eu lieu dans le cadre du parcours d'achat de l'abonnement. * Il a été spécifié à l'aide de https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid au moment de l'achat.

obfuscatedExternalProfileId

string

Version obscurcie de l'ID associé de manière unique au profil de l'utilisateur dans votre application. Uniquement présent si spécifié à l'aide de https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid lors de l'achat.

SubscribeWithGoogleInfo

Informations associées aux achats effectués avec S'abonner avec Google.

Représentation JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Champs
profileId

string

ID du profil Google de l'utilisateur lors de la souscription de l'abonnement.

profileName

string

Nom du profil de l'utilisateur lors de la souscription de l'abonnement.

emailAddress

string

Adresse e-mail de l'utilisateur lors de la souscription de l'abonnement.

givenName

string

Prénom de l'utilisateur lors de la souscription de l'abonnement.

familyName

string

Nom de famille de l'utilisateur lors de la souscription de l'abonnement.

SubscriptionPurchaseLineItem

Informations au niveau de l'article pour l'achat d'un abonnement.

Représentation JSON
{
  "productId": string,
  "expiryTime": string,
  "developerTargetedOffers": [
    {
      object (DeveloperTargetedOffer)
    }
  ],
  "latestSuccessfulOrderId": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of mutually exclusive fields.
  "offerDetails": {
    object (OfferDetails)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "deferredItemReplacement": {
    object (DeferredItemReplacement)
  },
  "deferredItemRemoval": {
    object (DeferredItemRemoval)
  }
  // End of mutually exclusive fields.
  "signupPromotion": {
    object (SignupPromotion)
  },
  "itemReplacement": {
    object (ItemReplacement)
  },
  "offerPhase": {
    object (OfferPhase)
  }
}
Champs
productId

string

ID du produit acheté (par exemple, "mensuel001").

expiryTime

string (Timestamp format)

Heure à laquelle l'abonnement a expiré ou expirera, sauf si l'accès est prolongé (par exemple, renouvelé).

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

developerTargetedOffers[]

object (DeveloperTargetedOffer)

Facultatif. Détails des offres destinées aux développeurs enregistrées pour cet élément de campagne.

latestSuccessfulOrderId

string

ID de la dernière commande réussie associée à cet article. Non présent si l'élément n'appartient pas encore à l'utilisateur (par exemple, l'élément différé est remplacé).

Type de forfait d'abonnement. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
autoRenewingPlan

object (AutoRenewingPlan)

L'article est renouvelé automatiquement.

prepaidPlan

object (PrepaidPlan)

L'article est prépayé.

Fin des champs mutuellement exclusifs.
offerDetails

object (OfferDetails)

Détails de l'offre pour cet article.

Le champ est présent lorsqu'un élément présente une modification différée. Vous pouvez la supprimer ou la remplacer. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
deferredItemReplacement

object (DeferredItemReplacement)

Informations sur le remplacement différé d'un article.

deferredItemRemoval

object (DeferredItemRemoval)

Informations sur la suppression différée d'un élément.

Fin des champs mutuellement exclusifs.
signupPromotion

object (SignupPromotion)

Informations sur la promotion concernant cet article. Défini uniquement si une promotion a été appliquée lors de l'inscription.

itemReplacement

object (ItemReplacement)

Détails de l'élément en cours de remplacement. Ce champ n'est renseigné que si cet article a remplacé un autre article dans un abonnement précédent. Il n'est disponible que pendant 60 jours après l'achat.

offerPhase

object (OfferPhase)

Détails de la phase d'offre actuelle pour cet article.

AutoRenewingPlan

Informations concernant un forfait à renouvellement automatique.

Représentation JSON
{
  "autoRenewEnabled": boolean,
  "recurringPrice": {
    object (Money)
  },
  "priceChangeDetails": {
    object (SubscriptionItemPriceChangeDetails)
  },
  "installmentDetails": {
    object (InstallmentPlan)
  },
  "planTransitionDetails": {
    object (PlanTransitionDetails)
  },
  "priceStepUpConsentDetails": {
    object (PriceStepUpConsentDetails)
  }
}
Champs
autoRenewEnabled

boolean

Si l'abonnement est actuellement configuré pour se renouveler automatiquement (par exemple, si l'utilisateur ne l'a pas résilié)

recurringPrice

object (Money)

Prix récurrent actuel du forfait à renouvellement automatique. Notez que le prix ne tient pas compte des remises et n'inclut pas les taxes. Pour les prix hors taxes, veuillez appeler l'API orders.get si vous avez besoin des détails de la transaction.

priceChangeDetails

object (SubscriptionItemPriceChangeDetails)

Informations sur le dernier changement de prix de l'article depuis l'inscription à l'abonnement.

installmentDetails

object (InstallmentPlan)

Informations sur l'engagement et l'état du plan de paiement par versements pour le forfait à renouvellement automatique.

planTransitionDetails

object (PlanTransitionDetails)

Informations sur la transition de forfait associée. Ce champ n'est présent que si un plan de transition est associé à ce plan. Il n'inclut que les derniers détails de transition associés à l'élément.

SubscriptionItemPriceChangeDetails

Informations sur le changement de prix d'un article d'abonnement.

Représentation JSON
{
  "newPrice": {
    object (Money)
  },
  "priceChangeMode": enum (PriceChangeMode),
  "priceChangeState": enum (PriceChangeState),
  "expectedNewPriceChargeTime": string
}
Champs
newPrice

object (Money)

Nouveau prix récurrent de l'article d'abonnement.

priceChangeMode

enum (PriceChangeMode)

Le mode de changement de prix spécifie comment le prix de l'élément d'abonnement est modifié.

priceChangeState

enum (PriceChangeState)

État actuel de la modification de prix.

expectedNewPriceChargeTime

string (Timestamp format)

Date de renouvellement à laquelle le changement de prix prendra effet pour l'utilisateur. Cette date peut être modifiée (repoussée) si la date de renouvellement change (par exemple, en cas de mise en pause). Ce champ n'est renseigné que si le changement de prix n'a pas pris effet.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

PriceChangeMode

Mode de modification du prix.

Enums
PRICE_CHANGE_MODE_UNSPECIFIED Mode de changement de prix non spécifié. Cette valeur ne doit jamais être définie.
PRICE_DECREASE Si le prix de l'abonnement diminue.
PRICE_INCREASE Si le prix de l'abonnement augmente et que l'utilisateur doit l'accepter.
OPT_OUT_PRICE_INCREASE Si le prix de l'abonnement augmente avec le mode d'opposition expresse.

PriceChangeState

État du changement de prix.

Enums
PRICE_CHANGE_STATE_UNSPECIFIED État du changement de prix non spécifié. Cette valeur ne doit pas être utilisée.
OUTSTANDING En attente de l'acceptation du changement de prix par l'utilisateur.
CONFIRMED Le changement de prix est confirmé pour l'utilisateur.
APPLIED Le changement de prix est appliqué, c'est-à-dire que le nouveau prix commence à être facturé à l'utilisateur.
CANCELED La modification du prix a été annulée.

InstallmentPlan

Informations sur un plan de paiement échelonné.

Représentation JSON
{
  "initialCommittedPaymentsCount": integer,
  "subsequentCommittedPaymentsCount": integer,
  "remainingCommittedPaymentsCount": integer,
  "pendingCancellation": {
    object (PendingCancellation)
  }
}
Champs
initialCommittedPaymentsCount

integer

Nombre total de paiements auxquels l'utilisateur s'est initialement engagé.

subsequentCommittedPaymentsCount

integer

Nombre total de paiements que l'utilisateur s'engage à effectuer après chaque période d'engagement. Si ce champ est vide, le plan de paiement par versements sera converti en abonnement à renouvellement automatique normal après l'engagement initial.

remainingCommittedPaymentsCount

integer

Nombre total de paiements engagés restants à payer pour ce cycle de renouvellement.

pendingCancellation

object (PendingCancellation)

Si ce champ est présent, cela signifie que ce plan de paiement échelonné est en attente d'annulation. La résiliation n'aura lieu qu'une fois que l'utilisateur aura effectué tous les paiements engagés.

PendingCancellation

Ce type ne comporte aucun champ.

Indique si une annulation est en attente sur le plan de paiement virtuel. La résiliation n'aura lieu qu'une fois que l'utilisateur aura effectué tous les paiements engagés.

PlanTransitionDetails

Informations concernant une transition de forfait.

Représentation JSON
{
  "productId": string,
  "basePlanId": string,
  "offerId": string,
  "transitionInfo": {
    object (TransitionInfo)
  }
}
Champs
productId

string

[Obligatoire] ID produit vers lequel ce forfait sera transféré (par exemple, "monthly001").

basePlanId

string

[Obligatoire] ID du forfait de base vers lequel ce forfait sera transféré.

offerId

string

ID d'offre. Présent uniquement pour les offres à prix réduit. Cette valeur n'est définie que si le forfait cible n'est pas un forfait de base.

transitionInfo

object (TransitionInfo)

Informations supplémentaires sur la transition de forfait programmée. Ne sera présent que si une transition de forfait a été planifiée.

TransitionInfo

Informations concernant une transition de forfait planifiée.

Représentation JSON
{
  "transitionState": enum (TransitionState),
  "price": {
    object (Money)
  },
  "expectedTransitionTime": string
}
Champs
transitionState

enum (TransitionState)

Uniquement en sortie. [Obligatoire] État actuel de la transition.

price

object (Money)

Prix du forfait de base par défaut vers lequel le forfait sera transféré.

expectedTransitionTime

string (Timestamp format)

Heure actuelle prévue à laquelle le plan peut être modifié. Cette date peut être modifiée (repoussée) en raison de cas où la date de renouvellement est décalée, comme une suspension ou un blocage de compte.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TransitionState

États potentiels d'une transition.

Enums
TRANSITION_STATE_UNSPECIFIED État de transition non spécifié.
SCHEDULED La transition est planifiée pour une date ultérieure.
IN_PROGRESS Le processus de transition a été lancé et la notification de transition initiale a été envoyée à l'utilisateur.
COMPLETED La transition est terminée.
CANCELED La transition a été annulée.

PriceStepUpConsentDetails

Informations concernant une augmentation de prix qui nécessite le consentement de l'utilisateur.

Représentation JSON
{
  "state": enum (ConsentState),
  "consentDeadlineTime": string,
  "newPrice": {
    object (Money)
  }
}
Champs
state

enum (ConsentState)

Uniquement en sortie. État du consentement à l'augmentation du prix.

consentDeadlineTime

string (Timestamp format)

Date limite à laquelle l'utilisateur doit donner son consentement. Si le consentement n'est pas fourni d'ici là, l'abonnement sera résilié.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

newPrice

object (Money)

Le nouveau prix qui nécessite le consentement utilisateur.

ConsentState

État du consentement à l'augmentation du prix.

Enums
CONSENT_STATE_UNSPECIFIED État du consentement non spécifié.
PENDING L'utilisateur n'a pas encore donné son consentement.
CONFIRMED L'utilisateur a donné son consentement, et le nouveau prix n'est pas encore entré en vigueur.
COMPLETED L'utilisateur a donné son consentement et le nouveau prix est entré en vigueur.

PrepaidPlan

Informations concernant un forfait prépayé.

Représentation JSON
{
  "allowExtendAfterTime": string
}
Champs
allowExtendAfterTime

string (Timestamp format)

Si ce paramètre est présent, il s'agit de l'heure après laquelle les achats de crédit sont autorisés pour le forfait prépayé. Ne sera pas présent pour les forfaits prépayés arrivés à expiration.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

OfferDetails

Informations sur les détails de l'offre liées à un élément de campagne d'achat.

Représentation JSON
{
  "offerTags": [
    string
  ],
  "basePlanId": string,
  "offerId": string
}
Champs
offerTags[]

string

Dernières balises d'offre associées à l'offre. Il inclut les tags hérités du forfait de base.

basePlanId

string

ID du forfait de base. Présent pour tous les forfaits de base et toutes les offres.

offerId

string

ID d'offre. Présent uniquement pour les offres à prix réduit.

DeferredItemReplacement

Informations sur le remplacement différé d'un article.

Représentation JSON
{
  "productId": string
}
Champs
productId

string

Le productId qui va remplacer le productId existant.

DeferredItemRemoval

Ce type ne comporte aucun champ.

Informations sur le remplacement différé d'un article.

SignupPromotion

Promotion appliquée à cet article lors de l'achat.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oneTimeCode": {
    object (OneTimeCode)
  },
  "vanityCode": {
    object (VanityCode)
  }
  // End of mutually exclusive fields.
}
Champs
Type de promotion appliqué à l'article. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
oneTimeCode

object (OneTimeCode)

Un code à usage unique a été appliqué.

vanityCode

object (VanityCode)

Un code personnalisé a été appliqué.

Fin des champs mutuellement exclusifs.

OneTimeCode

Ce type ne comporte aucun champ.

Code promotionnel à usage unique.

VanityCode

Code promotionnel prédéfini à usage multiple.

Représentation JSON
{
  "promotionCode": string
}
Champs
promotionCode

string

Code promotionnel.

ItemReplacement

Détails d'un élément de campagne d'abonnement en cours de remplacement.

Représentation JSON
{
  "productId": string,
  "replacementMode": enum (ReplacementMode),
  "basePlanId": string,
  "offerId": string
}
Champs
productId

string

ID produit de l'élément de campagne d'abonnement en cours de remplacement.

replacementMode

enum (ReplacementMode)

Mode de remplacement appliqué lors de l'achat.

basePlanId

string

ID du forfait de base de l'élément de campagne d'abonnement en cours de remplacement.

offerId

string

ID d'offre de l'élément de campagne d'abonnement en cours de remplacement, le cas échéant.

ReplacementMode

Mode de remplacement d'un abonnement.

Enums
REPLACEMENT_MODE_UNSPECIFIED Mode de remplacement non spécifié.
WITH_TIME_PRORATION Le nouveau forfait sera calculé au prorata et crédité à partir de l'ancien forfait.
CHARGE_PRORATED_PRICE Le prix du nouveau forfait sera facturé à l'utilisateur au prorata.
WITHOUT_PRORATION Le nouveau forfait remplacera l'ancien sans calcul au prorata de la durée.
CHARGE_FULL_PRICE Le prix total du nouveau forfait sera facturé à l'utilisateur.
DEFERRED L'ancien forfait sera résilié et le nouveau prendra effet à l'expiration de l'ancien.
KEEP_EXISTING Le plan restera inchangé avec ce remplacement.

OfferPhase

Détails de la phase de l'offre.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "prorationPeriod": {
    object (ProrationPeriodOfferPhase)
  },
  "freeTrial": {
    object (FreeTrialOfferPhase)
  },
  "introductoryPrice": {
    object (IntroductoryPriceOfferPhase)
  },
  "basePrice": {
    object (BasePriceOfferPhase)
  }
  // End of mutually exclusive fields.
}
Champs
Détails de la phase de l'offre. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
prorationPeriod

object (ProrationPeriodOfferPhase)

Défini lorsque la phase d'offre est une période de calcul au prorata.

freeTrial

object (FreeTrialOfferPhase)

Défini lorsque la phase de l'offre est un essai sans frais.

introductoryPrice

object (IntroductoryPriceOfferPhase)

Défini lorsque la phase de l'offre est une phase d'offre à prix découverte.

basePrice

object (BasePriceOfferPhase)

Défini lorsque la phase de l'offre est une phase de tarification du forfait de base.

Fin des champs mutuellement exclusifs.

ProrationPeriodOfferPhase

Détails sur la phase d'offre de la période de calcul au prorata.

Représentation JSON
{
  "originalOfferPhaseType": enum (OriginalOfferPhaseType)
}
Champs
originalOfferPhaseType

enum (OriginalOfferPhaseType)

Type de phase de l'offre d'origine avant la période de calcul au prorata. Défini uniquement lorsque la période de calcul au prorata est mise à jour à partir d'une phase d'offre existante.

OriginalOfferPhaseType

La phase d'offre d'origine du paiement de l'offre, si le paiement de l'offre est un paiement au prorata.

Enums
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED Type de phase d'offre d'origine non spécifié.
BASE L'abonnement est dans la phase de prix de base (par exemple, plein tarif).
INTRODUCTORY L'abonnement est dans une phase de prix découverte.
FREE_TRIAL L'abonnement est en période d'essai sans frais.

FreeTrialOfferPhase

Ce type ne comporte aucun champ.

Détails sur la phase d'offre d'essai sans frais.

IntroductoryPriceOfferPhase

Ce type ne comporte aucun champ.

Détails sur la phase de l'offre à prix découverte.

BasePriceOfferPhase

Ce type ne comporte aucun champ.

Détails sur la phase d'offre du prix de base.

DeveloperTargetedOffer

Informations sur une offre ciblant les développeurs pour un élément de campagne d'abonnement.

Représentation JSON
{
  "offerId": string,
  "activateTime": string
}
Champs
offerId

string

Facultatif. ID d'offre créée par le développeur et ciblée pour l'abonnement.

activateTime

string (Timestamp format)

Facultatif. Heure à laquelle le ciblage de l'offre a été activé.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

OutOfAppPurchaseContext

Informations spécifiques à un achat hors application.

Représentation JSON
{
  "expiredExternalAccountIdentifiers": {
    object (ExternalAccountIdentifiers)
  },
  "expiredPurchaseToken": string
}
Champs
expiredExternalAccountIdentifiers

object (ExternalAccountIdentifiers)

Identifiant du compte utilisateur du dernier abonnement arrivé à expiration pour ce SKU.

expiredPurchaseToken

string

Jeton d'achat du dernier abonnement arrivé à expiration. Ce jeton d'achat ne doit être utilisé que pour identifier l'utilisateur si le lien entre le purchaseToken et l'utilisateur est stocké dans votre base de données. Il ne peut pas être utilisé pour appeler l'API Google Developer si plus de 60 jours se sont écoulés depuis son expiration.

OnHoldStateContext

Contexte supplémentaire sur les abonnements à l'état ON_HOLD.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Champs
Raison pour laquelle l'abonnement est à l'état ON_HOLD. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
renewalDeclined

object (RenewalDeclinedContext)

Facultatif. Le paiement du renouvellement a été refusé.

Fin des champs mutuellement exclusifs.

RenewalDeclinedContext

Contexte lié au scénario de refus de renouvellement.

Représentation JSON
{
  "pendingOrderId": string
}
Champs
pendingOrderId

string

Obligatoire. ID de la commande en attente ou ayant échoué à l'origine de l'état.

InGracePeriodStateContext

Contexte supplémentaire concernant les abonnements à l'état IN_GRACE_PERIOD.

Représentation JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "renewalDeclined": {
    object (RenewalDeclinedContext)
  }
  // End of mutually exclusive fields.
}
Champs
Raison pour laquelle l'abonnement est à l'état IN_GRACE_PERIOD. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
renewalDeclined

object (RenewalDeclinedContext)

Facultatif. Le paiement du renouvellement a été refusé.

Fin des champs mutuellement exclusifs.

Méthodes

activateoffertargeting

Active le ciblage pour une offre spécifique.

cancel

Résilier un achat d'abonnement pour l'utilisateur.

cancelplantransition

Annuler une transition de forfait pour un abonnement.

deactivateoffertargeting

Désactive le ciblage pour une offre spécifique.

defer

Diffère le renouvellement d'un abonnement.

get

Obtenir les métadonnées d'un abonnement

revoke

Révoquer l'achat d'un abonnement pour l'utilisateur.

scheduleplantransition

Planifier une transition de forfait pour un abonnement.

Codes d'erreur

Les opérations de cette ressource renvoient les codes d'erreur HTTP suivants :

Code d'erreur Motif Description Solution
400 / 410 subscriptionExpired L'abonnement a expiré et l'opération demandée ne peut pas être effectuée. Vérifiez la date d'expiration de l'abonnement. Cette opération n'est pas autorisée sur les abonnements arrivés à expiration.
400 subscriptionInvalidArgument Un argument non valide a été fourni dans la requête d'abonnement. Consultez la documentation de l'API et assurez-vous que tous les champs obligatoires sont fournis et correctement formatés.
400 invalidPurchaseState L'état de l'achat n'est pas valide pour l'opération demandée. Par exemple, vous essayez peut-être de confirmer un achat déjà consommé ou de résilier un abonnement qui n'est pas actif. Vérifiez l'état actuel de la ressource à l'aide de l'API Get correspondante avant de tenter l'opération. Assurez-vous que la ressource est dans un état approprié pour l'action.
400 invalidValue Une valeur non valide a été fournie dans la requête. Cette erreur est souvent renvoyée pour un jeton d'achat incorrect ou non valide. Corrigez la valeur de champ non valide dans le corps ou les paramètres de la requête en fonction de la documentation de référence de l'API.
400 prepaidSubscriptionNotSupported L'opération demandée n'est pas compatible avec les abonnements prépayés. Assurez-vous que l'opération est applicable au type d'abonnement. Cette erreur est spécifique aux méthodes telles que Cancel.
400 productNotOwnedByUser Le jeton d'achat fourni est valide, mais l'utilisateur ne possède pas le produit actuellement. Cela peut se produire si l'achat a été remboursé, révoqué ou a expiré avant d'être confirmé. Vérifiez l'état actuel de la ressource à l'aide de l'API Get correspondante avant de tenter l'opération. Assurez-vous que la ressource est dans un état approprié pour l'action.
400 purchaseTokenMismatch Le jeton d'achat fourni ne correspond pas à l'achat, au nom du package, à l'ID d'abonnement ou à l'ID produit. Vérifiez que toutes les informations de la demande sont correctes et correspondent les unes aux autres.
400 required Un champ ou un paramètre obligatoire est manquant dans la requête. Consultez la documentation de l'API pour vous assurer que tous les champs et paramètres obligatoires sont inclus.
400 unsupportedIabType L'opération n'est pas disponible pour le type de facturation des achats in-app indiqué. Assurez-vous que la méthode API est compatible avec le type d'élément géré.
403 userInsufficientPermission L'utilisateur ne dispose pas des autorisations suffisantes pour effectuer l'opération demandée. Assurez-vous que l'utilisateur authentifié dispose des autorisations nécessaires dans la Google Play Console. Pour en savoir plus, consultez Utiliser un compte de service.
404 notFound La ressource demandée est introuvable. Vérifiez que les identifiants (par exemple, jeton d'achat, nom du package, ID produit, ID d'abonnement) sont corrects.
409 concurrentUpdate Une tentative de mise à jour d'un objet en cours de mise à jour a été effectuée. Réessayez d'envoyer la requête avec un intervalle exponentiel entre les tentatives. Évitez de modifier simultanément une même ressource.
410 purchaseTokenNoLongerValid Le jeton d'achat n'est définitivement plus valide, car le compte utilisateur associé a été supprimé ou l'enregistrement d'achat n'existe plus. Arrêtez d'utiliser ce jeton d'achat.
410 subscriptionNoLongerAvailable L'achat de l'abonnement n'est plus disponible pour la requête, car il a expiré depuis trop longtemps. Cette erreur indique que l'abonnement a expiré depuis plus de 60 jours. Vous ne devez plus interroger ces abonnements.
5xx Generic error Erreur générique sur le serveur Google Play. Réessayez d'envoyer votre requête.

Si le problème persiste, contactez votre responsable de compte Google Play ou envoyez une demande d'assistance. Consultez le tableau de bord d'état de Play pour vérifier si des pannes sont connues.