- Recurso: SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- InstallmentPlan
- PendingCancellation
- PlanTransitionDetails
- TransitionInfo
- TransitionState
- PriceStepUpConsentDetails
- ConsentState
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- DeferredItemRemoval
- SignupPromotion
- OneTimeCode
- VanityCode
- ItemReplacement
- ReplacementMode
- OfferPhase
- ProrationPeriodOfferPhase
- OriginalOfferPhaseType
- FreeTrialOfferPhase
- IntroductoryPriceOfferPhase
- BasePriceOfferPhase
- DeveloperTargetedOffer
- OutOfAppPurchaseContext
- OnHoldStateContext
- RenewalDeclinedContext
- InGracePeriodStateContext
- Métodos
Recurso: SubscriptionPurchaseV2
Indica el estado de la compra de una suscripción que hace un usuario.
| Representación JSON |
|---|
{ "kind": string, "regionCode": string, "lineItems": [ { object ( |
| Campos | |
|---|---|
kind |
Este tipo representa un objeto SubscriptionPurchaseV2 en el servicio androidpublisher. |
regionCode |
Es el código regional o de país de facturación (según ISO 3166-1 alpha-2) del usuario en el momento en que se otorgó la suscripción. |
lineItems[] |
Es la información a nivel del elemento para la compra de una suscripción. Todos los elementos de una misma compra deben estar establecidos como AutoRenewingPlan, o bien como PrepaidPlan. |
startTime |
Es la fecha y hora en la que se otorgó la suscripción. No se configura para las suscripciones pendientes (cuando se crea la suscripción, pero se espera el pago durante el registro). Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
subscriptionState |
Es el estado actual de la suscripción. |
linkedPurchaseToken |
Es el token de compra de la suscripción anterior si esta suscripción es una de las siguientes: * Nuevo registro de una suscripción cancelada pero no vencida * Cambio a una versión superior o inferior desde una suscripción anterior * Cambio de una suscripción prepagada a una con renovación automática * Cambio de una suscripción con renovación automática a una prepagada * Recarga de una suscripción prepagada |
pausedStateContext |
Es contexto adicional para las suscripciones pausadas. Solo está presente si la suscripción tiene el estado subscriptionState establecido como SUBSCRIPTION_STATE_PAUSED. |
canceledStateContext |
Es contexto adicional para las suscripciones canceladas. Solo está presente si la suscripción tiene el estado subscriptionState establecido como SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED. |
testPurchase |
Solo está presente si la compra de esta suscripción es de prueba. |
acknowledgementState |
Es el estado del procesamiento de compra de la suscripción. |
externalAccountIdentifiers |
Es el identificador de la cuenta de usuario en el servicio externo. |
subscribeWithGoogleInfo |
Es el perfil de usuario asociado a las compras realizadas con "Suscríbete con Google". |
etag |
Es la etiqueta de entidad que representa el estado actual de la suscripción. El desarrollador proporcionará esta ETag para que se pueda usar en acciones relacionadas con las suscripciones. Las suscripciones prepagadas y con renovación automática siempre tienen esta ETag. |
outOfAppPurchaseContext |
Es contexto adicional para las compras fuera de la app. Esta información solo está presente en las compras de renovaciones de suscripciones (compras de suscripciones realizadas después de que haya vencido la suscripción anterior del mismo producto) que se realizan a través del centro de suscripciones de Google Play. Este campo se quitará después de que confirmes la suscripción. |
onHoldStateContext |
Opcional. Es contexto adicional para las suscripciones en estado ON_HOLD. Solo está presente si la suscripción tiene el estado subscriptionState establecido como SUBSCRIPTION_STATE_ON_HOLD. |
inGracePeriodStateContext |
Opcional. Es contexto adicional para las suscripciones en estado IN_GRACE_PERIOD. Solo está presente si la suscripción tiene el estado subscriptionState establecido como SUBSCRIPTION_STATE_IN_GRACE_PERIOD. |
SubscriptionState
Son los estados posibles de una suscripción; por ejemplo, activa o cancelada. Los elementos de la compra de una suscripción pueden ser todos planes con renovación automática o planes prepagados.
| Enums | |
|---|---|
SUBSCRIPTION_STATE_UNSPECIFIED |
No se especificó el estado de la suscripción. |
SUBSCRIPTION_STATE_PENDING |
Se creó la suscripción, pero se espera el pago durante el registro. En este estado, todos los elementos están pendientes de pago. |
SUBSCRIPTION_STATE_ACTIVE |
La suscripción está activa. - (1) Si la suscripción es un plan con renovación automática, al menos un elemento tiene el estado autoRenewEnabled y no venció. - (2) Si la suscripción es un plan prepagado, al menos un elemento no venció. |
SUBSCRIPTION_STATE_PAUSED |
Se pausó la suscripción. Este estado solo se encuentra disponible cuando la suscripción es un plan con renovación automática. Todos los elementos están en pausa. |
SUBSCRIPTION_STATE_IN_GRACE_PERIOD |
La suscripción está en período de gracia. Este estado solo se encuentra disponible cuando la suscripción es un plan con renovación automática. Todos los elementos se encuentran en período de gracia. |
SUBSCRIPTION_STATE_ON_HOLD |
La suscripción está en espera (suspendida). Este estado solo se encuentra disponible cuando la suscripción es un plan con renovación automática. Todos los elementos se encuentran en espera. |
SUBSCRIPTION_STATE_CANCELED |
Se canceló la suscripción, pero todavía no venció. Este estado solo se encuentra disponible cuando la suscripción es un plan con renovación automática. Todos los elementos tienen el campo autoRenewEnabled establecido en falso. |
SUBSCRIPTION_STATE_EXPIRED |
Venció la suscripción. Todos los elementos tienen el campo expirationTime establecido como una fecha en el pasado. |
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED |
Se canceló la transacción pendiente para la suscripción. Si esta compra pendiente era para una suscripción existente, se debe usar linkedPurchaseToken para obtener el estado actual de esa suscripción. |
PausedStateContext
Es información específica sobre una suscripción en pausa.
| Representación JSON |
|---|
{ "autoResumeTime": string } |
| Campos | |
|---|---|
autoResumeTime |
Es la fecha y hora a la que se reanudará automáticamente la suscripción. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
CanceledStateContext
Es información específica sobre una suscripción con el estado SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "userInitiatedCancellation": { object ( |
| Campos | |
|---|---|
| Es el motivo por el que se canceló una suscripción. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
userInitiatedCancellation |
El usuario canceló la suscripción. |
systemInitiatedCancellation |
El sistema canceló la suscripción, por ejemplo, debido a un problema de facturación. |
developerInitiatedCancellation |
El desarrollador canceló la suscripción. |
replacementCancellation |
Se reemplazó la suscripción por una nueva. |
| Fin de los campos mutuamente excluyentes. | |
UserInitiatedCancellation
Es información específica sobre las cancelaciones que inician los usuarios.
| Representación JSON |
|---|
{
"cancelSurveyResult": {
object ( |
| Campos | |
|---|---|
cancelSurveyResult |
Es la información que proporciona el usuario cuando completa el flujo de cancelación de la suscripción (encuesta sobre el motivo de la cancelación). |
cancelTime |
Es la fecha y hora en la que el usuario canceló la suscripción. Es posible que, después de ese momento, el usuario aún tenga acceso a la suscripción. Para saber si esto es así, se debe usar lineItems.expiry_time. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
CancelSurveyResult
Es el resultado de la encuesta que se le realiza al usuario cuando cancela la suscripción.
| Representación JSON |
|---|
{
"reason": enum ( |
| Campos | |
|---|---|
reason |
Es el motivo que seleccionó el usuario en la encuesta sobre la cancelación. |
reasonUserInput |
Solo se establece para CANCEL_SURVEY_REASON_OTHERS. Es la respuesta de formato libre que ofrece el usuario en la encuesta. |
CancelSurveyReason
Es el motivo que seleccionó el usuario en la encuesta sobre la cancelación.
| Enums | |
|---|---|
CANCEL_SURVEY_REASON_UNSPECIFIED |
No se especificó el motivo de la cancelación en la encuesta. |
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE |
La suscripción no se usó lo suficiente. |
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES |
Surgieron problemas técnicos al usar la app. |
CANCEL_SURVEY_REASON_COST_RELATED |
Surgieron problemas con los costos. |
CANCEL_SURVEY_REASON_FOUND_BETTER_APP |
El usuario encontró una app mejor. |
CANCEL_SURVEY_REASON_OTHERS |
Los motivos fueron otros. |
SystemInitiatedCancellation
Este tipo no tiene campos.
Es información específica sobre las cancelaciones que inicia el sistema de Google.
DeveloperInitiatedCancellation
Este tipo no tiene campos.
Es información específica sobre las cancelaciones que inician los desarrolladores.
ReplacementCancellation
Este tipo no tiene campos.
Es información específica sobre las cancelaciones causadas por el reemplazo de la suscripción.
TestPurchase
Este tipo no tiene campos.
Indica si la compra de esta suscripción es de prueba.
AcknowledgementState
Son los posibles estados de procesamiento de compra de una suscripción.
| Enums | |
|---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
No se especificó el estado del procesamiento de compra. |
ACKNOWLEDGEMENT_STATE_PENDING |
Aún no se procesó la compra de la suscripción. |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
Se procesó la compra de la suscripción. |
ExternalAccountIdentifiers
Es el identificador de la cuenta de usuario en el servicio externo.
| Representación JSON |
|---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
| Campos | |
|---|---|
externalAccountId |
Es el identificador de la cuenta de usuario en el servicio externo. Solo está presente si la vinculación de la cuenta se llevó a cabo como parte del flujo de compra de la suscripción. |
obfuscatedExternalAccountId |
Es una versión ofuscada del ID que está asociado de forma única a la cuenta del usuario en tu app. Está presente para las compras en los siguientes casos: * La cuenta se vinculó como parte del flujo de compra de la suscripción. * Se usó https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid para especificar el campo cuando se realizó la compra. |
obfuscatedExternalProfileId |
Es una versión ofuscada del ID que está asociado de forma única al perfil del usuario en tu app. Solo está presente si se especificó con https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid cuando se realizó la compra. |
SubscribeWithGoogleInfo
Es información asociada a las compras realizadas con "Suscríbete con Google".
| Representación JSON |
|---|
{ "profileId": string, "profileName": string, "emailAddress": string, "givenName": string, "familyName": string } |
| Campos | |
|---|---|
profileId |
Es el ID del perfil de Google del usuario en el momento de la compra de la suscripción. |
profileName |
Es el nombre de perfil del usuario en el momento de la compra de la suscripción. |
emailAddress |
Es la dirección de correo electrónico del usuario en el momento de la compra de la suscripción. |
givenName |
Es el nombre de pila del usuario en el momento de la compra de la suscripción. |
familyName |
Es el apellido del usuario en el momento de la compra de la suscripción. |
SubscriptionPurchaseLineItem
Es la información a nivel del elemento para la compra de una suscripción.
| Representación JSON |
|---|
{ "productId": string, "expiryTime": string, "developerTargetedOffers": [ { object ( |
| Campos | |
|---|---|
productId |
Es el ID del producto comprado (por ejemplo, "monthly001"). |
expiryTime |
Es la fecha y hora en la que venció o vencerá la suscripción, a menos que se extienda el acceso (p. ej., se renueve). Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
developerTargetedOffers[] |
Opcional. Son los detalles de las ofertas orientadas a desarrolladores registradas para esta línea de pedido. |
latestSuccessfulOrderId |
Es el ID del pedido más reciente que se completó correctamente y que está asociado a este elemento. No está presente si el usuario aún no es propietario del elemento (p.ej., el elemento que se reemplazó de forma diferida). |
| Es el tipo de plan de suscripción. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
autoRenewingPlan |
El elemento se renueva automáticamente. |
prepaidPlan |
El elemento está prepagado. |
| Fin de los campos mutuamente excluyentes. | |
offerDetails |
Son los detalles de la oferta para este elemento. |
| Este campo está presente cuando un elemento tiene un cambio diferido. Se puede quitar o reemplazar. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
deferredItemReplacement |
Es información sobre el reemplazo diferido del elemento. |
deferredItemRemoval |
Es información sobre la eliminación diferida del elemento. |
| Fin de los campos mutuamente excluyentes. | |
signupPromotion |
Son los detalles de la promoción de este artículo. Solo se establece si se aplicó una promoción durante el registro. |
itemReplacement |
Son los detalles del elemento que se reemplazará. Este campo solo se completa si este elemento reemplazó a otro en una suscripción anterior y solo está disponible durante 60 días después de la fecha de compra. |
offerPhase |
Son los detalles de la fase de la oferta actual para este elemento. |
AutoRenewingPlan
Es información respecto de un plan con renovación automática.
| Representación JSON |
|---|
{ "autoRenewEnabled": boolean, "recurringPrice": { object ( |
| Campos | |
|---|---|
autoRenewEnabled |
La suscripción se encuentra configurada para renovarse automáticamente; p. ej., el usuario no la canceló. |
recurringPrice |
Es el precio recurrente actual del plan con renovación automática. Ten en cuenta que el precio no incluye descuentos ni impuestos. En el caso de los precios sin impuestos, llama a la API de |
priceChangeDetails |
Es la información del último cambio de precio del elemento desde el registro de la suscripción. |
installmentDetails |
Es el compromiso del plan de cuotas y la información relacionada con el estado del plan con renovación automática. |
planTransitionDetails |
Es la información sobre la transición del plan asociado. Solo está presente si el plan de la suscripción cuenta con un plan de transición asociado y solo incluye los detalles de la transición más reciente asociada con el elemento. |
priceStepUpConsentDetails |
Es la información del consentimiento ante el aumento de precio más reciente. |
SubscriptionItemPriceChangeDetails
Es información relacionada con el cambio de precio de un elemento de suscripción.
| Representación JSON |
|---|
{ "newPrice": { object ( |
| Campos | |
|---|---|
newPrice |
Es el nuevo precio recurrente del elemento de suscripción. |
priceChangeMode |
El modo de cambio de precio especifica cómo cambia el precio del elemento de suscripción. |
priceChangeState |
Es el estado en el que se encuentra el cambio de precio. |
expectedNewPriceChargeTime |
Es la fecha y hora de renovación en la que entrará en vigencia el cambio de precio para el usuario. Puede cambiar (a un momento futuro) en los casos en los que se modifique la fecha y hora de renovación, como cuando se realiza una pausa. Este campo solo se completa si no se aplicó el cambio de precio. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
PriceChangeMode
Es el modo del cambio de precio.
| Enums | |
|---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
No se especificó el modo del cambio de precio. Nunca se debe establecer este valor. |
PRICE_DECREASE |
Indica si el precio de la suscripción está disminuyendo. |
PRICE_INCREASE |
Indica si el precio de la suscripción está aumentando, y el usuario debe establecer si lo acepta. |
OPT_OUT_PRICE_INCREASE |
Indica si el precio de la suscripción está aumentando, y está disponible el modo de rechazo. |
PriceChangeState
Es el estado del cambio de precio.
| Enums | |
|---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
No se especificó el estado del cambio de precio. No se debe usar este valor. |
OUTSTANDING |
Se espera que el usuario acepte el cambio de precio. |
CONFIRMED |
Se confirmó que cambiará el precio para el usuario. |
APPLIED |
Se aplicó el cambio de precio, es decir, se le empezó a cobrar el precio nuevo al usuario. |
CANCELED |
Se canceló el cambio de precio. |
InstallmentPlan
Es información sobre un plan de cuotas.
| Representación JSON |
|---|
{
"initialCommittedPaymentsCount": integer,
"subsequentCommittedPaymentsCount": integer,
"remainingCommittedPaymentsCount": integer,
"pendingCancellation": {
object ( |
| Campos | |
|---|---|
initialCommittedPaymentsCount |
Es la cantidad total de pagos que el usuario se comprometió a realizar inicialmente. |
subsequentCommittedPaymentsCount |
Es la cantidad total de pagos que el usuario deberá realizar después de cada período de compromiso. Si está vacío, significa que el plan de cuotas volverá a ser una suscripción con renovación automática normal después del compromiso inicial. |
remainingCommittedPaymentsCount |
Es la cantidad total de pagos restantes que deben hacerse en este ciclo de renovación según el compromiso tomado. |
pendingCancellation |
Si está presente, significa que el plan de cuotas está pendiente de cancelación, y esta se producirá solo después de que el usuario termine de realizar todos los pagos a los que se comprometió. |
PendingCancellation
Este tipo no tiene campos.
Indica si hay una cancelación pendiente en el plan de cuotas virtual, y esta se producirá solo después de que el usuario termine de realizar todos los pagos a los que se comprometió.
PlanTransitionDetails
Es información relacionada con una transición de plan.
| Representación JSON |
|---|
{
"productId": string,
"basePlanId": string,
"offerId": string,
"transitionInfo": {
object ( |
| Campos | |
|---|---|
productId |
[Obligatorio] Es el ID del producto que tendría el plan después de la transición (por ejemplo, "monthly001"). |
basePlanId |
[Obligatorio] Es el ID de plan básico que tendría el plan después de la transición. |
offerId |
Es el ID de la oferta. Solo está presente para las ofertas con descuento. Este campo solo se establece si el plan de destino no es un plan básico. |
transitionInfo |
Es información adicional sobre la transición de plan programada. Solo estará presente si se programó una transición de plan. |
TransitionInfo
Es información relacionada con la transición de plan programada.
| Representación JSON |
|---|
{ "transitionState": enum ( |
| Campos | |
|---|---|
transitionState |
Solo salida. [Obligatorio] Es el estado actual de la transición. |
price |
Es el precio de plan básico predeterminado que tendrá el plan después de la transición. |
expectedTransitionTime |
Es la fecha y hora estimada actual en la que se realizaría la transición del plan. Puede cambiar (en un momento futuro) en los casos en los que se modifique el momento de renovación, como cuando se realiza una pausa o una suspensión de la cuenta. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
TransitionState
Son los estados posibles de una transición.
| Enums | |
|---|---|
TRANSITION_STATE_UNSPECIFIED |
No se especificó el estado de la transición. |
SCHEDULED |
La transición se programó para comenzar en una fecha futura. |
IN_PROGRESS |
Se inició el proceso de transición, y se envió la notificación correspondiente al usuario. |
COMPLETED |
Se completó la transición. |
CANCELED |
Se canceló la transición. |
PriceStepUpConsentDetails
Es información relacionada con un aumento de precio que requiere el consentimiento del usuario.
| Representación JSON |
|---|
{ "state": enum ( |
| Campos | |
|---|---|
state |
Solo salida. Es el estado del consentimiento para el aumento gradual del precio. |
consentDeadlineTime |
Es la fecha límite en la que el usuario debe proporcionar el consentimiento. Si no se proporciona el consentimiento para ese momento, se cancelará la suscripción. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
newPrice |
Es el precio nuevo que requiere el consentimiento del usuario. |
ConsentState
Es el estado del consentimiento para el aumento gradual del precio.
| Enums | |
|---|---|
CONSENT_STATE_UNSPECIFIED |
Indica que no se especificó el estado de consentimiento. |
PENDING |
El usuario aún no otorgó su consentimiento. |
CONFIRMED |
El usuario dio su consentimiento y el precio nuevo está esperando para entrar en vigencia. |
COMPLETED |
El usuario dio su consentimiento y el precio nuevo entró en vigencia. |
PrepaidPlan
Es información relacionada con un plan prepagado.
| Representación JSON |
|---|
{ "allowExtendAfterTime": string } |
| Campos | |
|---|---|
allowExtendAfterTime |
Si está presente, es la fecha y hora a partir de la cual se permitirán las compras de recargas del plan prepagado. No estará presente para los planes prepagados vencidos. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
OfferDetails
Es información detallada de una oferta relacionada con un concepto de la compra.
| Representación JSON |
|---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
| Campos | |
|---|---|
offerTags[] |
Son las etiquetas más recientes asociadas con la oferta. Incluyen etiquetas heredadas del plan básico. |
basePlanId |
Es el ID del plan básico. Está presente para todas las ofertas y planes básicos. |
offerId |
Es el ID de la oferta. Solo está presente para las ofertas con descuento. |
DeferredItemReplacement
Es información relacionada con el reemplazo diferido del elemento.
| Representación JSON |
|---|
{ "productId": string } |
| Campos | |
|---|---|
productId |
Es el campo productId que reemplazará al existente. |
DeferredItemRemoval
Este tipo no tiene campos.
Es información relacionada con el reemplazo diferido del elemento.
SignupPromotion
Es la promoción que se aplicó a este artículo cuando se compró.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "oneTimeCode": { object ( |
| Campos | |
|---|---|
| Es el tipo de promoción que se aplica al artículo. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
oneTimeCode |
Se aplicó un código de un solo uso. |
vanityCode |
Se aplicó un código personalizado. |
| Fin de los campos mutuamente excluyentes. | |
OneTimeCode
Este tipo no tiene campos.
Un código promocional de un solo uso
VanityCode
Es un código promocional predefinido de uso múltiple.
| Representación JSON |
|---|
{ "promotionCode": string } |
| Campos | |
|---|---|
promotionCode |
Es el código promocional. |
ItemReplacement
Son los detalles de un elemento de suscripción que se está reemplazando.
| Representación JSON |
|---|
{
"productId": string,
"replacementMode": enum ( |
| Campos | |
|---|---|
productId |
Es el ID del producto de la línea de pedido de suscripción que se reemplazará. |
replacementMode |
Es el modo de reemplazo que se aplicó durante la compra. |
basePlanId |
Es el ID del plan básico de la línea de pedido de suscripción que se reemplazará. |
offerId |
Es el ID de la oferta de la línea de pedido de suscripción que se reemplazará, si corresponde. |
ReplacementMode
Es el modo de reemplazo de una suscripción.
| Enums | |
|---|---|
REPLACEMENT_MODE_UNSPECIFIED |
No se especificó el modo de reemplazo. |
WITH_TIME_PRORATION |
El nuevo plan se prorrateará y se acreditará desde el plan anterior. |
CHARGE_PRORATED_PRICE |
Se le cobrará al usuario un precio prorrateado por el plan nuevo. |
WITHOUT_PRORATION |
El plan nuevo reemplazará al anterior sin prorratear el tiempo. |
CHARGE_FULL_PRICE |
Se le cobrará al usuario el precio total del plan nuevo. |
DEFERRED |
Se cancelará el plan anterior y el nuevo entrará en vigencia después de que venza el anterior. |
KEEP_EXISTING |
El plan no cambiará con este reemplazo. |
OfferPhase
Son los detalles de la fase de la oferta.
| Representación JSON |
|---|
{ // The following is a list of mutually exclusive fields. At most one of the // fields will be set in a response: "prorationPeriod": { object ( |
| Campos | |
|---|---|
| Son los detalles de la fase de la oferta. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
prorationPeriod |
Se establece cuando la fase de la oferta es un período de prorrateo. |
freeTrial |
Se establece cuando la fase de la oferta es una prueba gratuita. |
introductoryPrice |
Se establece cuando la fase de la oferta es una fase de oferta de precio de lanzamiento. |
basePrice |
Se establece cuando la fase de la oferta es una fase de precios del plan básico. |
| Fin de los campos mutuamente excluyentes. | |
ProrationPeriodOfferPhase
Detalles sobre la fase de oferta del período de prorrateo.
| Representación JSON |
|---|
{
"originalOfferPhaseType": enum ( |
| Campos | |
|---|---|
originalOfferPhaseType |
Es el tipo de fase de la oferta original antes del período de prorrateo. Solo se establece cuando el período de prorrateo se actualiza desde una fase de oferta existente. |
OriginalOfferPhaseType
Es la fase de la oferta original del pago de la oferta, si este es un pago prorrateado.
| Enums | |
|---|---|
ORIGINAL_OFFER_PHASE_TYPE_UNSPECIFIED |
Indica que no se especificó el tipo de fase de la oferta original. |
BASE |
La suscripción se encuentra en la fase de precio base (p.ej., precio completo). |
INTRODUCTORY |
La suscripción se encuentra en una fase de precio de lanzamiento. |
FREE_TRIAL |
La suscripción está en un período de prueba gratuita. |
FreeTrialOfferPhase
Este tipo no tiene campos.
Son detalles sobre la fase de la oferta de prueba gratuita.
IntroductoryPriceOfferPhase
Este tipo no tiene campos.
Son detalles sobre la fase de la oferta de precio de lanzamiento.
BasePriceOfferPhase
Este tipo no tiene campos.
Detalles sobre la fase de oferta de precio base.
DeveloperTargetedOffer
Es información sobre una oferta dirigida a desarrolladores para un elemento de una suscripción.
| Representación JSON |
|---|
{ "offerId": string, "activateTime": string } |
| Campos | |
|---|---|
offerId |
Opcional. Es el ID de la oferta creada por el desarrollador para la suscripción. |
activateTime |
Opcional. Es la hora en que se activó la segmentación de la oferta. Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: |
OutOfAppPurchaseContext
Es información específica sobre una compra fuera de la app.
| Representación JSON |
|---|
{
"expiredExternalAccountIdentifiers": {
object ( |
| Campos | |
|---|---|
expiredExternalAccountIdentifiers |
Es el identificador de la cuenta de usuario de la última suscripción vencida para este SKU. |
expiredPurchaseToken |
Es el token de compra de la última suscripción vencida. Este token de compra solo se debe usar para ayudar a identificar al usuario si el vínculo entre el purchaseToken y el usuario se almacena en tu base de datos. No se puede usar para llamar a la API de Google Developer si transcurrieron más de 60 días desde el vencimiento. |
OnHoldStateContext
Es contexto adicional para las suscripciones en estado ON_HOLD.
| Representación JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"renewalDeclined": {
object ( |
| Campos | |
|---|---|
| Es el motivo por el que la suscripción está en estado ON_HOLD. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
renewalDeclined |
Opcional. Se rechazó el pago de la renovación. |
| Fin de los campos mutuamente excluyentes. | |
RenewalDeclinedContext
Contexto relacionado con la situación de rechazo de la renovación.
| Representación JSON |
|---|
{ "pendingOrderId": string } |
| Campos | |
|---|---|
pendingOrderId |
Obligatorio. Es el ID del pedido pendiente o con errores que causa el estado. |
InGracePeriodStateContext
Es contexto adicional para las suscripciones en estado IN_GRACE_PERIOD.
| Representación JSON |
|---|
{
// The following is a list of mutually exclusive fields. At most one of the
// fields will be set in a response:
"renewalDeclined": {
object ( |
| Campos | |
|---|---|
| Es el motivo por el que la suscripción se encuentra en el estado IN_GRACE_PERIOD. La siguiente es una lista de campos mutuamente excluyentes. Como máximo, se establecerá uno de los campos en una respuesta: | |
renewalDeclined |
Opcional. Se rechazó el pago de la renovación. |
| Fin de los campos mutuamente excluyentes. | |
Métodos |
|
|---|---|
|
Activa la segmentación para una oferta específica. |
|
Cancela la compra de una suscripción para el usuario. |
|
Cancela una transición de plan para una suscripción. |
|
Desactiva la segmentación para una oferta específica. |
|
Difiere la renovación de una suscripción. |
|
Obtiene metadatos sobre una suscripción. |
|
Revoca la compra de una suscripción para el usuario. |
|
Programa una transición de plan para una suscripción. |
Códigos de error
Las operaciones de este recurso devuelven los siguientes códigos de error de HTTP:
| Código de error | Motivo | Descripción | Solución |
|---|---|---|---|
400 / 410 |
subscriptionExpired |
La suscripción venció y no se puede realizar la operación solicitada. | Verifica la hora de vencimiento de la suscripción. No se permite esta operación en suscripciones vencidas. |
400 |
subscriptionInvalidArgument |
Se proporcionó un argumento no válido en la solicitud de la suscripción. | Revisa la documentación de la API y asegúrate de que se proporcionen todos los campos obligatorios y de que tengan el formato correcto. |
400 |
invalidPurchaseState |
La compra no tiene un estado válido para realizar la operación solicitada. Por ejemplo, es posible que estés intentando confirmar una compra ya consumida o cancelar una suscripción que no está activa. | Verifica el estado actual del recurso con la API Get correspondiente antes de intentar la operación. Asegúrate de que el recurso esté en un estado adecuado para la acción. |
400 |
invalidValue |
Se proporcionó un valor no válido en la solicitud. Esto suele mostrarse cuando el token de compra tiene un formato incorrecto o no es válido. | Corrige el valor del campo no válido en el cuerpo o los parámetros de la solicitud según la referencia de la API. |
400 |
prepaidSubscriptionNotSupported |
No se admite la operación solicitada para las suscripciones prepagadas. | Asegúrate de que la operación sea aplicable al tipo de suscripción. Este error es específico de métodos como Cancel. |
400 |
productNotOwnedByUser |
El token de compra proporcionado es válido, pero el usuario no es propietario del producto en este momento. Esto puede suceder si la compra se reembolsó, se revocó o venció antes de la confirmación. | Verifica el estado actual del recurso con la API Get correspondiente antes de intentar la operación. Asegúrate de que el recurso esté en un estado adecuado para la acción. |
400 |
purchaseTokenMismatch |
El token de compra proporcionado no coincide con la compra, el nombre del paquete, el ID de suscripción ni el ID del producto. | Verifica que todos los detalles de la solicitud sean correctos y se correspondan entre sí. |
400 |
required |
Falta un campo o parámetro obligatorio en la solicitud. | Consulta la documentación de la API para asegurarte de que se incluyan todos los campos y parámetros obligatorios. |
400 |
unsupportedIabType |
No se admite la operación para el tipo de Facturación integrada en la aplicación proporcionado. | Asegúrate de que el método de la API sea compatible con el tipo de artículo que se administra. |
403 |
userInsufficientPermission |
El usuario no tiene permisos suficientes para realizar la operación solicitada. | Asegúrate de que el usuario autenticado tenga los permisos necesarios en Google Play Console. Consulta Usa una cuenta de servicio para obtener más detalles. |
404 |
notFound |
No se encontró el recurso solicitado. | Verifica que los identificadores (p.ej., el token de compra, el nombre del paquete, el ID del producto y el ID de suscripción) sean correctos. |
409 |
concurrentUpdate |
Se intentó actualizar un objeto que se está actualizando de forma simultánea. | Vuelve a intentar la solicitud con una retirada exponencial. Evita las modificaciones simultáneas en el mismo recurso. |
410 |
purchaseTokenNoLongerValid |
El token de compra no es válido de forma permanente porque se borró la cuenta de usuario asociada o ya no existe el registro de compra. | Deja de usar este token de compra. |
410 |
subscriptionNoLongerAvailable |
La compra de la suscripción ya no está disponible para la consulta porque venció hace demasiado tiempo. | Este error indica que la suscripción venció hace más de 60 días. Ya no deberías consultar estas suscripciones. |
5xx |
Generic error |
Se produjo un error genérico en el servidor de Google Play. | Vuelve a intentar ejecutar la solicitud. Si el problema persiste, comunícate con tu administrador de cuentas de Google Play o envía una solicitud de asistencia. Considera consultar el Panel de estado de Play para ver si hay interrupciones conocidas. |