REST Resource: monetization.subscriptions

Recurso: Suscripción

Es una suscripción única a una app.

Representación JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  },
  "restrictedPaymentCountries": {
    object (RestrictedPaymentCountries)
  }
}
Campos
packageName

string

Inmutable. Es el nombre del paquete de la app principal.
productId

string

Inmutable. Es el ID único del producto. en la app principal. Los IDs de producto deben componerse de letras minúsculas (a-z), números (0-9), guiones bajos (_) y puntos (.), tienen que empezar con una letra minúscula o un número, y deben tener entre 1 y 40 caracteres (inclusive) de longitud.
basePlans[]

object (BasePlan)

Es el conjunto de planes básicos para esta suscripción. Representa los precios y la duración de la suscripción si no se aplican otras ofertas.
listings[]

object (SubscriptionListing)

Obligatorio. Es la lista de fichas localizadas para esta suscripción. Debe contener al menos una entrada para el idioma predeterminado de la app superior.
archived
(deprecated)

boolean

Solo salida. Obsoleto. No se admite archivar suscripciones.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detalles sobre los impuestos y el cumplimiento legal.
restrictedPaymentCountries

object (RestrictedPaymentCountries)

Opcional. Son los países donde la compra de esta suscripción está restringida a las formas de pago registradas en el mismo país. Si está vacío, no se imponen restricciones por ubicación de pago.

BasePlan

Es un plan básico único para una suscripción.

