REST Resource: purchases.subscriptionsv2

Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Recurso: SubscriptionPurchaseV2

Indica el estado de compra de una suscripción de un usuario.

Representación JSON
{
  "kind": string,
  "regionCode": string,
  "latestOrderId": 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)
  }
}
Campos
kind

string

Este tipo representa un objeto SubscriptionPurchaseV2 en el servicio androidpublisher.

regionCode

string

Código de país/región de facturación ISO 3166-1 alfa-2 del usuario en el momento en que se otorgó la suscripción.

latestOrderId

string

El ID del pedido más reciente asociado con la compra de la suscripción. En el caso de las suscripciones con renovación automática, este es el ID de pedido del pedido de registro si aún no se renueva o el último ID recurrente (pedido exitoso, pendiente o rechazado). Para la suscripción prepaga, es el ID de pedido asociado con el token de compra consultada.

lineItems[]

object (SubscriptionPurchaseLineItem)

Información a nivel del artículo para una compra de suscripción. Los artículos de la misma compra deben ser todos con el plan AutoRenewingPlan o todos con el plan PrepaidPlan.

startTime

string (Timestamp format)

Hora en la que se otorgó la suscripción. No se estableció para suscripciones pendientes (la suscripción se creó, pero está pendiente de pago durante el registro).

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

subscriptionState

enum (SubscriptionState)

El estado actual de la suscripción.

linkedPurchaseToken

string

El token de compra de la suscripción anterior si esta suscripción es una de las siguientes: * Volver a registrarse en una suscripción cancelada pero no vencida * Actualizar/pasar a una versión anterior de una suscripción anterior. * Conversión de suscripción prepaga a renovación automática. * Convierta una suscripción que se renueva automáticamente a prepaga. * Agrega dinero a una suscripción prepaga.

pausedStateContext

object (PausedStateContext)

Contexto adicional sobre las suscripciones pausadas Presente únicamente si la suscripción actualmente tiene subscriptionState SUBSCRIPTION_STATE_PAUSED.

canceledStateContext

object (CanceledStateContext)

Contexto adicional sobre las suscripciones canceladas Presente únicamente si la suscripción actualmente tiene subscriptionState SUBSCRIPTION_STATE_CANCELED.

testPurchase

object (TestPurchase)

Solo está presente si la compra de esta suscripción es de prueba.

acknowledgementState

enum (AcknowledgementState)

El estado de confirmación de la suscripción.

externalAccountIdentifiers

object (ExternalAccountIdentifiers)

Es el identificador de la cuenta de usuario en el servicio de terceros.

subscribeWithGoogleInfo

object (SubscribeWithGoogleInfo)

Perfil de usuario asociado a compras realizadas con &suscribirte a Google

Estado de suscripción

Los estados potenciales en los que puede estar una suscripción, por ejemplo, si está activa o cancelada. Los elementos de una compra de suscripción pueden ser todos planes de renovación automática o planes prepagados.

Enumeradores
SUBSCRIPTION_STATE_UNSPECIFIED Estado de suscripción no especificado.
SUBSCRIPTION_STATE_PENDING La suscripción se creó, pero está pendiente de 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 es autoRenewEnabled y no ha caducado. - (2) Si la suscripción es un plan prepagado, al menos un artículo no venció.
SUBSCRIPTION_STATE_PAUSED Se detuvo 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 en estado detenido.
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 artículos 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 aún no venció. El estado solo está disponible cuando la suscripción es un plan con renovación automática. Todos los elementos tienen configurado ReReEnabled de forma falsa.
SUBSCRIPTION_STATE_EXPIRED La suscripción venció. Todos los elementos tienen una fecha de vencimiento en el pasado.

Contexto de estado detenido

Información específica de una suscripción en estado de pausa.

Representación JSON
{
  "autoResumeTime": string
}
Campos
autoResumeTime

string (Timestamp format)

Hora en la que se reanudará automáticamente la suscripción.

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

CanceladoStateContext

Información específica de una suscripción en estado cancelado.

Representación JSON
{

  // Union field cancellation_reason can be only one of the following:
  "userInitiatedCancellation": {
    object (UserInitiatedCancellation)
  },
  "systemInitiatedCancellation": {
    object (SystemInitiatedCancellation)
  },
  "developerInitiatedCancellation": {
    object (DeveloperInitiatedCancellation)
  },
  "replacementCancellation": {
    object (ReplacementCancellation)
  }
  // End of list of possible types for union field cancellation_reason.
}
Campos
Campo de unión cancellation_reason. El motivo por el que se canceló una suscripción. Las direcciones (cancellation_reason) solo pueden ser una de las siguientes opciones:
userInitiatedCancellation

object (UserInitiatedCancellation)

El usuario canceló la suscripción.

systemInitiatedCancellation

object (SystemInitiatedCancellation)

El sistema canceló la suscripción, por ejemplo, debido a un problema de facturación.

developerInitiatedCancellation

object (DeveloperInitiatedCancellation)

El desarrollador canceló la suscripción.

replacementCancellation

object (ReplacementCancellation)

La suscripción se reemplazó por una nueva.

Cancelación iniciada por el usuario

Información específica de cancelaciones iniciadas por los usuarios.

Representación JSON
{
  "cancelSurveyResult": {
    object (CancelSurveyResult)
  },
  "cancelTime": string
}
Campos
cancelSurveyResult

object (CancelSurveyResult)

