- Recurso: SubscriptionPurchaseV2
- SubscriptionState
- PausedStateContext
- CanceledStateContext
- UserInitiatedCancellation
- CancelSurveyResult
- CancelSurveyReason
- SystemInitiatedCancellation
- DeveloperInitiatedCancellation
- ReplacementCancellation
- TestPurchase
- AcknowledgementState
- ExternalAccountIdentifiers
- SubscribeWithGoogleInfo
- SubscriptionPurchaseLineItem
- AutoRenewingPlan
- SubscriptionItemPriceChangeDetails
- PriceChangeMode
- PriceChangeState
- InstallmentPlan
- PendingCancellation
- PrepaidPlan
- OfferDetails
- DeferredItemReplacement
- Métodos
Recurso: SubscriptionPurchaseV2
Indica el estado de la compra de la suscripción de 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 de país o región de facturación ISO 3166-1 alpha-2 del usuario al momento de otorgar la suscripción. |
lineItems[] |
Información a nivel del artículo para la compra de una suscripción. Todos los artículos de la misma compra deben estar todos con AutoRenewingPlan o todos con PrepaidPlan. |
startTime |
Hora en la que se otorgó la suscripción. No se configuró para las suscripciones pendientes (la suscripción se creó, pero está esperando el pago durante el registro). Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
subscriptionState |
Estado actual de la suscripción. |
latestOrderId |
Es el ID de pedido del último pedido asociado con la compra de la suscripción. Para la renovación automática de suscripciones, es el ID del pedido de registro, si aún no se renovó, o el ID del último pedido recurrente (pedido exitoso, pendiente o rechazado). Para la suscripción prepagada, es el ID de pedido asociado con el token de compra consultado. |
linkedPurchaseToken |
El token de compra de la suscripción anterior, si esta es uno de los siguientes: * Nuevo registro de una suscripción cancelada pero no vencida * Actualización o cambio a una versión inferior de una suscripción anterior. * Cámbiate de una suscripción prepagada a una de renovación automática. * Cámbiate de una suscripción con renovación automática a una prepagada. * Recarga una suscripción prepagada. |
pausedStateContext |
Contexto adicional sobre las suscripciones pausadas. Solo está presente si la suscripción tiene el estado subscriptionState SUBSCRIPTION_STATE_PALOCATION. |
canceledStateContext |
Contexto adicional sobre las suscripciones canceladas. Solo está presente si la suscripción tiene el estado subscriptionState SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED. |
testPurchase |
Solo está presente si la compra de esta suscripción es una compra de prueba. |
acknowledgementState |
El estado de confirmación de la suscripción. |
externalAccountIdentifiers |
Es el identificador de cuenta de usuario en el servicio de terceros. |
subscribeWithGoogleInfo |
Perfil de usuario asociado con las compras realizadas con "Suscríbete con Google". |
SubscriptionState
Los estados potenciales en los que puede estar una suscripción, por ejemplo, si está activa o cancelada Los elementos de la compra de una suscripción pueden ser todos planes con renovación automática o planes prepagados.
Enumeradores | |
---|---|
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 artículos 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, no haya vencido al menos un artículo. |
SUBSCRIPTION_STATE_PAUSED |
Se pausó la suscripción. El estado solo está disponible cuando la suscripción es un plan con renovación automática. En este estado, todos los elementos se encuentran detenidos. |
SUBSCRIPTION_STATE_IN_GRACE_PERIOD |
La suscripción está en período de gracia. El estado solo está disponible cuando la suscripción es un plan con renovación automática. En este estado, todos los elementos se encuentran en período de gracia. |
SUBSCRIPTION_STATE_ON_HOLD |
La suscripción está suspendida (suspendida). El estado solo está disponible cuando la suscripción es un plan con renovación automática. En este estado, todos los elementos están en espera. |
SUBSCRIPTION_STATE_CANCELED |
Se canceló la suscripción, pero todavía no venció. El estado solo está disponible cuando la suscripción es un plan con renovación automática. Todos los elementos tienen autoRenewEnabled establecido en falso. |
SUBSCRIPTION_STATE_EXPIRED |
La suscripción venció. Todos los artículos tienen un expirationTime en el pasado. |
SUBSCRIPTION_STATE_PENDING_PURCHASE_CANCELED |
Se canceló la transacción pendiente de suscripción. Si esta compra pendiente era para una suscripción existente, usa linkedPurchaseToken para obtener el estado actual de esa suscripción. |
PausedStateContext
Información específica de una suscripción en estado de pausa.
Representación JSON |
---|
{ "autoResumeTime": string } |
Campos | |
---|---|
autoResumeTime |
Hora a la que se reanudará automáticamente la suscripción. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
CanceledStateContext
Información específica de una suscripción con el estado SUBSCRIPTION_STATE_CANCELED o SUBSCRIPTION_STATE_EXPIRED.
Representación JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de unión cancellation_reason . Indica el motivo por el que se canceló una suscripción. Las direcciones (cancellation_reason ) solo pueden ser una de las siguientes opciones: |
|
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 |
La suscripción se reemplazó por una nueva. |
UserInitiatedCancellation
Información específica de las cancelaciones que inician los usuarios.
Representación JSON |
---|
{
"cancelSurveyResult": {
object ( |
Campos | |
---|---|
cancelSurveyResult |
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 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. Usa lineItems.expiry_time para determinar si un usuario aún tiene acceso. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
CancelSurveyResult
Resultado de la encuesta de cancelación cuando el usuario canceló la suscripción.
Representación JSON |
---|
{
"reason": enum ( |
Campos | |
---|---|
reason |
Es el motivo por el que el usuario seleccionó en la encuesta de cancelación. |
reasonUserInput |
Solo se establece para CANCEL_SURVEY_REASON_OTHERS. Esta es la respuesta de formato libre del usuario a la encuesta. |
CancelSurveyReason
Es el motivo por el que el usuario seleccionó en la encuesta de cancelación.
Enumeradores | |
---|---|
CANCEL_SURVEY_REASON_UNSPECIFIED |
No se especificó el motivo de la cancelación de la encuesta. |
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE |
No hay suficiente uso de la suscripción. |
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES |
Problemas técnicos mientras se usa la app |
CANCEL_SURVEY_REASON_COST_RELATED |
Problemas relacionados con los costos. |
CANCEL_SURVEY_REASON_FOUND_BETTER_APP |
El usuario encontró una app mejor. |
CANCEL_SURVEY_REASON_OTHERS |
Otros motivos. |
SystemInitiatedCancellation
Este tipo no tiene campos.
Información específica de las cancelaciones que inicia el sistema de Google.
DeveloperInitiatedCancellation
Este tipo no tiene campos.
Información específica de las cancelaciones que inician los desarrolladores.
ReplacementCancellation
Este tipo no tiene campos.
Información específica sobre las cancelaciones causadas por el reemplazo de una suscripción.
TestPurchase
Este tipo no tiene campos.
Indica si la compra de esta suscripción es una compra de prueba.
AcknowledgementState
Son los posibles estados de confirmación de una suscripción.
Enumeradores | |
---|---|
ACKNOWLEDGEMENT_STATE_UNSPECIFIED |
Estado de confirmación no especificado. |
ACKNOWLEDGEMENT_STATE_PENDING |
Aún no se confirmó la suscripción. |
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED |
Se confirmó la suscripción. |
ExternalAccountIdentifiers
Es el identificador de cuenta de usuario en el servicio de terceros.
Representación JSON |
---|
{ "externalAccountId": string, "obfuscatedExternalAccountId": string, "obfuscatedExternalProfileId": string } |
Campos | |
---|---|
externalAccountId |
Es el identificador de cuenta de usuario en el servicio de terceros. Solo está presente si la vinculación de cuentas se realizó como parte del flujo de compra de la suscripción. |
obfuscatedExternalAccountId |
Es una versión ofuscada del ID que está asociada de forma exclusiva con la cuenta del usuario en tu app. Presenta en las siguientes compras: * Si la vinculación de la cuenta se realizó como parte del flujo de compra de la suscripción. * Se especificó con https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedaccountid cuando se realizó la compra. |
obfuscatedExternalProfileId |
Es una versión ofuscada del ID que está asociada de forma exclusiva con el perfil del usuario en tu app. Solo está presente si se especifica mediante https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#setobfuscatedprofileid cuando se realiza la compra. |
SubscribeWithGoogleInfo
Información asociada con las compras realizadas con "Suscríbete con Google".
Representación JSON |
---|
{ "profileId": string, "profileName": string, "emailAddress": string, "givenName": string, "familyName": string } |
Campos | |
---|---|
profileId |
Indica el ID de perfil de Google del usuario cuando se compró la suscripción. |
profileName |
Es el nombre de perfil del usuario cuando se compró la suscripción. |
emailAddress |
Es la dirección de correo electrónico del usuario cuando se compró la suscripción. |
givenName |
Indica el nombre del usuario cuando se compró la suscripción. |
familyName |
Es el nombre de familia del usuario cuando se compró la suscripción. |
SubscriptionPurchaseLineItem
Información a nivel del artículo para la compra de una suscripción.
Representación JSON |
---|
{ "productId": string, "expiryTime": string, // Union field |
Campos | |
---|---|
productId |
Indica el ID del producto comprado (por ejemplo, "mensual001"). |
expiryTime |
Hora en la que la suscripción venció o vencerá, a menos que se extienda el acceso (p. ej., se renueve). Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
Campo de unión plan_type . Es el tipo de plan de suscripción. Las direcciones (plan_type ) solo pueden ser una de las siguientes opciones: |
|
autoRenewingPlan |
El elemento se renovará automáticamente. |
prepaidPlan |
Este elemento está prepagado. |
offerDetails |
Son los detalles de la oferta de este artículo. |
Campo de unión deferred_item_change . El campo está presente cuando un elemento tiene un cambio diferido. Se puede quitar o reemplazar. Las direcciones (deferred_item_change ) solo pueden ser una de las siguientes opciones: |
|
deferredItemReplacement |
Información para el reemplazo diferido de los artículos. |
AutoRenewingPlan
Información relacionada con un plan con renovación automática.
Representación JSON |
---|
{ "autoRenewEnabled": boolean, "priceChangeDetails": { object ( |
Campos | |
---|---|
autoRenewEnabled |
Si la suscripción está configurada para renovarse automáticamente, p.ej., el usuario no canceló la suscripción |
priceChangeDetails |
Es la información del último cambio de precio del artículo desde el registro de la suscripción. |
installmentDetails |
El compromiso del plan de cuotas y la información relacionada con el estado del plan de renovación automática |
SubscriptionItemPriceChangeDetails
Información relacionada con el cambio de precio de un elemento de suscripción.
Representación JSON |
---|
{ "newPrice": { object ( |
Campos | |
---|---|
newPrice |
Nuevo precio recurrente para el elemento de suscripción. |
priceChangeMode |
El modo de cambio de precio especifica cómo cambia el precio del elemento de suscripción. |
priceChangeState |
Indica en este momento el cambio de precio. |
expectedNewPriceChargeTime |
Es la hora de renovación en la que el cambio de precio entrará en vigencia para el usuario. Esto está sujeto a cambios(en un momento futuro) debido a casos en los que el horario de renovación cambia, como una pausa. Este campo solo se propaga si no se aplicó el cambio de precio. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
PriceChangeMode
El modo del cambio de precio.
Enumeradores | |
---|---|
PRICE_CHANGE_MODE_UNSPECIFIED |
Modo de cambio de precio sin especificar. Nunca se debe establecer este valor. |
PRICE_DECREASE |
Si el precio de la suscripción disminuye. |
PRICE_INCREASE |
Si el precio de la suscripción aumenta y el usuario debe aceptarla. |
OPT_OUT_PRICE_INCREASE |
Si el precio de la suscripción aumenta con el modo de inhabilitación |
PriceChangeState
Es el estado del cambio de precio.
Enumeradores | |
---|---|
PRICE_CHANGE_STATE_UNSPECIFIED |
Estado del cambio de precio sin especificar. No se debe usar este valor. |
OUTSTANDING |
Se debe esperar a que el usuario acepte el cambio de precio. |
CONFIRMED |
Se confirma que el cambio de precio ocurrió para el usuario. |
APPLIED |
Se aplica el cambio de precio, es decir, se le comenzó a cobrar el precio nuevo al usuario. |
InstallmentPlan
Información para un plan de cuotas.
Representación JSON |
---|
{
"initialCommittedPaymentsCount": integer,
"subsequentCommittedPaymentsCount": integer,
"remainingCommittedPaymentsCount": integer,
"pendingCancellation": {
object ( |
Campos | |
---|---|
initialCommittedPaymentsCount |
Cantidad total de pagos por los que el usuario se compromete inicialmente. |
subsequentCommittedPaymentsCount |
Cantidad total de pagos que se comprometerá al usuario después de cada período de compromiso. Si está vacío, el plan de cuotas volverá a ser una suscripción con renovación automática normal después del compromiso inicial. |
remainingCommittedPaymentsCount |
Cantidad total de pagos comprometidos que quedan por pagar en este ciclo de renovación. |
pendingCancellation |
Si está presente, este plan de cuotas está pendiente de cancelación. La cancelación se producirá solo después de que el usuario finalice todos los pagos comprometidos. |
PendingCancellation
Este tipo no tiene campos.
Este es un indicador de si hay una cancelación pendiente en el plan de cuotas virtuales. La cancelación se producirá solo después de que el usuario finalice todos los pagos comprometidos.
PrepaidPlan
Información relacionada con un plan prepagado.
Representación JSON |
---|
{ "allowExtendAfterTime": string } |
Campos | |
---|---|
allowExtendAfterTime |
Si está presente, este es el momento en el que se permitirán las compras de recarga del plan prepagado. No estará presente en los planes prepagados vencidos. Una marca de tiempo en formato RFC3339 UTC “Zulú”, con una resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: |
OfferDetails
Incluye información detallada de la oferta relacionada con una línea de pedido de compra.
Representación JSON |
---|
{ "offerTags": [ string ], "basePlanId": string, "offerId": string } |
Campos | |
---|---|
offerTags[] |
Son las etiquetas de oferta más recientes asociadas con la oferta. Incluye etiquetas heredadas del plan básico. |
basePlanId |
El ID del plan básico. Está presente para todas las ofertas y el plan básico. |
offerId |
Es el ID de la oferta. Presenta solo para ofertas con descuento. |
DeferredItemReplacement
Información relacionada con el reemplazo diferido de elementos.
Representación JSON |
---|
{ "productId": string } |
Campos | |
---|---|
productId |
El productId que reemplazará el productId existente. |
Métodos |
|
---|---|
|
Cómo obtener metadatos de una suscripción |
|
Revocar la compra de una suscripción para el usuario |