Representación JSON 
{
  "basePlanId": string,
  "state": enum (State),
  "regionalConfigs": [
    {
      object (RegionalBasePlanConfig)
    }
  ],
  "offerTags": [
    {
      object (OfferTag)
    }
  ],
  "otherRegionsConfig": {
    object (OtherRegionsBasePlanConfig)
  },

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

string

Obligatorio. Inmutable. Es el identificador único de este plan básico. Debe ser único en la suscripción y cumplir con el RFC-1034. Esto significa que solo puede contener letras minúsculas (a-z), números (0-9) y guiones (-), y debe tener, como máximo, 63 caracteres.
state

enum (State)

Solo salida. Es el estado del plan básico, es decir, si está activo. Los planes básicos en borrador o inactivos se pueden activar o borrar. Los planes básicos activos pueden establecerse como inactivos. Los planes básicos inactivos se pueden cancelar. Este campo no se puede modificar actualizando el recurso. Usa los extremos dedicados para ese fin.
regionalConfigs[]

object (RegionalBasePlanConfig)

Es información específica de cada región para este plan básico.
offerTags[]

object (OfferTag)

Es una lista de hasta 20 etiquetas personalizadas especificadas para este plan básico que se devuelven a la app a través de la biblioteca de facturación. Las ofertas de suscripción de este plan básico también recibirán estas etiquetas de oferta en la biblioteca de facturación.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Es la información de precios de ubicaciones nuevas en las que Play podría lanzar la opción en el futuro. Si se omite, BasePlan no estará disponible automáticamente en ubicaciones nuevas en las que Play podría lanzar la opción en el futuro.
Campo de unión base_plan_type. Es el tipo de este plan básico. Se debe establecer exactamente uno. El tipo de plan básico es inmutable después de crearlo. Las direcciones (base_plan_type) solo pueden ser una de las siguientes opciones:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Se configura cuando se renueva automáticamente el plan básico a un intervalo regular.
prepaidBasePlanType

object (PrepaidBasePlanType)

Se configura cuando no se renueva automáticamente el plan básico al final del período de facturación.
installmentsBasePlanType

object (InstallmentsBasePlanType)

Se configura para planes básicos en cuotas en los que el usuario se compromete a una cantidad de pagos especificada.

Estado

Es el estado actual de un plan básico.

Enumeraciones
STATE_UNSPECIFIED Estado sin especificar.
DRAFT Indica que el plan básico se encuentra en estado de borrador y no se activó. Se puede borrar de forma segura en este punto.
ACTIVE Indica que el plan básico está activo y disponible para suscriptores nuevos.
INACTIVE Indica que el plan básico está inactivo y solo está disponible para suscriptores existentes.

AutoRenewingBasePlanType

Representa un plan básico que se renueva automáticamente al final de su período de suscripción.

Representación JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Campos
billingPeriodDuration

string

Obligatorio. Inmutable. Período de suscripción, especificado en formato ISO 8601. Para ver una lista de períodos de facturación aceptables, consulta el Centro de ayuda. La duración es inmutable después de crear el plan base.
gracePeriodDuration

string

Es el período de gracia de la suscripción, especificado en formato ISO 8601. Los valores aceptables deben estar en días y entre P0D y el menor de 30D y el período de facturación del plan básico.

Si no se especifica, se usará un valor predeterminado en función del período de facturación.

La suma de gracePeriodDuration y accountHoldDuration debe estar entre P30D y P60D inclusive.
accountHoldDuration

string

Opcional. Es el período de suspensión de la cuenta de la suscripción, especificado en formato ISO 8601. Los valores aceptables deben estar en días y entre P0D y P60D.

Si no se especifica, el valor predeterminado es P30D.

La suma de gracePeriodDuration y accountHoldDuration debe estar entre P30D y P60D inclusive.
resubscribeState

enum (ResubscribeState)

Indica si los usuarios deben tener la opción de volver a suscribirse a este plan básico en las plataformas de Google Play. El valor predeterminado es RESUBSCRIBE_STATE_ACTIVE si no se especifica.
prorationMode

enum (SubscriptionProrationMode)

El modo de prorrateo del plan básico determina qué ocurre cuando un usuario que tiene otro plan básico cambia a este. Si no se especifica, el valor predeterminado es CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indica si el plan básico con renovación es retrocompatible.

El plan básico retrocompatible es devuelto por el método obsoleto querySkuDetailsAsync() de la Biblioteca de Facturación Google Play.

Solo se puede marcar un plan básico con renovación como compatible con versiones heredadas para una suscripción determinada.
legacyCompatibleSubscriptionOfferId

string

Es el ID de la oferta de suscripción que es compatible con versiones heredadas.

El método obsoleto querySkuDetailsAsync() de la Biblioteca de Facturación Google Play devuelve la oferta de suscripción retrocompatible.

Solo se puede marcar una oferta de suscripción como compatible con versiones heredadas para un determinado plan básico con renovación.

Para no tener ninguna oferta de suscripción como compatible con versiones heredadas, configura este campo como una cadena vacía.

ResubscribeState

Es el estado de resuscripción del plan básico.

Enumeraciones
RESUBSCRIBE_STATE_UNSPECIFIED Estado sin especificar.
RESUBSCRIBE_STATE_ACTIVE Indica que la opción para volver a suscribirse está activa.
RESUBSCRIBE_STATE_INACTIVE Indica que la opción para volver a suscribirse está inactiva.

SubscriptionProrationMode

Es el modo de prorrateo que se usa para los planes básicos con renovación.

Enumeraciones
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modo sin especificar.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Indica que se les cobrará a los usuarios el nuevo plan básico al final del período de facturación actual.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Indica que se les cobrará a los usuarios el nuevo plan básico de forma inmediata y en su totalidad. Cualquier período restante de la suscripción existente se usará para extender la duración del nuevo plan de facturación.

PrepaidBasePlanType

Representa un plan básico que no se renueva automáticamente cuando termina y que el usuario debe renovar de forma manual.

Representación JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Campos
billingPeriodDuration

string

Obligatorio. Inmutable. Período de suscripción, especificado en formato ISO 8601. Para ver una lista de períodos de facturación aceptables, consulta el Centro de ayuda. La duración es inmutable después de crear el plan base.
timeExtension

enum (TimeExtension)

Indica si los usuarios deben tener la opción de extender este plan básico prepagado en las plataformas de Google Play. El valor predeterminado es TIME_EXTENSION_ACTIVE si no se especifica.

TimeExtension

Es la extensión de tiempo del plan básico.

Enumeraciones
TIME_EXTENSION_UNSPECIFIED Estado sin especificar.
TIME_EXTENSION_ACTIVE Indica que la extensión de tiempo está activa. Los usuarios pueden extender su plan prepagado o agregarle dinero.
TIME_EXTENSION_INACTIVE Indica que la extensión de tiempo está inactiva. Los usuarios no pueden extender su plan prepagado ni agregarle dinero.

InstallmentsBasePlanType

Representa un plan básico en cuotas en el que el usuario se compromete a una cantidad de pagos especificada.

Representación JSON 
{
  "billingPeriodDuration": string,
  "committedPaymentsCount": integer,
  "renewalType": enum (RenewalType),
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode)
}
Campos
billingPeriodDuration

string

Obligatorio. Inmutable. Es el período de suscripción, especificado en formato ISO 8601. Para ver una lista de períodos de facturación aceptables, consulta el Centro de ayuda. La duración es inmutable después de crear el plan base.
committedPaymentsCount

integer

Obligatorio. Inmutable. Es la cantidad de pagos a los que se compromete el usuario. Es inmutable después de crear el plan base.
renewalType

enum (RenewalType)

Obligatorio. Inmutable. Es el tipo de renovación del plan básico en cuotas. Determina el comportamiento al final del compromiso inicial. El tipo de renovación es inmutable después de crear el plan básico.
gracePeriodDuration

string

