REST Resource: monetization.subscriptions

Recurso: Subscription

Uma única assinatura de 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 principal.

productId

string

Imutável. ID exclusivo do produto. Exclusivo no app pai. Os IDs dos produtos precisam ser compostos por letras minúsculas (a-z), números (0-9), sublinhados (_) e pontos (.). Precisa 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 páginas de detalhes localizadas para esta assinatura. Precisa conter pelo menos uma entrada para o idioma padrão do app pai.

archived
(deprecated)

boolean

Apenas saída. Obsoleto: não há suporte para o arquivamento de assinaturas.

taxAndComplianceSettings

object (SubscriptionTaxAndComplianceSettings)

Detalhes sobre tributos e conformidade legal.

BasePlan

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. O identificador exclusivo desse plano básico. Precisa ser exclusivo na assinatura e estar em conformidade com o RFC-1034. Ou seja, esse ID pode conter somente letras minúsculas (a-z), números (0-9) e hifens (-) e ter no máximo 63 caracteres.

state

enum (State)

Apenas saída. O estado do plano básico, ou seja, se ele está ativo. Planos básicos em rascunho e inativos podem ser ativados ou excluídos. Os planos básicos ativos podem ficar inativos. 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 este plano básico e retornadas ao app pela biblioteca de faturamento. As ofertas de assinatura deste plano básico também vão receber estas tags de oferta na Biblioteca Faturamento.

otherRegionsConfig

object (OtherRegionsBasePlanConfig)

Informações sobre preços para novos locais que o Google Play poderá lançar no futuro. Se omitido, o BasePlan não vai ser disponibilizado automaticamente em novos locais que o Google Play lançar no futuro.

Campo de união base_plan_type. O tipo desse plano básico. Exatamente um deve ser definido. 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 intervalos regulares.

prepaidBasePlanType

object (PrepaidBasePlanType)

Defina quando o plano básico não vai ser renovado automaticamente no final 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. Nesse momento, 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 só está disponível para assinantes atuais.

AutoRenewingBasePlanType

Representa um plano básico que é renovado automaticamente ao final do período de assinatura.

Representação JSON
{
  "billingPeriodDuration": string,
  "gracePeriodDuration": string,
  "accountHoldDuration": 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 acessar uma lista de períodos de faturamento aceitáveis, 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 (dia zero), 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.

accountHoldDuration

string

Opcional. Período de suspensão de conta da assinatura, especificado no formato ISO 8601. Os valores aceitáveis devem estar em DIAS e no intervalo de P0D (zero dias) a P30D (30 dias). Se não for especificado, o valor padrão será P30D (30 dias).

resubscribeState

enum (ResubscribeState)

Define se os usuários podem assinar novamente esse plano básico nas plataformas do Google Play. Se nada for especificado, o padrão será REINSTALL_STATE_ACTIVE.

prorationMode

enum (SubscriptionProrationMode)

O modo de cálculo proporcional do plano básico determina o que acontece quando um usuário muda de um plano básico para este. Se não for especificado, será usado o padrão 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.

Apenas um plano básico com renovação pode ser marcado como compatível com as versões legadas para uma determinada assinatura.

legacyCompatibleSubscriptionOfferId

string

Código da oferta de assinatura que é 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 plano básico renovado.

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

ResubscribeState

Estado de renovação da assinatura do plano básico.

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

SubscriptionProrationMode

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 vão receber uma cobrança 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 por completo. Qualquer período restante da assinatura atual será usado para estender a duração do novo plano de faturamento.

PrepaidBasePlanType

Representa um plano básico que não é renovado automaticamente ao fim de um plano básico e que precisa 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 acessar uma lista de períodos de faturamento aceitáveis, consulte a Central de Ajuda.

timeExtension

enum (TimeExtension)

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

TimeExtension

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 ou estender o plano pré-pago.

RegionalBasePlanConfig

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. Código de região a que essa configuração se aplica, conforme definido pela ISO 3166-2, por exemplo, "US".

newSubscriberAvailability

boolean

Se o plano básico na região especificada está disponível para novos assinantes. Se esse valor for definido como "false", os assinantes atuais não terão a assinatura cancelada. 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.

OtherRegionsBasePlanConfig

Informações sobre os preços dos novos locais em que o Google Play poderá ser lançado.

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

object (Money)

Obrigatório. Preço em USD para usar em novos locais em que o Google Play for lançado.

eurPrice

object (Money)

Obrigatório. Preço em EUR usado em todos os novos locais em que o Google Play for lançado.

newSubscriberAvailability

boolean

Se o plano básico está disponível para novos assinantes em novos locais onde o Google Play pode ser lançado. Se não for especificado, o padrão será "false".

SubscriptionListing

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 desta listagem, conforme definido por BCP-47, por exemplo, "pt-BR".

title

string

Obrigatório. O título da assinatura no idioma desta página de detalhes. Texto simples.

benefits[]

string

Uma lista dos benefícios mostrados ao usuário em plataformas como a Play Store e em fluxos de restauração no idioma desta página de detalhes. Texto simples. Lista ordenada com no máximo quatro benefícios.

description

string

A descrição desta assinatura no idioma desta página de detalhes. O tamanho máximo é de 80 caracteres. Texto simples.

Métodos

archive
(deprecated)

Obsoleto: não há suporte para o arquivamento de assinaturas.

batchGet

Lê uma ou mais assinaturas.

batchUpdate

Atualiza um lote de assinaturas.

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.