REST Resource: monetization.subscriptions

Recurso: Subscription

É uma única assinatura para um app.

Representação JSON 
{
  "packageName": string,
  "productId": string,
  "basePlans": [
    {
      object (BasePlan)
    }
  ],
  "listings": [
    {
      object (SubscriptionListing)
    }
  ],
  "archived": boolean,
  "taxAndComplianceSettings": {
    object (SubscriptionTaxAndComplianceSettings)
  }
}
Campos
packageName

string

Imutável. Nome do pacote do app pai.
productId

string

Imutável. ID exclusivo do produto. Exclusivo no app pai. Os IDs do produto precisam ser compostos por letras minúsculas (a-z), números (0-9), sublinhados (_) e pontos (.), além de começar com uma letra minúscula ou um número e ter entre 1 e 40 caracteres (inclusive).
basePlans[]

object (BasePlan)

É o conjunto de planos básicos desta assinatura. Representa os preços e a duração da assinatura se nenhuma outra oferta se aplicar.
listings[]

object (SubscriptionListing)

Obrigatório. Lista de listagens localizadas para esta assinatura. Precisa ter pelo menos uma entrada para o idioma padrão do app pai.
archived

boolean

Apenas saída. Indica se a assinatura está arquivada. As assinaturas arquivadas não estão mais disponíveis para assinantes, não podem ser atualizadas e não são retornadas em solicitações de listas, a menos que a sinalização de exibição arquivada seja transmitida.
taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detalhes sobre tributos e conformidade legal.

Plano básico

Um único plano básico para uma assinatura.

Representação 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

Obrigatório. Imutável. Identificador exclusivo do plano básico. Precisa ser exclusivo na assinatura e estar em conformidade com o RFC-1034. Ou seja, esse ID só pode conter letras minúsculas (a-z), números (0-9) e hifens (-) e pode ter no máximo 63 caracteres.
state

enum (State)

Apenas saída. O estado do plano básico, ou seja, se ele está ativo. Os planos básicos e de rascunho podem ser ativados ou excluídos. Os planos básicos ativos podem ser desativados. Os planos básicos inativos podem ser cancelados. Este campo não pode ser alterado atualizando o recurso. Use os endpoints dedicados.
regionalConfigs[]

object (RegionalBasePlanConfig)

Informações específicas da região para este plano básico.
offerTags[]

object (OfferTag)

Lista de até 20 tags personalizadas especificadas para esse plano básico e retornadas ao app pela Biblioteca Faturamento. As ofertas de assinatura desse plano básico também vão receber essas tags na Biblioteca Faturamento.
otherRegionsConfig

object (OtherRegionsBasePlanConfig)

As informações de preços de todos os novos locais que o Google Play poderá lançar no futuro. Se omitido, o BasePlan não estará automaticamente disponível em novos locais que o Google Play possa lançar no futuro.
Campo de união base_plan_type. É o tipo do plano básico. É necessário definir exatamente um. base_plan_type pode ser apenas de um dos tipos a seguir:
autoRenewingBasePlanType

object (AutoRenewingBasePlanType)

Defina quando o plano básico será renovado automaticamente em um intervalo regular.
prepaidBasePlanType

object (PrepaidBasePlanType)

Defina quando o plano básico não será renovado automaticamente no fim do período de faturamento.

Estado

Estado atual de um plano básico.

Enums
STATE_UNSPECIFIED Estado não especificado.
DRAFT O plano básico está em estado de rascunho e não foi ativado. Ele já pode ser excluído com segurança.
ACTIVE O plano básico está ativo e disponível para novos assinantes.
INACTIVE O plano básico está inativo e disponível apenas para assinantes atuais.

Tipo de renovação automática com base no tipo de plano

Representa um plano básico que é renovado automaticamente no fim do período da assinatura.

Representação JSON 
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "resubscribeState": enum (ResubscribeState),
  "prorationMode": enum (SubscriptionProrationMode),
  "legacyCompatible": boolean,
  "legacyCompatibleSubscriptionOfferId": string
}
Campos
billingPeriodDuration

string

Obrigatório. Período de assinatura, especificado no formato ISO 8601. Para ver uma lista de períodos de faturamento aceitos, consulte a Central de Ajuda.
gracePeriodDuration

string

Período de carência da assinatura, especificado no formato ISO 8601. Os valores aceitáveis são P0D (0 dias), P3D (3 dias), P7D (7 dias), P14D (14 dias) e P30D (30 dias). Se não for especificado, um valor padrão será usado com base na duração do período recorrente.
resubscribeState

enum (ResubscribeState)

Indica se os usuários podem assinar novamente esse plano básico nas plataformas do Google Play. Se não for especificado, o padrão será RECANCEL_STATE_ACTIVE.
prorationMode

enum (SubscriptionProrationMode)

O modo de cálculo proporcional para o plano básico determina o que acontece quando um usuário muda de outro plano básico para esse plano. Se não for especificado, o padrão será CHARGE_ON_NEXT_BILLING_DATE.
legacyCompatible

boolean

Indica se o plano básico renovado é compatível com versões anteriores.

O plano básico compatível com versões anteriores é retornado pelo método descontinuado querySkuDetailsAsync() da Biblioteca Google Play Faturamento.