Es el período de gracia de la suscripción, especificado en formato ISO 8601. Los valores aceptables deben estar en días y entre P0D y el menor de 30D y el período de facturación del plan básico.

Si no se especifica, se usará un valor predeterminado en función del período de facturación.

La suma de gracePeriodDuration y accountHoldDuration debe estar entre P30D y P60D inclusive.
accountHoldDuration

string

Opcional. Es el período de suspensión de la cuenta de la suscripción, especificado en formato ISO 8601. Los valores aceptables deben estar en días y entre P0D y P60D.

Si no se especifica, el valor predeterminado es P30D.

La suma de gracePeriodDuration y accountHoldDuration debe estar entre P30D y P60D inclusive.
resubscribeState

enum (ResubscribeState)

Indica si los usuarios deben tener la opción de volver a suscribirse a este plan básico en las plataformas de Google Play. El valor predeterminado es RESUBSCRIBE_STATE_ACTIVE si no se especifica.
prorationMode

enum (SubscriptionProrationMode)

El modo de prorrateo del plan básico determina qué ocurre cuando un usuario que tiene otro plan básico cambia a este. Si no se especifica, el valor predeterminado es CHARGE_ON_NEXT_BILLING_DATE.

RenewalType

Es el tipo de renovación del plan básico en cuotas. Determina el comportamiento al final del compromiso inicial. El tipo de renovación es inmutable después de crear el plan básico.

Enumeraciones
RENEWAL_TYPE_UNSPECIFIED Estado sin especificar.
RENEWAL_TYPE_RENEWS_WITHOUT_COMMITMENT Indica que se renueva periódicamente para la duración del período de facturación sin compromiso.
RENEWAL_TYPE_RENEWS_WITH_COMMITMENT Indica que se renueva con el compromiso de la misma duración que la inicial.

RegionalBasePlanConfig

Es la configuración de un plan básico específico de una región.

Representación JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Campos
regionCode

string

Obligatorio. Es el código de región al que se aplica esta configuración, según la norma ISO 3166-2, p.ej., "US".
newSubscriberAvailability

boolean

Indica si el plan básico de la región especificada está disponible para suscriptores nuevos. Si este valor se establece como falso, no se cancelarán las suscripciones existentes. Si no se especifica, el valor predeterminado será falso.
price

object (Money)

Es el precio del plan básico en la región especificada. Se debe configurar si el plan básico está disponible para suscriptores nuevos. Se debe establecer en la moneda vinculada con la región especificada.

OtherRegionsBasePlanConfig

Es la información de precios de ubicaciones nuevas en las que Play podría lanzar la opción en el futuro.

Representación JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Campos
usdPrice

object (Money)

Obligatorio. Es el precio en USD que se usará para las ubicaciones nuevas en las que Play puede hacer un lanzamiento.
eurPrice

object (Money)

Obligatorio. Es el precio en EUR que se usará para las ubicaciones nuevas en las que Play puede hacer un lanzamiento.
newSubscriberAvailability

boolean

Indica si el plan básico está disponible para suscriptores nuevos en cualquiera de las ubicaciones nuevas en las que Play puede lanzar la oferta. Si no se especifica, el valor predeterminado será falso.

SubscriptionListing

Son los metadatos de una suscripción que están visibles para el usuario.

Representación JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Campos
languageCode

string

Obligatorio. Es el idioma de esta ficha, según se define en BCP-47 (p.ej., "en-US").
title

string

Obligatorio. Es el título de esta suscripción en el idioma de la ficha. Texto sin formato
benefits[]

string

Es una lista de beneficios que se muestran a los usuarios en plataformas como Play Store y en flujos de restablecimiento en el idioma de esta ficha. Texto sin formato Es una lista ordenada de, como máximo, cuatro beneficios.
description

string

Es la descripción de esta suscripción en el idioma de la ficha. Tiene una longitud máxima de 80 caracteres. Texto sin formato

RestrictedPaymentCountries

Son los países donde la compra de este producto está restringida a las formas de pago registradas en el mismo país. Si está vacío, no se imponen restricciones por ubicación de pago.

Representación JSON 
{
  "regionCodes": [
    string
  ]
}
Campos
regionCodes[]

string

Obligatorio. Son códigos de región a los que deben imponerse restricciones de pago, según se define en ISO 3166-2, p.ej., "US".

Métodos

archive
(deprecated)

 Obsoleto. No se admite archivar suscripciones.

batchGet

 Lee una o más suscripciones.

batchUpdate

 Actualiza un lote de suscripciones.

create

 Crea una suscripción nueva.

delete

 Elimina una suscripción.

get

 Lee una sola suscripción.

list

 Enumera todas las suscripciones de una app determinada.

patch

 Actualiza una suscripción existente.