Información que proporciona el usuario cuando completa el flujo de cancelación de la suscripción (encuesta del motivo de cancelación).

cancelTime

string (Timestamp format)

El momento en el que el usuario canceló la suscripción. Es posible que el usuario aún tenga acceso a la suscripción después de ese período. Usa lineItems.expiry_time para determinar si un usuario aún tiene acceso.

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

CancelarSurveyResult

Resultado de la encuesta de cancelación cuando el usuario canceló la suscripción.

Representación JSON
{
  "reason": enum (CancelSurveyReason),
  "reasonUserInput": string
}
Campos
reason

enum (CancelSurveyReason)

Indica el motivo por el que el usuario seleccionó la encuesta de cancelación.

reasonUserInput

string

Solo se establece para CANCEL_SURVEY_REASON_OTHERS. Esta es la respuesta en formato libre del usuario a la encuesta.

Motivo de la encuesta de cancelación

Indica el motivo por el que el usuario seleccionó la encuesta de cancelación.

Enumeradores
CANCEL_SURVEY_REASON_UNSPECIFIED Motivo de cancelación de la encuesta no especificado.
CANCEL_SURVEY_REASON_NOT_ENOUGH_USAGE No hay suficiente uso de la suscripción.
CANCEL_SURVEY_REASON_TECHNICAL_ISSUES Problemas técnicos al usar la aplicación
CANCEL_SURVEY_REASON_FOUND_BETTER_APP El usuario encontró una app mejor.
CANCEL_SURVEY_REASON_OTHERS Otros motivos.

Cancelación iniciada por el sistema

Información específica de las cancelaciones que inicia el sistema de Google.

Cancelación iniciada por el programador

Información específica de cancelaciones iniciadas por los desarrolladores.

Cancelación de reemplazo

Información específica de cancelaciones causadas por el reemplazo de suscripciones.

CompraDePrueba

Indica si esta compra de suscripción es una compra de prueba.

Estado de confirmación

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 confirma la suscripción.
ACKNOWLEDGEMENT_STATE_ACKNOWLEDGED Se confirmó la suscripción.

ExternalAccountIdentifiers

Es el identificador de la cuenta de usuario en el servicio de terceros.

Representación JSON
{
  "externalAccountId": string,
  "obfuscatedExternalAccountId": string,
  "obfuscatedExternalProfileId": string
}
Campos
externalAccountId

string

Es el identificador de la cuenta de usuario en el servicio de terceros. Solo está presente si la vinculación de la cuenta se produjo como parte del flujo de compra de la suscripción.

obfuscatedExternalAccountId

string

Es una versión ofuscada del ID que está asociada de forma exclusiva con la cuenta del usuario en tu app. Presenta las siguientes compras: * Si se vinculó la cuenta como parte del flujo de compra de la suscripción. * Se especificó mediante https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#set ofuscadaccountid cuando se realizó la compra.

obfuscatedExternalProfileId

string

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 con https://developer.android.com/reference/com/android/billingclient/api/BillingFlowParams.Builder#set ofuscadprofileid cuando se realizó la compra.

Información de Suscríbete con Google

Información asociada con compras realizadas con &Suscríbete con Google

Representación JSON
{
  "profileId": string,
  "profileName": string,
  "emailAddress": string,
  "givenName": string,
  "familyName": string
}
Campos
profileId

string

El ID de perfil de Google del usuario cuando se compró la suscripción.

profileName

string

Es el nombre de perfil del usuario cuando se compró la suscripción.

emailAddress

string

La dirección de correo electrónico del usuario cuando se compró la suscripción.

givenName

string

Es el nombre del usuario cuando se compró la suscripción.

familyName

string

El nombre de la familia del usuario cuando se compró la suscripción.

SuscripciónCompraLíneaDePedido

Información a nivel del artículo para una compra de suscripción.

Representación JSON
{
  "productId": string,
  "expiryTime": string,

  // Union field plan_type can be only one of the following:
  "autoRenewingPlan": {
    object (AutoRenewingPlan)
  },
  "prepaidPlan": {
    object (PrepaidPlan)
  }
  // End of list of possible types for union field plan_type.
}
Campos
productId

string

El ID del producto comprado (por ejemplo, 'monthly001').

expiryTime

string (Timestamp format)

Hora en la que la suscripción venció o vencerá a menos que se extienda el acceso (p. ej., se renueva).

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Campo de unión plan_type. El tipo de plan de suscripción. Las direcciones (plan_type) solo pueden ser una de las siguientes opciones:
autoRenewingPlan

object (AutoRenewingPlan)

El artículo se renueva automáticamente.

prepaidPlan

object (PrepaidPlan)

El artículo es prepago.

Plan de renovación automática

Información relacionada con un plan de renovación automática.

Representación JSON
{
  "autoRenewEnabled": boolean
}
Campos
autoRenewEnabled

boolean

Si la suscripción está configurada para renovarse automáticamente, p.ej., el usuario no la canceló

Plan prepagado

Información relacionada con un plan prepagado.

Representación JSON
{
  "allowExtendAfterTime": string
}
Campos
allowExtendAfterTime

string (Timestamp format)

Después de este plazo, la suscripción se permite para una nueva compra de recarga. No está presente si la suscripción ya se extendió mediante una compra de recarga.

Una marca de tiempo en formato RFC3339 UTC (Zulú) con resolución en nanosegundos y hasta nueve dígitos decimales. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".

Métodos

get

Obtén metadatos sobre una suscripción