Somente um plano básico de renovação pode ser marcado como compatível com uma assinatura específica.
legacyCompatibleSubscriptionOfferId

string

ID da oferta de assinatura compatível com as versões legadas.

A oferta de assinatura compatível com versões anteriores é retornada pelo método descontinuado querySkuDetailsAsync() da Biblioteca Google Play Faturamento.

Apenas uma oferta de assinatura pode ser marcada como compatível com versões legadas para um determinado plano básico de renovação.

Para não ter uma oferta de assinatura como compatível com versões legadas, defina esse campo como uma string vazia.

Estado de reinscrição

Estado de reinscrição do plano básico.

Enums
RESUBSCRIBE_STATE_UNSPECIFIED Estado não especificado.
RESUBSCRIBE_STATE_ACTIVE A nova assinatura está ativa.
RESUBSCRIBE_STATE_INACTIVE A assinatura está inativa.

Modo de cálculo de assinatura

O modo de cálculo proporcional usado para renovar os planos básicos.

Enums
SUBSCRIPTION_PRORATION_MODE_UNSPECIFIED Modo não especificado.
SUBSCRIPTION_PRORATION_MODE_CHARGE_ON_NEXT_BILLING_DATE Os usuários serão cobrados pelo novo plano básico no fim do período de faturamento atual.
SUBSCRIPTION_PRORATION_MODE_CHARGE_FULL_PRICE_IMMEDIATELY Os usuários serão cobrados pelo novo plano básico imediatamente e na íntegra. O período restante da assinatura existente será usado para estender a duração do novo plano de faturamento.

Tipo de plano pré-pago

Representa um plano básico que não será renovado automaticamente no final do plano básico e precisará ser renovado manualmente pelo usuário.

Representação JSON 
{
  "billingPeriodDuration": string,
  "timeExtension": enum (TimeExtension)
}
Campos
billingPeriodDuration

string

Obrigatório. Período de assinatura, especificado no formato ISO 8601. Para ver uma lista de períodos de faturamento aceitos, consulte a Central de Ajuda.
timeExtension

enum (TimeExtension)

Indica se os usuários podem estender o plano básico pré-pago nas plataformas do Google Play. Se não for especificado, o padrão será TIME_EXTENSION_ACTIVE

Extensão de hora

Extensão de tempo do plano básico.

Enums
TIME_EXTENSION_UNSPECIFIED Estado não especificado.
TIME_EXTENSION_ACTIVE A extensão de tempo está ativa. Os usuários podem recarregar ou estender o plano pré-pago.
TIME_EXTENSION_INACTIVE A extensão de tempo está inativa. Os usuários não podem recarregar nem estender o plano pré-pago.

Plano de base regional

Configuração para um plano básico específico de uma região.

Representação JSON 
{
  "regionCode": string,
  "newSubscriberAvailability": boolean,
  "price": {
    object (Money)
  }
}
Campos
regionCode

string

Obrigatório. O código da região a que essa configuração se aplica, conforme definido pela ISO 3166-2, por exemplo, "US".
newSubscriberAvailability

boolean

Indica se o plano básico na região especificada está disponível para novos assinantes. Os assinantes atuais não terão a assinatura cancelada se esse valor for definido como falso. Se não for especificado, o padrão será "false".
price

object (Money)

O preço do plano básico na região especificada. Precisa ser definido se o plano básico estiver disponível para novos assinantes. Precisa ser definido na moeda vinculada à região especificada.

Outras regiõesBasePlanConfig

Informações sobre preços de todos os novos locais em que o Google Play pode ser lançado.

Representação JSON 
{
  "usdPrice": {
    object (Money)
  },
  "eurPrice": {
    object (Money)
  },
  "newSubscriberAvailability": boolean
}
Campos
usdPrice

object (Money)

Obrigatório. Preço em dólares americanos para usar em novos locais em que o Google Play poderá ser lançado.
eurPrice

object (Money)

Obrigatório. Preço em EUR para usar em qualquer novo local em que o Google Play possa ser lançado.
newSubscriberAvailability

boolean

Indica se o plano básico está disponível para novos assinantes em novos locais. Se não for especificado, o padrão será "false".

Lista de assinaturas

Os metadados de uma assinatura visíveis ao consumidor.

Representação JSON 
{
  "languageCode": string,
  "title": string,
  "benefits": [
    string
  ],
  "description": string
}
Campos
languageCode

string

Obrigatório. O idioma dessa listagem, conforme definido pelo BCP-47, por exemplo, "en-US".
title

string

Obrigatório. O título da assinatura no idioma dessa ficha. Texto simples.
benefits[]

string

Uma lista de benefícios mostrados ao usuário em plataformas como a Play Store e nos fluxos de restauração no idioma dessa página. Texto simples. Lista ordenada de até quatro benefícios.
description

string

É a descrição desta assinatura no idioma dessa ficha. O tamanho máximo é de 80 caracteres. Texto simples.

Métodos

archive

 Arquiva uma assinatura.

create

 Cria uma nova assinatura.

delete

 Exclui uma assinatura.

get

 Lê uma única assinatura.

list

 Lista todas as assinaturas de um determinado app.

patch

 Atualiza uma assinatura existente.