REST Resource: monetization.subscriptions

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

Recurso: Suscripción

Una sola suscripción para una app.

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

string

Inmutable. Nombre del paquete de la app superior.

productId

string

Inmutable. Es el ID único del producto. Es único dentro de la app principal. Los ID del producto deben incluir letras en minúscula (a-z), números (0-9), guiones bajos (_) y puntos (.). Debe comenzar con una letra o un número en minúscula, y tener entre 1 y 40 caracteres (inclusive).

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. Se trata de apks.list de fichas localizadas para esta suscripción. Debe contener al menos una entrada para el idioma predeterminado de la app principal.

archived

boolean

Solo salida. Indica si esta suscripción está archivada. Las suscripciones archivadas ya no están disponibles para ningún suscriptor, no se pueden actualizar y no se muestran en las solicitudes de lista, a menos que se pase la marca de archivado del programa.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detalles sobre los impuestos y el cumplimiento legal.

Plan básico

Un solo plan básico 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)
  }
  // End of list of possible types for union field base_plan_type.
}
Campos
basePlanId

string

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

state

enum (State)

Solo salida. El estado del plan básico, es decir, si está activo. Los borradores y los planes básicos inactivos se pueden activar o borrar. Los planes básicos activos pueden quedar inactivos. Los planes básicos inactivos se pueden cancelar. Este campo no se puede cambiar mediante la actualización del recurso. En su lugar, usa los extremos dedicados.

regionalConfigs[]

object (RegionalBasePlanConfig)

Información específica de la región para este plan básico.

offerTags[]

object (OfferTag)

apks.list de hasta 20 etiquetas personalizadas especificadas para este plan básico y que regresa a la app mediante la biblioteca de facturación. Las ofertas de suscripción para este plan básico también recibirán estas etiquetas de ofertas en la biblioteca de facturación.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

La información sobre los precios de las nuevas ubicaciones que Play pueda lanzar en el futuro. Si se omite, el Plan básico no estará disponible automáticamente en las ubicaciones nuevas que Play pueda lanzar en el futuro.

Campo de unión base_plan_type. El tipo de este plan básico. Se debe establecer exactamente uno. Las direcciones (base_plan_type) solo pueden ser una de las siguientes opciones:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Se establece cuando el plan básico se renueva automáticamente a intervalos regulares.

prepaidBasePlanType

object (PrepaidBasePlanType)

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

State

Estado actual de un plan básico.

Enumeradores
STATE_UNSPECIFIED Estado sin especificar.
DRAFT El plan básico se encuentra actualmente en estado de borrador y no se activó. En este momento, puedes borrarla de forma segura.
ACTIVE El plan básico está activo y está disponible para los suscriptores nuevos.
INACTIVE El plan básico está inactivo y solo está disponible para los suscriptores existentes.

Tipo de plan de renovación automática

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

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

string

Obligatorio. Período de suscripción especificado en formato ISO 8601. Para obtener una lista de los períodos de facturación aceptables, consulta el Centro de ayuda.

gracePeriodDuration

string

Período de gracia de la suscripción, especificado en formato ISO 8601. Los valores aceptables son P0D (cero días), P3D (3 días), P7D (7 días), P14D (14 días) y P30D (30 días). Si no se especifica, se usará un valor predeterminado según la duración del período recurrente.

resubscribeState

enum (ResubscribeState)

Indica si los usuarios deben poder volver a suscribirse a este plan básico en las plataformas de Google Play. La configuración predeterminada es RESUBSCRIBE_STATE_ACTIVE si no se especifica.

prorationMode

enum (SubscriptionProrationMode)

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

legacyCompatible

boolean

Si el plan básico renovado es retrocompatible.

El método base querySkuDetailsAsync() muestra la versión anterior de la Biblioteca de Facturación Google Play.

Solo se puede marcar un plan básico con renovación como heredado para una suscripción determinada.

legacyCompatibleSubscriptionOfferId

string

ID de oferta de suscripción compatible con versiones heredadas.

La Biblioteca de Facturación Google Play muestra el método obsoleto querySkuDetailsAsync(). Solo se puede marcar una oferta de suscripción compatible como heredada para un plan básico renovado. Para no tener ninguna oferta de suscripción como compatible heredada, establece este campo como una string vacía.

Estado de resuscripción

Estado del estado de resuscripción del plan básico.

Enumeradores
RESUBSCRIBE_STATE_UNSPECIFIED Estado sin especificar.
RESUBSCRIBE_STATE_ACTIVE La opción para volver a suscribirse está activa.
RESUBSCRIBE_STATE_INACTIVE La opción para volver a suscribirse está inactiva.

Modo de prorrateado de suscripción

El modo de prorrateo que se usa para renovar planes básicos.

Enumeradores
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modo no especificado.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE A los usuarios se les cobrará el nuevo plan básico al final del período de facturación actual.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY A los usuarios se les cobrará su nuevo plan básico de inmediato y en su totalidad. Cualquier período restante de su suscripción existente se utilizará para extender la duración del nuevo plan de facturación.

Tipo de plan prepagado

Representa un plan básico que no se renueva automáticamente al final del plan básico y que el usuario debe renovar manualmente.

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

string

Obligatorio. Período de suscripción especificado en formato ISO 8601. Para obtener una lista de los períodos de facturación aceptables, consulta el Centro de ayuda.

timeExtension

enum (TimeExtension)

Indica si los usuarios deben poder extender este plan básico prepago en las plataformas de Google Play. La configuración predeterminada es TIME_EXTENSION_ACTIVE si no se especifica.

Extensión de tiempo

Extensión de tiempo del plan básico.

Enumeradores
TIME_EXTENSION_UNSPECIFIED Estado sin especificar.
TIME_EXTENSION_ACTIVE La extensión de tiempo está activa. Los usuarios pueden agregar dinero a su plan prepagado o extenderlo.
TIME_EXTENSION_INACTIVE La extensión de tiempo está inactiva. Los usuarios no pueden agregar dinero ni extender su plan prepagado.

Configuración del plan regional básico

Configuración para un plan básico específico de una región.

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

string

Obligatorio. Código de región al que se aplica esta configuración, según lo define la norma ISO 3166-2, p. ej., "US"

newSubscriberAvailability

boolean

Si el plan básico en la región especificada está disponible para suscriptores nuevos. La suscripción no se cancelará si el valor se establece como falso. Si no se especifica, el valor predeterminado será “false”.

price

object (Money)

El precio del plan básico en la región especificada. Se debe configurar si el plan básico está disponible para suscriptores nuevos. Debe establecerse en la moneda vinculada a la región especificada.

OtraConfiguraciónBasePlanBase

Información de precios para las nuevas ubicaciones en las que Play pueda lanzar contenido.

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

object (Money)

Obligatorio. Precio en USD que se usará para cualquier ubicación nueva en la que Play pueda lanzarse.

eurPrice

object (Money)

Obligatorio. Precio en EUR que se usará para las nuevas ubicaciones en las que Play pueda lanzar contenido.

newSubscriberAvailability

boolean

Si el plan básico está disponible para suscriptores nuevos en cualquier ubicación nueva en la que Play pueda lanzar contenido Si no se especifica, el valor predeterminado será “false”.

Lista de suscripciones

Los metadatos visibles de un consumidor de una suscripción.

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

string

Obligatorio. El idioma de esta lista, según lo definido por BCP-47, p. ej., "en-US"

title

string

Obligatorio. El título de esta suscripción en el idioma de esta ficha. Texto sin formato

benefits[]

string

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

description

string

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

Métodos

archive

Archiva una suscripción.

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.