REST Resource: monetization.subscriptions

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

string

Inmutable. Es el nombre del paquete de la app superior.

string

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

object (BasePlan)

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

object (SubscriptionListing)

Obligatorio. Lista de fichas localizadas de esta suscripción. Debe contener al menos una entrada para el idioma predeterminado de la app principal.

boolean

Solo salida. Obsoleto: no se admite la opción de archivar suscripciones.

object (SubscriptionTaxAndComplianceSettings)

Detalles sobre impuestos y cumplimiento legal.

object (RestrictedPaymentCountries)

Opcional. 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 aplican restricciones de ubicación de pagos.

{
  "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.
}

string

Obligatorio. Inmutable. Es el identificador único de este plan básico. Debe ser único dentro de 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.

enum (State)

Solo salida. El estado del plan básico, es decir, si está activo. Los planes básicos inactivos y en borrador se pueden activar o borrar. Los planes básicos activos pueden desactivarse. Los planes básicos inactivos se pueden cancelar. Este campo no se puede cambiar actualizando el recurso. En su lugar, usa los extremos dedicados.

object (RegionalBasePlanConfig)

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

object (OfferTag)

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

object (OtherRegionsBasePlanConfig)

Información sobre los precios de las nuevas ubicaciones que Play pueda lanzar en el futuro. Si se omite, el BasePlan no estará disponible automáticamente en ninguna ubicación nueva que Play pueda lanzar en el futuro.

object (AutoRenewingBasePlanType)

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

object (PrepaidBasePlanType)

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

object (InstallmentsBasePlanType)

Se establece para planes básicos de cuotas en los que un usuario se compromete a realizar una cantidad específica de pagos.

{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}

string

Obligatorio. Es el 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.

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.

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 DAYS y en el rango P0D (cero días) a P30D (30 días). Si no se especifica, el valor predeterminado es P30D (30 días).

enum (ResubscribeState)

Indica si los usuarios deben poder volver a suscribirse a este plan básico en las plataformas de Google Play. Si no se especifica, el valor predeterminado es REsubscribe_STATE_ACTIVE.

enum (SubscriptionProrationMode)

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

boolean

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.

string

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

La oferta de suscripción retrocompatible es devuelta por el método obsoleto querySkuDetailsAsync() de la Biblioteca de Facturación Google Play.

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

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

{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}

string

Obligatorio. Es el 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.

enum (TimeExtension)

Indica si los usuarios deben poder extender este plan básico prepagado en las plataformas de Google Play. Si no se especifica, el valor predeterminado es TIME_EXTENSION_ACTIVE.

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

string

Obligatorio. Es el 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.

integer

Obligatorio. Es la cantidad de pagos a los que se compromete el usuario.

enum (RenewalType)

Obligatorio. Tipo de renovación del plan básico en cuotas. Determina el comportamiento al final del compromiso inicial.

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.

string

Opcional. Es el período de suspensión de la cuenta de la suscripción, especificado exclusivamente en días y en formato ISO 8601. Los valores aceptables son P0D (cero días) a P30D (30 días). Si no se especifica, el valor predeterminado es P30D (30 días).

enum (ResubscribeState)

Indica si los usuarios deben poder volver a suscribirse a este plan básico en las plataformas de Google Play. Si no se especifica, el valor predeterminado es REsubscribe_STATE_ACTIVE.

enum (SubscriptionProrationMode)

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

{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}

string

Obligatorio. Es el código regional al que se aplica esta configuración, según lo definido por la norma ISO 3166-2; p.ej., “US”.

boolean

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

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. Se debe configurar en la moneda vinculada a la región especificada.

{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}

object (Money)

Obligatorio. Es el precio en USD para usar en cualquier ubicación nueva en la que se pueda lanzar Play.

object (Money)

Obligatorio. Es el precio en EUR para usar en las ubicaciones nuevas en las que se pueda lanzar Play.

boolean

Si el plan básico está disponible para suscriptores nuevos en ubicaciones nuevas en las que Play pueda lanzarse Si no se especifica, el valor predeterminado será falso.

{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}

string

Obligatorio. El idioma de esta ficha, según lo define BCP-47, p.ej., “en-US”.

string

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

string

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.

string

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

{
  "regionCodes": [
    string
  ]
}

string

Obligatorio. Códigos regionales a los que se deben imponer restricciones de pago, como se define en la norma ISO 3166-2; p.ej., “US”.